SecuritySession (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.security.SecuritySession

```
public class SecuritySession
extends java.lang.Object
```
Package private class that maintains all per connection data. Particularly, the reference to the generation of the SecurityCache that is in effect when the session is created, is kept here. This allows for a safe fading out of all older generations of SecurityCache as soon as the last session referring to the old SecurityCache goes away.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`browserWebSocket` The browser WebSocket address.
`private SecurityCache`	`cache` security cache in effect by the time of session creation
`private SecurityContext`	`context` security context created for this session
`private java.lang.String`	`description` Session description from SsoAuthenticator.
`private java.lang.String`	`driverName` The client driver name.
`private int`	`httpPort` The web client HTTP port.
`private java.lang.Object`	`id` An object that serves as an ID of this connection
`private boolean`	`interactive` Flag to mark a session as an interactive user.
`private java.lang.String`	`osUserName` The related session UUID.
`private long`	`pid` The related session UUID.
`private java.lang.String`	`relatedSessionUuid` The related session UUID.
`private java.lang.String`	`sessionUuid` The session UUID.
`private long`	`timestamp` Timestamp of when this session was created.
`private java.lang.String`	`userid` Account name.

Constructor Summary

Constructors
Constructor and Description
`SecuritySession(java.lang.Object id, SecurityCache cache)` Package private constructor for client side Session.
`SecuritySession(java.lang.Object id, SecurityCache cache, SecurityContext context)` Package private constructor for server side Session.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBrowserWebSocket()` Gets the browser WebSocket address.
`(package private) SecurityCache`	`getCache()` Gets the security cache this session is bound to.
`java.lang.String`	`getDescription()` Returns the session description from SsoAuthenticator.
`java.lang.String`	`getDriverName()` Returns the client ui driver class.
`int`	`getHttpPort()` Returns the web client HTTP port.
`java.lang.String`	`getOsUserName()` Returns the OS user name.
`long`	`getPid()` Returns the client pid.
`java.lang.String`	`getRelatedSessionUuid()` Gets related session UUID.
`(package private) SecurityContext`	`getSecurityContext()` Gets the session security context.
`(package private) java.lang.Object`	`getSessionId()` Gets the session ID object.
`long`	`getTimeStamp()` Obtain the timestamp of when this session was created.
`java.lang.String`	`getUid()` Gets session UUID.
`(package private) java.lang.String`	`getUserid()` Gets the session's account name.
`(package private) boolean`	`hasContext(SecurityContext context)` Checks whether this session was created with the specified security context.
`(package private) boolean`	`isInteractive()` Reports if the session is interactive.
`(package private) void`	`setBrowserWebSocket(java.lang.String browserWebSocket)` Sets the browser WebSocket address.
`(package private) void`	`setDescription(java.lang.String description)` Sets the session description from SsoAuthenticator.
`(package private) void`	`setDriverName(java.lang.String driverName)` Sets the ui driver class.
`(package private) void`	`setHttpPort(int httpPort)` Sets the web client HTTP port.
`(package private) void`	`setInteractive()` Mark the session as interactive.
`(package private) void`	`setOsUserName(java.lang.String osUserName)` Sets the OS user name.
`(package private) void`	`setPid(long pid)` Sets the client pid.
`(package private) void`	`setRelatedSessionUuid(java.lang.String relatedUuid)` Sets the uuid of the original session (different from uuid when forked).
`(package private) void`	`setUserid(java.lang.String userid)` Set the session's account name.
`(package private) void`	`setUuid(java.lang.String uuid)` Sets the session UUID.

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

- Field Detail
  - id
```
private java.lang.Object id
```
    An object that serves as an ID of this connection
  - context
```
private SecurityContext context
```
    security context created for this session
  - cache
```
private SecurityCache cache
```
    security cache in effect by the time of session creation
  - timestamp
```
private long timestamp
```
    Timestamp of when this session was created.
  - userid
```
private java.lang.String userid
```
    Account name.
  - interactive
```
private boolean interactive
```
    Flag to mark a session as an interactive user.
  - sessionUuid
```
private java.lang.String sessionUuid
```
    The session UUID.
  - relatedSessionUuid
```
private java.lang.String relatedSessionUuid
```
    The related session UUID.
  - driverName
```
private java.lang.String driverName
```
    The client driver name.
  - pid
```
private long pid
```
    The related session UUID.
  - osUserName
```
private java.lang.String osUserName
```
    The related session UUID.
  - httpPort
```
private int httpPort
```
    The web client HTTP port.
  - description
```
private java.lang.String description
```
    Session description from SsoAuthenticator.
  - browserWebSocket
```
private java.lang.String browserWebSocket
```
    The browser WebSocket address.
- Constructor Detail
  - SecuritySession
```
SecuritySession(java.lang.Object id,
                SecurityCache cache)
```
    Package private constructor for client side Session.
    
    Parameters:
    
    id - session ID, normally the socket that maps the connection
    
    cache - reference to a SecurityCache
  - SecuritySession
```
SecuritySession(java.lang.Object id,
                SecurityCache cache,
                SecurityContext context)
```
    Package private constructor for server side Session.
    
    Parameters:
    
    id - session ID, normally the socket that maps the connection
    
    cache - reference to a SecurityCache
    
    context - security context to be associated with the session
- Method Detail
  - setDriverName
```
void setDriverName(java.lang.String driverName)
```
    Sets the ui driver class.
    
    Parameters:
    
    driverName - The ui driver class.
  - getDriverName
```
public java.lang.String getDriverName()
```
    Returns the client ui driver class.
    
    Returns:
    
    See above.
  - setPid
```
void setPid(long pid)
```
    Sets the client pid.
    
    Parameters:
    
    pid - The client pid.
  - getPid
```
public long getPid()
```
    Returns the client pid.
    
    Returns:
    
    See above.
  - setOsUserName
```
void setOsUserName(java.lang.String osUserName)
```
    Sets the OS user name.
    
    Parameters:
    
    osUserName - The OS user name.
  - getOsUserName
```
public java.lang.String getOsUserName()
```
    Returns the OS user name.
    
    Returns:
    
    See above.
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the session description from SsoAuthenticator.
    
    Returns:
    
    See above.
  - setDescription
```
void setDescription(java.lang.String description)
```
    Sets the session description from SsoAuthenticator.
    
    Parameters:
    
    description - The session description from SsoAuthenticator.
  - getHttpPort
```
public int getHttpPort()
```
    Returns the web client HTTP port.
    
    Returns:
    
    See above.
  - setHttpPort
```
void setHttpPort(int httpPort)
```
    Sets the web client HTTP port.
    
    Parameters:
    
    httpPort - The web client HTTP port.
  - getBrowserWebSocket
```
public java.lang.String getBrowserWebSocket()
```
    Gets the browser WebSocket address.
    
    Returns:
    
    The browser WebSocket address.
  - setBrowserWebSocket
```
void setBrowserWebSocket(java.lang.String browserWebSocket)
```
    Sets the browser WebSocket address.
    
    Parameters:
    
    browserWebSocket - The browser WebSocket address.
  - hasContext
```
boolean hasContext(SecurityContext context)
```
    Checks whether this session was created with the specified security context.
    
    Parameters:
    
    context - security context to check
    
    Returns:
    
    true if security context matches
  - getSessionId
```
java.lang.Object getSessionId()
```
    Gets the session ID object.
    
    Returns:
    
    session ID object
  - getUid
```
public java.lang.String getUid()
```
    Gets session UUID.
    
    Returns:
    
    session UUID.
  - getRelatedSessionUuid
```
public java.lang.String getRelatedSessionUuid()
```
    Gets related session UUID.
    
    Returns:
    
    related session UUID.
  - setUuid
```
void setUuid(java.lang.String uuid)
```
    Sets the session UUID.
    
    Parameters:
    
    uuid - The session UUID.
  - setRelatedSessionUuid
```
void setRelatedSessionUuid(java.lang.String relatedUuid)
```
    Sets the uuid of the original session (different from uuid when forked).
    
    Parameters:
    
    relatedUuid - The uuid of the related session.
  - getUserid
```
java.lang.String getUserid()
```
    Gets the session's account name.
    
    Returns:
    
    The userid.
  - setUserid
```
void setUserid(java.lang.String userid)
```
    Set the session's account name.
    
    Parameters:
    
    userid - The account name.
  - setInteractive
```
void setInteractive()
```
    Mark the session as interactive.
  - isInteractive
```
boolean isInteractive()
```
    Reports if the session is interactive.
    
    Returns:
    
    true if the session is interactive.
  - getSecurityContext
```
SecurityContext getSecurityContext()
```
    Gets the session security context.
    
    Returns:
    
    session SecurityContext
  - getCache
```
SecurityCache getCache()
```
    Gets the security cache this session is bound to.
    
    Returns:
    
    session SecurityCache
  - getTimeStamp
```
public long getTimeStamp()
```
    Obtain the timestamp of when this session was created.
    
    Returns:
    
    Milliseconds since the January 1, 1970.

Class SecuritySession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

context

cache

timestamp

userid

interactive

sessionUuid

relatedSessionUuid

driverName

pid

osUserName

httpPort

description

browserWebSocket

Constructor Detail

SecuritySession

SecuritySession

Method Detail

setDriverName

getDriverName

setPid

getPid

setOsUserName

getOsUserName

getDescription

setDescription

getHttpPort

setHttpPort

getBrowserWebSocket

setBrowserWebSocket

hasContext

getSessionId

getUid

getRelatedSessionUuid

setUuid

setRelatedSessionUuid

getUserid

setUserid

setInteractive

isInteractive

getSecurityContext

getCache

getTimeStamp