info.magnolia.cms.security.auth.callback

Class FormClientCallback

java.lang.Object

info.magnolia.cms.security.auth.callback.AbstractHttpClientCallback

info.magnolia.cms.security.auth.callback.FormClientCallback

All Implemented Interfaces:

HttpClientCallback

public class FormClientCallback
extends AbstractHttpClientCallback

Renders a login form using Freemarker and the template configured with loginForm. This is using SimpleFreemarkerHelper, which means the configured loginForm will only be loaded through the classpath loader and won't have access to shared variables etc. For a more complex login form template, re-implement a HttpClientCallback which uses FreemarkerHelper or the RenderingEngine

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_STRING
static String	SERVICE_CONTACT

Constructor Summary

Constructors

Constructor and Description
FormClientCallback(MagnoliaConfigurationProperties configurationProperties) Deprecated. since 5.4.3 use FormClientCallback(MagnoliaConfigurationProperties, Provider) instead.
FormClientCallback(MagnoliaConfigurationProperties configurationProperties, javax.inject.Provider<WebContext> webContextProvider)

Method Summary

Modifier and Type	Method and Description
String	getLoginForm()
protected Map<String,Object>	getMessages() Deprecated. since 5.4, use getTemplateContext()
protected Map<String,Object>	getTemplateContext() Simply sets "errorString" in case of login exception.
void	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Override this method to provide the specific functionality.
void	setLoginForm(String loginForm)

Methods inherited from class info.magnolia.cms.security.auth.callback.AbstractHttpClientCallback

accepts, doCallback, getHostPattern, getOriginalUrlPattern, getUrlPattern, getVoters, setHostPattern, setOriginalUrlPattern, setUrlPattern, setVoters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_STRING

public static final String ERROR_STRING

See Also:

Constant Field Values

SERVICE_CONTACT

public static final String SERVICE_CONTACT

See Also:

Constant Field Values

Constructor Detail

FormClientCallback

@Inject
public FormClientCallback(MagnoliaConfigurationProperties configurationProperties,
                                  javax.inject.Provider<WebContext> webContextProvider)

FormClientCallback

@Deprecated
public FormClientCallback(MagnoliaConfigurationProperties configurationProperties)

Deprecated. since 5.4.3 use FormClientCallback(MagnoliaConfigurationProperties, Provider) instead.

Method Detail

handle

public void handle(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)

Description copied from class: AbstractHttpClientCallback

Override this method to provide the specific functionality. This implementation is only kept for backwards compatibility with versions prior to 4.5, and merely delegates the call to AbstractHttpClientCallback.doCallback(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse).

Specified by:

handle in interface HttpClientCallback

Overrides:

handle in class AbstractHttpClientCallback

getLoginForm

public String getLoginForm()

setLoginForm

public void setLoginForm(String loginForm)

getMessages

@Deprecated
protected Map<String,Object> getMessages()

Deprecated. since 5.4, use getTemplateContext()

getTemplateContext

protected Map<String,Object> getTemplateContext()

Simply sets "errorString" in case of login exception. Override this to pass more objects to the freemarker template.

Returns:

a map containing translated messages