PxtSessionDelegateImpl

java.lang.Object
- com.redhat.rhn.frontend.servlets.PxtSessionDelegateImpl

All Implemented Interfaces:

PxtSessionDelegate
```
public class PxtSessionDelegateImpl
extends java.lang.Object
implements PxtSessionDelegate
```
PxtSessionDelegateImpl is an implementation of PxtSessionDelegate that wraps a RequestContext object.

See Also:

PxtSessionDelegate, RequestContext

Constructor Summary

Constructors
Modifier Constructor and Description

protected PxtSessionDelegateImpl()

Constructors
Modifier	Constructor and Description
`protected`	`PxtSessionDelegateImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected WebSession`	`createPxtSession(java.lang.Long uid)` Creates a new pxt session.
`protected WebSession`	`findPxtSessionById(java.lang.Long id)` Retrieves the pxt session with the given ID.
`WebSession`	`getPxtSession(javax.servlet.http.HttpServletRequest request)` Retrieve the pxt session.
`protected java.lang.Long`	`getPxtSessionId(javax.servlet.http.HttpServletRequest request)` Parses the pxt session id out of the pxt cookie if it included in the request.
`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.
`protected void`	`loadPxtSession(javax.servlet.http.HttpServletRequest request)` Loads the pxt session and stores it in the request as an attribute named `session`.
`void`	`refreshPxtSession(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Refreshes the pxt session, effectively reseting the timeout of the session.
`protected void`	`savePxtSession(WebSession pxtSession)` This method is a hook for testing.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PxtSessionDelegateImpl
```
protected PxtSessionDelegateImpl()
```
- Method Detail
  - getPxtSession
```
public 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.
    
    Specified by:
    
    getPxtSession in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    Returns:
    
    The pxt session to which the request is bound.
  - getPxtSessionIfExists
```
public 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.
    
    Specified by:
    
    getPxtSessionIfExists in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    Returns:
    
    The pxt session to which the request is bound if there is one.
  - getWebUserId
```
public java.lang.Long getWebUserId(javax.servlet.http.HttpServletRequest request)
```
    Returns the webUserId property of the pxt session bound to the specified request.
    
    Specified by:
    
    getWebUserId in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    Returns:
    
    The webUserId property of the pxt session.
  - updateWebUserId
```
public 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.
    
    Specified by:
    
    updateWebUserId in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    response - The current response
    
    id - The ID to be assigned to the webUserId property.
    
    See Also:
    
    PxtSessionDelegate.refreshPxtSession(HttpServletRequest, HttpServletResponse)
  - isPxtSessionExpired
```
public boolean isPxtSessionExpired(javax.servlet.http.HttpServletRequest request)
```
    Return true if the pxt session for the current request has expired.
    
    Specified by:
    
    isPxtSessionExpired in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    Returns:
    
    true if the pxt session for the current request has expired, false otherwise
  - isPxtSessionKeyValid
```
public 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.
    
    Specified by:
    
    isPxtSessionKeyValid in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    Returns:
    
    true if the encoded session ID matches the secret key, false otherwise.
  - loadPxtSession
```
protected void loadPxtSession(javax.servlet.http.HttpServletRequest request)
```
    Loads the pxt session and stores it in the request as an attribute named session. If the pxt session is not already present in the request, it is fetched from the database if the pxt cookie is available. If the pxt cookie is not available, a new pxt session is created.
    
    Parameters:
    
    request - The current request.
  - getPxtSessionId
```
protected java.lang.Long getPxtSessionId(javax.servlet.http.HttpServletRequest request)
```
    Parses the pxt session id out of the pxt cookie if it included in the request.
    
    Parameters:
    
    request - The current request.
    
    Returns:
    
    The pxt session id parsed out of the pxt cookie, if the cookie is included in the request. Return null if the pxt cookie is not found or if the key is invalid.
  - findPxtSessionById
```
protected WebSession findPxtSessionById(java.lang.Long id)
```
    Retrieves the pxt session with the given ID. This method simply wraps a call to WebSessionFactory. This makes it easier to write tests that can avoid calls to WebSessionFactory, which would result in database calls.
    
    Parameters:
    
    id - The session ID to search by.
    
    Returns:
    
    The pxt session or null if no session is found.
    
    See Also:
    
    WebSessionFactory.lookupById(Long)
  - createPxtSession
```
protected WebSession createPxtSession(java.lang.Long uid)
```
    Creates a new pxt session. This method simply wraps a call to SessionManager. This makes it easier to write tests that can avoid calls to SessionManager, which would result in database calls.
    
    Parameters:
    
    uid - The user id to create the session for.
    
    Returns:
    
    A new pxt session.
    
    See Also:
    
    SessionManager.makeSession(Long, long)
  - refreshPxtSession
```
public 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.
    Specified by:
    
    refreshPxtSession in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    response - The current response
  - savePxtSession
```
protected void savePxtSession(WebSession pxtSession)
```
    This method is a hook for testing.
    
    Parameters:
    
    pxtSession - The session to be saved
  - invalidatePxtSession
```
public void invalidatePxtSession(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
```
    Invalidates the pxt session for the given request.
    
    Specified by:
    
    invalidatePxtSession in interface PxtSessionDelegate
    
    Parameters:
    
    request - The current request
    
    response - The current response

Class PxtSessionDelegateImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PxtSessionDelegateImpl

Method Detail

getPxtSession

getPxtSessionIfExists

getWebUserId

updateWebUserId

isPxtSessionExpired

isPxtSessionKeyValid

loadPxtSession

getPxtSessionId

findPxtSessionById

createPxtSession

refreshPxtSession

savePxtSession

invalidatePxtSession