Previous Topic: Configure Rewritable Session Schemes

Next Topic: Use an IP Address Session Scheme

Implement the Rewritable Interface

When implementing the rewritable interface, the following methods are available:

Return Value

Method

Description

public string

rewrite(String url, String id, HttpServletRequest req)

Rewrites a requested URL to contain a session identifier.

public string

onSessionCreateRedirect(String id, String url, HttpServletRequest req,
HttpServletResponse resp)

Provides a callback for the event of session creation by redirection. It is typically used in conjunction with forms-based authentication, where the target URL is different from the requested URL. For example, the authentication scheme may modify the URL or add a cookie.

In addition to the rewritable interface, the methods must be implemented in the custom session scheme.

Return Value

Method

Description

protected void

setRequestURI(HttpServletRequest req, String uri)

Allows the scheme to modify the request URI.

protected void

setRequestPathInfo(HttpServletRequest req, String pathInfo)

Allows the scheme to modify the path information of the request.

The methods described in the following table have been implemented to provide logging for rewritable schemes.

Return Value

Method

Description

protected void

logDebug(String msg)

Logs a debug level message (log level 2)

protected void

logInfo(String msg)

Logs an information level message (log levels 1-2)

protected void

logWarn(String msg)

Logs a warning level message (log levels 0-2)