Skip navigation links

oracle.stellent.wcm.javaee.servlet.filter
Class WCMSiteFilter

java.lang.Object
oracle.stellent.wcm.javaee.servlet.filter.WCMSiteFilter

All Implemented Interfaces:

javax.servlet.Filter

public class WCMSiteFilter

extends java.lang.Object

implements javax.servlet.Filter

Maps requests through the structure database

Nested Class Summary

static class

WCMSiteFilter.Action

Field Summary

static java.lang.String	IGNORE_REQUEST
static java.lang.String	PARAM_EXCLUDE_BY_SITE_EXTENSION
static java.lang.String	PARAM_EXCLUDE_FILTER
static java.lang.String	REDIRECT_URL
static java.lang.String	SS_LINK
static java.lang.String	SS_NODE_LINK

Constructor Summary

WCMSiteFilter()

Method Summary

protected ServletRequestContext	createRequestContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create the request context object
protected SiteContext	createSiteContext(ServletRequestContext requestContext) Create the site context object
void	destroy()
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)
protected WCMSiteFilter.Action	getActionForRequest(ServletRequestContext requestContext) Examine the incoming request and determine if we should handle the request
java.lang.String	getEncoding()
SimplePatternMatcher	getExcludesFilter()
java.lang.String	getPublicDir()
protected WCMSiteFilter.Action	getSiteContextAction(ServletRequestContext requestContext, SiteContext siteContext) Check if the site context is valid
ClientApplication	getWcmApplication()
protected void	handlePageInvocation(ServletRequestContext requestContext) Invoke the page handler and handle the response
protected boolean	handleTokenizedLinks(ServletRequestContext servletRC) Process the filter for this command
void	init(javax.servlet.FilterConfig filterConfig)
boolean	isExcludeBySiteExtension()

Methods inherited from class java.lang.Object

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

Field Detail

SS_LINK

public static final java.lang.String SS_LINK

See Also:

Constant Field Values

SS_NODE_LINK

public static final java.lang.String SS_NODE_LINK

See Also:

Constant Field Values

PARAM_EXCLUDE_FILTER

public static final java.lang.String PARAM_EXCLUDE_FILTER

See Also:

Constant Field Values

PARAM_EXCLUDE_BY_SITE_EXTENSION

public static final java.lang.String PARAM_EXCLUDE_BY_SITE_EXTENSION

See Also:

Constant Field Values

IGNORE_REQUEST

public static final java.lang.String IGNORE_REQUEST

See Also:

Constant Field Values

REDIRECT_URL

public static final java.lang.String REDIRECT_URL

See Also:

Constant Field Values

Constructor Detail

WCMSiteFilter

public WCMSiteFilter()

Method Detail

getWcmApplication

public ClientApplication getWcmApplication()
                                    throws ApplicationException

Returns:

the current wcm application

Throws:

ApplicationException

getPublicDir

public java.lang.String getPublicDir()
                              throws ApplicationException

Returns:

the public directory where content server content is stored; we ignore all requests to this dir

Throws:

ApplicationException

getExcludesFilter

public SimplePatternMatcher getExcludesFilter()

Returns:

the exclusion pattern matcher

getEncoding

public java.lang.String getEncoding()

Returns:

the encoding to use on all page requests

isExcludeBySiteExtension

public boolean isExcludeBySiteExtension()

Returns:

true to exclude the paths to this filter by their site ID

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest servletRequest,
                     javax.servlet.ServletResponse servletResponse,
                     javax.servlet.FilterChain filterChain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException

getActionForRequest

protected WCMSiteFilter.Action getActionForRequest(ServletRequestContext requestContext)
                                            throws ApplicationException,
                                                   java.io.IOException

Examine the incoming request and determine if we should handle the request

Parameters:

requestContext - the request context

Returns:

the action to take for this request

Throws:

ApplicationException

java.io.IOException

createSiteContext

protected SiteContext createSiteContext(ServletRequestContext requestContext)
                                 throws ApplicationException

Create the site context object

Parameters:

requestContext - the request context

Returns:

the new SiteContext object

Throws:

ApplicationException

getSiteContextAction

protected WCMSiteFilter.Action getSiteContextAction(ServletRequestContext requestContext,
                                                    SiteContext siteContext)
                                             throws ApplicationException,
                                                    java.io.IOException

Check if the site context is valid

Parameters:

requestContext - the request context

siteContext - the site context

Returns:

true if the site context is valid

Throws:

ApplicationException

java.io.IOException

createRequestContext

protected ServletRequestContext createRequestContext(javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)

Create the request context object

Parameters:

request - the http request

response - the http response

Returns:

a new servlet request context

handlePageInvocation

protected void handlePageInvocation(ServletRequestContext requestContext)
                             throws ApplicationException,
                                    java.io.IOException

Invoke the page handler and handle the response

Parameters:

requestContext - the request context

Throws:

ApplicationException

java.io.IOException

handleTokenizedLinks

protected boolean handleTokenizedLinks(ServletRequestContext servletRC)
                                throws ApplicationException,
                                       java.io.IOException

Process the filter for this command

Parameters:

servletRC - the servlet request

Returns:

true if the response was handled

Throws:

ApplicationException

java.io.IOException

Skip navigation links