org.apache.beehive.netui.pageflow
Interface ServletContainerAdapter

All Superinterfaces:

Adapter

All Known Implementing Classes:

DefaultServletContainerAdapter

public interface ServletContainerAdapter
extends Adapter

Adapter interface for plugging into various Servlet containers. An implementor of this interface is "discovered" at runtime. The discovery process is as follows:

• A list of META-INF/services/org.apache.beehive.netui.pageflow.ServletContainerAdapter resources is obtained from classpath. This means, for example, that a file called "org.apache.beehive.netui.pageflow.ServletContainerAdapter" under directory META-INF/services would be found inside any JAR file on classpath.
• Inside each of these resources is the name of a class that implements ServletContainerAdapter. This class is loaded, and its accept method is called.
• If accept returns true, then that implementation class is chosen as the current adapter; otherwise, the next one in the list is tried.
• If no adapters are discovered, an instance of DefaultServletContainerAdapter is used.

isInProductionMode

boolean isInProductionMode()

Tell whether the server is running in production mode.

Returns:

true if the server is running in production mode.

getSecurityProtocol

SecurityProtocol getSecurityProtocol(String path,
                                     HttpServletRequest request)

Tell whether a web application resource requires a secure transport protocol. This is determined from web.xml; for example, the following block specifies that all resources under /login require a secure transport protocol.

    <security-constraint>
        <web-resource-collection>
          <web-resource-name>Secure PageFlow - begin</web-resource-name> 
          <url-pattern>/login/*</url-pattern>
        </web-resource-collection>
        <user-data-constraint>
           <transport-guarantee>CONFIDENTIAL</transport-guarantee>
        </user-data-constraint>
    </security-constraint>
 

Parameters:

path - a webapp-relative path for a resource.

request - the current HttpServletRequest.

Returns:

Boolean.TRUE if a transport-guarantee of CONFIDENTIAL or INTEGRAL is associated with the given resource; Boolean.FALSE a transport-guarantee of NONE is associated with the given resource; or null if there is no transport-guarantee associated with the given resource.

doSecurityRedirect

boolean doSecurityRedirect(String path,
                           HttpServletRequest request,
                           HttpServletResponse response)

Cause the server to do a security check for the given path. If required, it does a redirect to change the scheme (http/https).

Parameters:

path - the webapp-relative path on which to run security checks.

request - the current HttpServletRequest.

response - the current HttpServletResponse.

Returns:

true if a redirect occurred.

getListenPort

int getListenPort(HttpServletRequest request)

Get the port on which the server is listening for unsecure connections.

Parameters:

request - the current HttpServletRequest.

Returns:

the port on which the server is listening for unsecure connections.

getSecureListenPort

int getSecureListenPort(HttpServletRequest request)

Get the port on which the server is listening for secure connections.

Parameters:

request - the current HttpServletRequest.

Returns:

the port on which the server is listening for secure connections.

login

void login(String username,
           String password,
           HttpServletRequest request,
           HttpServletResponse response)
           throws LoginException

Log in the user, using "weak" username/password authentication.

Parameters:

username - the user's login name.

password - the user's password.

request - the current HttpServletRequest.

response - the current HttpServletResponse.

Throws:

LoginException - if the authentication failed

logout

void logout(boolean invalidateSessions,
            HttpServletRequest request,
            HttpServletResponse response)

Log out the current user.

Parameters:

invalidateSessions - if true, the session is invalidated (on all single-signon webapps); otherwise the session and its data are left intact. To invalidate the session in only the current webapp, set this parameter to false and call invalidate() on the HttpSession.

request - the current HttpServletRequest.

response - the current HttpServletResponse.

getFullContextPath

String getFullContextPath(HttpServletRequest request)

Return the webapp context path for the given request. This differs from HttpServletRequest.getContextPath() only in that it will return a valid value even if the request is for the default webapp.

Parameters:

request - the current HttpServletRequest.

ensureFailover

void ensureFailover(String attrName,
                    Object attrVal,
                    HttpServletRequest request)

Ensure that the given session attribute is replicated in a cluster for session failover. This method does not need to be implemented for servers that do not support clustering and session failover.

Parameters:

attrName - the name of the session attribute for which failover should be ensured.

attrVal - the value of the given session attribute.

request - the current HttpServletRequest.

beginRequest

void beginRequest(HttpServletRequest request,
                  HttpServletResponse response)

Called at the beginning of each processed request.

Parameters:

request - the current HttpServletRequest.

response - the current HttpServletResponse.

endRequest

void endRequest(HttpServletRequest request,
                HttpServletResponse response)

Called at the end of each processed request.

Parameters:

request - the current HttpServletRequest.

response - the current HttpServletResponse.

createControlBeanContext

Object createControlBeanContext(HttpServletRequest request,
                                HttpServletResponse response)

Get a context object to support Beehive Controls.

Parameters:

request - the current HttpServletRequest.

response - the current HttpServletResponse.

Returns:

a new ControlBeanContext.

getPlatformName

String getPlatformName()

Get the name of the platform, which may be used to find platform-specific configuration files.

Returns:

the name of the platform

getEventReporter

PageFlowEventReporter getEventReporter()

Get an event reporter, which will be notified of events like "page flow created", "action raised", etc.

getFactory

Factory getFactory(Class classType,
                   String id,
                   FactoryConfig config)

Generic method to get a Factory class that may be container dependent.

This method is called to get the following Factory implementations:

• URLTemplatesFactory

Parameters:

classType - the class type that the factory should extend or implement.

id - can be used for the case where there is more than one possible Factory that extends or implaments the class type.

config - a configuration object passed to a Factory

Returns:

a Factory class that extends or implemtents the given class type.