info.magnolia.cms.security.auth.callback

Class AbstractHttpClientCallback

java.lang.Object

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

All Implemented Interfaces:

HttpClientCallback

Direct Known Subclasses:

BasicClientCallback, FormClientCallback, RedirectClientCallback

public abstract class AbstractHttpClientCallback
extends Object
implements HttpClientCallback

A base class for HttpClientCallback implementations, providing a default set of configurable filters to accept the request.

Constructor Summary

Constructors

Constructor and Description
AbstractHttpClientCallback()

Method Summary

Modifier and Type	Method and Description
boolean	accepts(javax.servlet.http.HttpServletRequest request) Let the implementation if it wants to handle this request.
protected void	doCallback(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated. since 4.5
protected SimpleUrlPattern	getHostPattern()
protected SimpleUrlPattern	getOriginalUrlPattern()
protected SimpleUrlPattern	getUrlPattern()
Voter	getVoters()
void	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Override this method to provide the specific functionality.
void	setHostPattern(SimpleUrlPattern hostPattern)
void	setOriginalUrlPattern(SimpleUrlPattern originalUrlPattern)
void	setUrlPattern(SimpleUrlPattern urlPattern)
void	setVoters(Voter voters)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHttpClientCallback

public AbstractHttpClientCallback()

Method Detail

accepts

public boolean accepts(javax.servlet.http.HttpServletRequest request)

Description copied from interface: HttpClientCallback

Let the implementation if it wants to handle this request.

Specified by:

accepts in interface HttpClientCallback

handle

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

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 doCallback(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse).

Specified by:

handle in interface HttpClientCallback

doCallback

@Deprecated
protected void doCallback(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response)

Deprecated. since 4.5

Since 4.5, one can simply implement handle(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) when subclassing AbstractHttpClientCallback.

getOriginalUrlPattern

protected SimpleUrlPattern getOriginalUrlPattern()

setOriginalUrlPattern

public void setOriginalUrlPattern(SimpleUrlPattern originalUrlPattern)

getUrlPattern

protected SimpleUrlPattern getUrlPattern()

setUrlPattern

public void setUrlPattern(SimpleUrlPattern urlPattern)

getHostPattern

protected SimpleUrlPattern getHostPattern()

setHostPattern

public void setHostPattern(SimpleUrlPattern hostPattern)

getVoters

public Voter getVoters()

setVoters

public void setVoters(Voter voters)