atg.servlet
Interface HttpSessionRequest

Deprecated.

public interface HttpSessionRequest

This represents session tracking information associated with a request in an HTTP-specific implementation of session tracking. This contains information about how the request was associated with that Session, including what session id was requested and how that id was requested.

This also contains methods for rewriting URL's so that they include the session ID if necessary.

This object is available as an attribute of the ServletRequest, and can be obtained by calling "getAttribute(HttpSessionRequest.ATTRIBUTE_NAME)". The name of the attribute is "javax.servlet.http.session-request".

See Also:

HttpServletRequest, HttpServletResponse

Field Summary

static java.lang.String	ATTRIBUTE_NAME Deprecated. The name of the attribute in a ServletRequest that will hold a SessionRequest.
static java.lang.String	CLASS_VERSION Deprecated.

Method Summary

java.lang.String	encodeRedirectURL(java.lang.String pURL) Deprecated. This will return an "encoded" version of the specified URL for use in the "HttpServletResponse.sendRedirect" method.
java.lang.String	encodeURL(java.lang.String pURL) Deprecated. This will return an "encoded" version of the specified URL, by including the session ID in the URL.
java.lang.String	encodeURL(java.lang.String pURL, java.lang.String pSessionIdSpecifier) Deprecated. This will return an "encoded" version of the specified URL, by including the session ID in the URL.
java.lang.String	getRequestedSessionId() Deprecated. Returns the session id specified by this request, or null if the request did not specify a session id.
javax.servlet.http.HttpSession	getSession() Deprecated. Returns the Session associated with this request.
boolean	isNewSession() Deprecated. Returns true if this request the first request for the Session.
boolean	isRequestedSessionIdFromCookie() Deprecated. Returns true if the session id specified by this request came in as a cookie.
boolean	isRequestedSessionIdFromURL() Deprecated. Returns true if the session id specified by the request for this session came in as part of the URL.
boolean	isRequestedSessionIdInvalid() Deprecated. Returns true if this request specified a session id for an invalid session.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Deprecated.

See Also:

Constant Field Values

ATTRIBUTE_NAME

static final java.lang.String ATTRIBUTE_NAME

Deprecated.

The name of the attribute in a ServletRequest that will hold a SessionRequest.

See Also:

Constant Field Values

Method Detail

getSession

javax.servlet.http.HttpSession getSession()

Deprecated.

Returns the Session associated with this request.

isNewSession

boolean isNewSession()

Deprecated.

Returns true if this request the first request for the Session.

getRequestedSessionId

java.lang.String getRequestedSessionId()

Deprecated.

Returns the session id specified by this request, or null if the request did not specify a session id. This may differ from the actual session id. For example, if the request specified an id for an invalid session, then this will represent a new Session with a new id.

See Also:

isRequestedSessionIdInvalid()

isRequestedSessionIdInvalid

boolean isRequestedSessionIdInvalid()

Deprecated.

Returns true if this request specified a session id for an invalid session. If true, then this will also be a new Session, with a different session id. To access the invalid id that was originally specified, call getRequestedSessionId.

See Also:

getRequestedSessionId()

isRequestedSessionIdFromCookie

boolean isRequestedSessionIdFromCookie()

Deprecated.

Returns true if the session id specified by this request came in as a cookie. Note that the session id that came with the request may not be the actual id of the session, as would be the case if the id was for an invalid session.

isRequestedSessionIdFromURL

boolean isRequestedSessionIdFromURL()

Deprecated.

Returns true if the session id specified by the request for this session came in as part of the URL. Note that the session id that came with the request may not be the actual id of the session, as would be the case if the id was for an invalid session.

encodeURL

java.lang.String encodeURL(java.lang.String pURL)

Deprecated.

This will return an "encoded" version of the specified URL, by including the session ID in the URL. The implementation of this method should include the logic to determine if the session ID needs to be encoded in the URL or not. For example, if the browser supports cookies, or Session Tracking is turned off, URL encoding is probably unnecessary. In cases where the encoding is not needed, the URL will be returned without modification.

All URL's emitted by a Servlet should be run through this method.

encodeURL

java.lang.String encodeURL(java.lang.String pURL,
                           java.lang.String pSessionIdSpecifier)

Deprecated.

This will return an "encoded" version of the specified URL, by including the session ID in the URL. The implementation of this method should include the logic to determine if the session ID needs to be encoded in the URL or not. For example, if the browser supports cookies, or Session Tracking is turned off, URL encoding is probably unnecessary. In cases where the encoding is not needed, the URL will be returned without modification.

All URL's emitted by a Servlet should be run through this method.

The specified session ID specifier is used if the session ID needs to be encoded in the URL instead of the default session ID specifier.

encodeRedirectURL

java.lang.String encodeRedirectURL(java.lang.String pURL)

Deprecated.

This will return an "encoded" version of the specified URL for use in the "HttpServletResponse.sendRedirect" method. Like "encodeURL" this may or may not decide to include the session ID in a URL. The reason this is a separate method is that the rules for making this determination are different for a redirect command and a normal link.

All URL's sent to the "HttpServletResponse.sendRedirect" method should be run through this method.