HiggsSession (http-s3 0.0.13 API)

java.lang.Object
- io.higgs.http.server.auth.HiggsSession

All Implemented Interfaces:

Serializable, org.apache.shiro.session.mgt.ValidatingSession, org.apache.shiro.session.Session
```
public class HiggsSession
extends Object
implements org.apache.shiro.session.mgt.ValidatingSession, Serializable
```
Author:

Courtney Robinson

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<Object,Object>`	`attributes`
`protected boolean`	`expired`
`protected String`	`host`
`protected Serializable`	`id`
`protected Date`	`lastAccessTime`
`protected static org.slf4j.Logger`	`log`
`protected static long`	`MILLIS_PER_MINUTE`
`protected static long`	`MILLIS_PER_SECOND`
`protected Date`	`startTimestamp`
`protected Date`	`stopTimestamp`
`protected long`	`timeout`

Constructor Summary

Constructors
Constructor and Description

HiggsSession()

HiggsSession(Serializable id)

Constructors
Constructor and Description
`HiggsSession()`
`HiggsSession(Serializable id)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Returns `true` if the specified argument is an `instanceof` `HiggsSession` and both `id`s are equal.
`protected void`	`expire()`
`void`	`flash(Object key, Object value)` Adds a key value pair to the session which is good for one use.
`Object`	`getAttribute(Object key)`
`Collection<Object>`	`getAttributeKeys()`
`String`	`getHost()`
`Serializable`	`getId()`
`Date`	`getLastAccessTime()`
`Date`	`getStartTimestamp()`
`Date`	`getStopTimestamp()` Returns the time the session was stopped, or `null` if the session is still active.
`long`	`getTimeout()`
`int`	`hashCode()` Returns the hashCode.
`boolean`	`isExpired()` Returns true if this session has expired, false otherwise.
`protected boolean`	`isStopped()`
`protected boolean`	`isTimedOut()` Determines if this session is expired.
`boolean`	`isValid()`
`protected boolean`	`onEquals(HiggsSession ss)` Provides an attribute-based comparison (no ID comparison) - incurred only when 'this' or the session object being compared for equality do not have a session id.
`Object`	`removeAttribute(Object key)`
`void`	`setAttribute(Object key, Object value)`
`void`	`setAttributes(Map<Object,Object> attributes)`
`void`	`setExpired(boolean expired)`
`void`	`setHost(String host)`
`void`	`setId(Serializable id)`
`void`	`setLastAccessTime(Date lastAccessTime)`
`void`	`setStopTimestamp(Date stopTimestamp)`
`void`	`setTimeout(long timeout)`
`void`	`stop()`
`String`	`toString()` Returns the string representation of this HiggsSession, equal to `getClass().getName() + ",id=" + getId()`.
`void`	`touch()`
`void`	`validate()`

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

- Field Detail
  - log
```
protected static final transient org.slf4j.Logger log
```
  - MILLIS_PER_SECOND
```
protected static final long MILLIS_PER_SECOND
```
    See Also:
    Constant Field Values
  - MILLIS_PER_MINUTE
```
protected static final long MILLIS_PER_MINUTE
```
    See Also:
    Constant Field Values
  - startTimestamp
```
protected final Date startTimestamp
```
  - id
```
protected Serializable id
```
  - stopTimestamp
```
protected Date stopTimestamp
```
  - lastAccessTime
```
protected Date lastAccessTime
```
  - timeout
```
protected long timeout
```
  - expired
```
protected boolean expired
```
  - host
```
protected String host
```
  - attributes
```
protected Map<Object,Object> attributes
```
- Constructor Detail
  - HiggsSession
```
public HiggsSession(Serializable id)
```
  - HiggsSession
```
public HiggsSession()
```
- Method Detail
  - flash
```
public void flash(Object key,
         Object value)
```
    Adds a key value pair to the session which is good for one use. Once the object is retrieved it is automatically removed
  - setAttributes
```
public void setAttributes(Map<Object,Object> attributes)
```
  - isValid
```
public boolean isValid()
```
    Specified by:
    
    isValid in interface org.apache.shiro.session.mgt.ValidatingSession
    
    Since:
    
    0.9
  - isStopped
```
protected boolean isStopped()
```
  - isExpired
```
public boolean isExpired()
```
    Returns true if this session has expired, false otherwise. If the session has expired, no further user interaction with the system may be done under this session.
    
    Returns:
    true if this session has expired, false otherwise.
  - getStopTimestamp
```
public Date getStopTimestamp()
```
    Returns the time the session was stopped, or null if the session is still active.
    A session may become stopped under a number of conditions:
    - If the user logs out of the system, their current session is terminated (released).
    - If the session expires
    - The application explicitly calls stop()
    - If there is an internal system error and the session state can no longer accurately reflect the user's behavior, such in the case of a system crash
    Once stopped, a session may no longer be used. It is locked from all further activity.
    Returns:
    The time the session was stopped, or null if the session is still active.
  - setStopTimestamp
```
public void setStopTimestamp(Date stopTimestamp)
```
  - setExpired
```
public void setExpired(boolean expired)
```
  - validate
```
public void validate()
              throws org.apache.shiro.session.InvalidSessionException
```
    Specified by:
    
    validate in interface org.apache.shiro.session.mgt.ValidatingSession
    
    Throws:
    
    org.apache.shiro.session.InvalidSessionException
  - getId
```
public Serializable getId()
```
    Specified by:
    
    getId in interface org.apache.shiro.session.Session
  - setId
```
public void setId(Serializable id)
```
  - getStartTimestamp
```
public Date getStartTimestamp()
```
    Specified by:
    
    getStartTimestamp in interface org.apache.shiro.session.Session
  - getLastAccessTime
```
public Date getLastAccessTime()
```
    Specified by:
    
    getLastAccessTime in interface org.apache.shiro.session.Session
  - setLastAccessTime
```
public void setLastAccessTime(Date lastAccessTime)
```
  - getTimeout
```
public long getTimeout()
```
    Specified by:
    
    getTimeout in interface org.apache.shiro.session.Session
  - setTimeout
```
public void setTimeout(long timeout)
```
    Specified by:
    
    setTimeout in interface org.apache.shiro.session.Session
  - getHost
```
public String getHost()
```
    Specified by:
    
    getHost in interface org.apache.shiro.session.Session
  - setHost
```
public void setHost(String host)
```
  - touch
```
public void touch()
```
    Specified by:
    
    touch in interface org.apache.shiro.session.Session
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.apache.shiro.session.Session
  - getAttributeKeys
```
public Collection<Object> getAttributeKeys()
                                    throws org.apache.shiro.session.InvalidSessionException
```
    Specified by:
    
    getAttributeKeys in interface org.apache.shiro.session.Session
    
    Throws:
    
    org.apache.shiro.session.InvalidSessionException
  - getAttribute
```
public Object getAttribute(Object key)
```
    Specified by:
    
    getAttribute in interface org.apache.shiro.session.Session
  - setAttribute
```
public void setAttribute(Object key,
                Object value)
```
    Specified by:
    
    setAttribute in interface org.apache.shiro.session.Session
  - removeAttribute
```
public Object removeAttribute(Object key)
```
    Specified by:
    
    removeAttribute in interface org.apache.shiro.session.Session
  - isTimedOut
```
protected boolean isTimedOut()
```
    Determines if this session is expired.
    
    Returns:
    true if the specified session has expired, false otherwise.
  - expire
```
protected void expire()
```
  - hashCode
```
public int hashCode()
```
    Returns the hashCode. If the id is not null, its hashcode is returned immediately. If it is null, an attributes-based hashCode will be calculated and returned.
    Do your best to ensure HiggsSession instances receive an ID very early in their lifecycle to avoid the more expensive attributes-based calculation.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    this object's hashCode
    Since:
    
    1.0
  - equals
```
public boolean equals(Object obj)
```
    Returns true if the specified argument is an instanceof HiggsSession and both ids are equal. If the argument is a HiggsSession and either 'this' or the argument does not yet have an ID assigned, the value of onEquals is returned, which does a necessary attribute-based comparison when IDs are not available.
    Do your best to ensure HiggsSession instances receive an ID very early in their lifecycle to avoid the more expensive attributes-based comparison.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to compare with this one for equality.
    
    Returns:
    true if this object is equivalent to the specified argument, false otherwise.
  - onEquals
```
protected boolean onEquals(HiggsSession ss)
```
    Provides an attribute-based comparison (no ID comparison) - incurred only when 'this' or the session object being compared for equality do not have a session id.
    
    Parameters:
    ss - the HiggsSession instance to compare for equality.
    
    Returns:
    true if all the attributes, except the id, are equal to this object's attributes.
    Since:
    
    1.0
  - toString
```
public String toString()
```
    Returns the string representation of this HiggsSession, equal to getClass().getName() + ",id=" + getId().
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the string representation of this HiggsSession, equal to getClass().getName() + ",id=" + getId().
    Since:
    
    1.0

Class HiggsSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

MILLIS_PER_SECOND

MILLIS_PER_MINUTE

startTimestamp

id

stopTimestamp

lastAccessTime

timeout

expired

host

attributes

Constructor Detail

HiggsSession

HiggsSession

Method Detail

flash

setAttributes

isValid

isStopped

isExpired

getStopTimestamp

setStopTimestamp

setExpired

validate

getId

setId

getStartTimestamp

getLastAccessTime

setLastAccessTime

getTimeout

setTimeout

getHost

setHost

touch

stop

getAttributeKeys

getAttribute

setAttribute

removeAttribute

isTimedOut

expire

hashCode

equals

onEquals

toString