org.apache.turbine.pipeline
Class DefaultSessionValidationValve

java.lang.Object
  org.apache.turbine.pipeline.AbstractValve
      org.apache.turbine.pipeline.DefaultSessionValidationValve

All Implemented Interfaces:

Valve, TurbineConstants

public class DefaultSessionValidationValve
extends AbstractValve
implements TurbineConstants

Implements the action portion of the "Turbine classic" processing pipeline (from the Turbine 2.x series).

Version:

$Id: DefaultSessionValidationValve.java 222043 2004-12-06 17:47:33Z painter $

Author:

Jason van Zyl\, Peter Courcoux

Field Summary

protected SessionValidator

sessionValidator

Fields inherited from interface org.apache.turbine.TurbineConstants

ACTION_ACCESS_CONTROLLER_DEFAULT, ACTION_ACCESS_CONTROLLER_KEY, ACTION_CACHE_SIZE_DEFAULT, ACTION_CACHE_SIZE_KEY, ACTION_EVENT_BUBBLE_EXCEPTION_UP, ACTION_EVENT_BUBBLE_EXCEPTION_UP_DEFAULT, ACTION_EVENTSUBMIT_NEEDSVALUE_DEFAULT, ACTION_EVENTSUBMIT_NEEDSVALUE_KEY, ACTION_LOGIN_DEFAULT, ACTION_LOGIN_KEY, ACTION_LOGOUT_DEFAULT, ACTION_LOGOUT_KEY, ACTION_PREFIX, ACTION_SESSION_VALIDATOR_DEFAULT, ACTION_SESSION_VALIDATOR_KEY, APPLICATION_ROOT_DEFAULT, APPLICATION_ROOT_KEY, CONFIG_NAMESPACE, DEFAULT_DOCUMENT_TYPE_KEY, DEFAULT_HTML_DOCTYPE_IDENTIFIER_DEFAULT, DEFAULT_HTML_DOCTYPE_IDENTIFIER_KEY, DEFAULT_HTML_DOCTYPE_ROOT_ELEMENT_DEFAULT, DEFAULT_HTML_DOCTYPE_ROOT_ELEMENT_KEY, DEFAULT_HTML_DOCTYPE_URI_DEFAULT, DEFAULT_HTML_DOCTYPE_URI_KEY, DEFAULT_LOGGER, DOCUMENT_TYPE_HTML40FRAMESET, DOCUMENT_TYPE_HTML40STRICT, DOCUMENT_TYPE_HTML40TRANSITIONAL, LAYOUT_CACHE_SIZE_DEFAULT, LAYOUT_CACHE_SIZE_KEY, LAYOUT_DEFAULT, LAYOUT_PREFIX, LOCALE_DEFAULT_CHARSET_DEFAULT, LOCALE_DEFAULT_CHARSET_KEY, LOCALE_DEFAULT_COUNTRY_DEFAULT, LOCALE_DEFAULT_COUNTRY_KEY, LOCALE_DEFAULT_LANGUAGE_DEFAULT, LOCALE_DEFAULT_LANGUAGE_KEY, LOG4J_CONFIG_FILE, LOG4J_CONFIG_FILE_DEFAULT, LOGGING_ROOT_DEFAULT, LOGGING_ROOT_KEY, LOGIN_ERROR, LOGIN_MESSAGE, LOGIN_MESSAGE_NOSCREEN, LOGOUT_MESSAGE, MAIL_SERVER_DEFAULT, MAIL_SERVER_KEY, MAIL_SMTP_FROM, MODULE_CACHE_DEFAULT, MODULE_CACHE_KEY, MODULE_PACKAGES, NAVIGATION_CACHE_SIZE_DEFAULT, NAVIGATION_CACHE_SIZE_KEY, NAVIGATION_PLACEHOLDER, NAVIGATION_PREFIX, PAGE_CACHE_SIZE_DEFAULT, PAGE_CACHE_SIZE_KEY, PAGE_DEFAULT_DEFAULT, PAGE_DEFAULT_KEY, PAGE_PREFIX, PP_URL_CASE_FOLDING, PROCESSING_EXCEPTION_PLACEHOLDER, SCHEDULED_JOB_CACHE_SIZE_DEFAULT, SCHEDULED_JOB_CACHE_SIZE_KEY, SCHEDULEDJOB_PREFIX, SCHEDULER_LOG_FACILITY, SCREEN_CACHE_SIZE_DEFAULT, SCREEN_CACHE_SIZE_KEY, SCREEN_DEFAULT_DEFAULT, SCREEN_ERROR_DEFAULT, SCREEN_ERROR_KEY, SCREEN_HOMEPAGE, SCREEN_INVALID_STATE, SCREEN_LOGIN, SCREEN_PLACEHOLDER, SCREEN_PREFIX, SESSION_TIMEOUT_DEFAULT, SESSION_TIMEOUT_KEY, STACK_TRACE_PLACEHOLDER, STANDARD_PIPELINE, TEMPLATE_ERROR_JSP, TEMPLATE_ERROR_KEY, TEMPLATE_ERROR_VM, TEMPLATE_HOMEPAGE, TEMPLATE_INVALID_STATE, TEMPLATE_LOGIN, USE_SSL_DEFAULT, USE_SSL_KEY, UUID_ADDRESS_KEY, WEB_CONTEXT, WEBAPP_ROOT_KEY

Constructor Summary

DefaultSessionValidationValve()

Method Summary

void	invoke(PipelineData pipelineData, ValveContext context) Perform request processing as required by this Valve.

Methods inherited from class org.apache.turbine.pipeline.AbstractValve

getRunData, initialize

Methods inherited from class java.lang.Object

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

Field Detail

sessionValidator

protected SessionValidator sessionValidator

Constructor Detail

DefaultSessionValidationValve

public DefaultSessionValidationValve()
                              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

invoke

public void invoke(PipelineData pipelineData,
                   ValveContext context)
            throws java.io.IOException,
                   TurbineException

Description copied from interface: Valve

Perform request processing as required by this Valve.

An individual Valve MAY perform the following actions, in the specified order:

• Examine and/or modify the properties of the specified Request and Response.
• Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller.
• Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on.
• If the corresponding Response was not generated (and control was not returned, call the next Valve in the pipeline (if there is one) by executing context.invokeNext().
• Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve via a call to context.invokeNext()).

A Valve MUST NOT do any of the following things:

• Change request properties that have already been used to direct the flow of processing control for this request.
• Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline.
• Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on.
• Modify the HTTP headers included with the Response after the invokeNext() method has returned.
• Perform any actions on the output stream associated with the specified Response after the invokeNext() method has returned.

Specified by:

invoke in interface Valve

Specified by:

invoke in class AbstractValve

Parameters:

pipelineData - The run-time information, including the servlet request and response we are processing.

context - The valve context used to invoke the next valve in the current processing pipeline

Throws:

java.io.IOException - Thrown by a subsequent Valve.

TurbineException - Thrown by a subsequent Valve.

See Also:

org.apache.turbine.Valve#invoke(RunData, ValveContext)