com.redhat.rhn.frontend.servlets

Interface PxtSessionDelegate

All Known Implementing Classes:

PxtSessionDelegateImpl

public interface PxtSessionDelegate

PxtSessionDelegate provides an API with operations for retrieving, creating, and updating the pxt session and pxt cookie.

Similiar operations can be found in RequestContext. Even though a similiar API already exists in RequestContext, this API is provided to server those client who need only these operations and not the full API of RequestContext. Therefore, it is reccomended that you use PxtSessionDelegate instead of RequestContext if this API provides all of the operations that you need.

You obtain instances of PxtSessionDelegate from PxtSessionDelegateFactory. Below is an example of how you might retrieve a PxtSessionDelegate:

  HttpServletRequest request = // Get the current request...
  PxtSessionDelegateFactory factory = PxtSessionDelegateFactory.getInstance();
  PxtSessionDelegate pxtDelegate = factory.newPxtSessionDelegate(request);
 

See Also:

PxtSessionDelegateFactory, RequestContext

Method Summary

Modifier and Type	Method and Description
WebSession	getPxtSession(javax.servlet.http.HttpServletRequest request) Retrieve the pxt session.
WebSession	getPxtSessionIfExists(javax.servlet.http.HttpServletRequest request) Retrieve the pxt session if there is a cookie identifying it or if it was already bound.
java.lang.Long	getWebUserId(javax.servlet.http.HttpServletRequest request) Returns the webUserId property of the pxt session bound to the specified request.
void	invalidatePxtSession(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Invalidates the pxt session for the given request.
boolean	isPxtSessionExpired(javax.servlet.http.HttpServletRequest request) Return true if the pxt session for the current request has expired.
boolean	isPxtSessionKeyValid(javax.servlet.http.HttpServletRequest request) Validates the pxt session ID that is stored in the pxt cookie with a secret key in the pxt session.
void	refreshPxtSession(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Refreshes the pxt session, effectively reseting the timeout of the session.
void	updateWebUserId(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Long id) Sets the webUserId property of the pxt session bound to the specified request.

Method Detail

getWebUserId

java.lang.Long getWebUserId(javax.servlet.http.HttpServletRequest request)

Returns the webUserId property of the pxt session bound to the specified request.

Parameters:

request - The current request

Returns:

The webUserId property of the pxt session.

getPxtSession

WebSession getPxtSession(javax.servlet.http.HttpServletRequest request)

Retrieve the pxt session. If the session does not exist, one will be created. The session will be bound to a request attribute named session.

Parameters:

request - The current request

Returns:

The pxt session to which the request is bound.

getPxtSessionIfExists

WebSession getPxtSessionIfExists(javax.servlet.http.HttpServletRequest request)

Retrieve the pxt session if there is a cookie identifying it or if it was already bound. The newly found session will be bound to a request attribute named session.

Parameters:

request - The current request

Returns:

The pxt session to which the request is bound if there is one.

updateWebUserId

void updateWebUserId(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     java.lang.Long id)

Sets the webUserId property of the pxt session bound to the specified request. Note that this operation triggers a session refresh.

Parameters:

request - The current request

response - The current response

id - The ID to be assigned to the webUserId property.

See Also:

refreshPxtSession(HttpServletRequest, HttpServletResponse)

isPxtSessionExpired

boolean isPxtSessionExpired(javax.servlet.http.HttpServletRequest request)

Return true if the pxt session for the current request has expired.

Parameters:

request - The current request

Returns:

true if the pxt session for the current request has expired, false otherwise

isPxtSessionKeyValid

boolean isPxtSessionKeyValid(javax.servlet.http.HttpServletRequest request)

Validates the pxt session ID that is stored in the pxt cookie with a secret key in the pxt session. Return true if the encoded session ID matches the secret key.

Parameters:

request - The current request

Returns:

true if the encoded session ID matches the secret key, false otherwise.

refreshPxtSession

void refreshPxtSession(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)

Refreshes the pxt session, effectively reseting the timeout of the session. Specifically, implementations of PxtSessionDelegate are responsible for the following:

• Set the expires property of the session to an appropriate value.
• Save the session.
• Store a pxt cookie in the response with an appropriate timeout.

Parameters:

request - The current request

response - The current response

invalidatePxtSession

void invalidatePxtSession(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)

Invalidates the pxt session for the given request.

Parameters:

request - The current request

response - The current response