org.springframework.security.web

Class FilterInvocation

java.lang.Object

org.springframework.security.web.FilterInvocation

public class FilterInvocation
extends java.lang.Object

Holds objects associated with a HTTP filter.

Guarantees the request and response are instances of HttpServletRequest and HttpServletResponse, and that there are no null objects.

Required so that security system classes can obtain access to the filter environment, as well as the request and response.

Constructor Summary

Constructors

Constructor and Description
FilterInvocation(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
FilterInvocation(java.lang.String servletPath, java.lang.String method)
FilterInvocation(java.lang.String contextPath, java.lang.String servletPath, java.lang.String method)
FilterInvocation(java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String query, java.lang.String method)

Method Summary

Modifier and Type	Method and Description
javax.servlet.FilterChain	getChain()
java.lang.String	getFullRequestUrl() Indicates the URL that the user agent used for this request.
javax.servlet.http.HttpServletRequest	getHttpRequest()
javax.servlet.http.HttpServletResponse	getHttpResponse()
javax.servlet.http.HttpServletRequest	getRequest()
java.lang.String	getRequestUrl() Obtains the web application-specific fragment of the URL.
javax.servlet.http.HttpServletResponse	getResponse()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterInvocation

public FilterInvocation(javax.servlet.ServletRequest request,
                        javax.servlet.ServletResponse response,
                        javax.servlet.FilterChain chain)

FilterInvocation

public FilterInvocation(java.lang.String servletPath,
                        java.lang.String method)

FilterInvocation

public FilterInvocation(java.lang.String contextPath,
                        java.lang.String servletPath,
                        java.lang.String method)

FilterInvocation

public FilterInvocation(java.lang.String contextPath,
                        java.lang.String servletPath,
                        java.lang.String pathInfo,
                        java.lang.String query,
                        java.lang.String method)

Method Detail

getChain

public javax.servlet.FilterChain getChain()

getFullRequestUrl

public java.lang.String getFullRequestUrl()

Indicates the URL that the user agent used for this request.

The returned URL does not reflect the port number determined from a PortResolver.

Returns:

the full URL of this request

getHttpRequest

public javax.servlet.http.HttpServletRequest getHttpRequest()

getHttpResponse

public javax.servlet.http.HttpServletResponse getHttpResponse()

getRequestUrl

public java.lang.String getRequestUrl()

Obtains the web application-specific fragment of the URL.

Returns:

the URL, excluding any server name, context path or servlet path

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object