Session (Fujion Core Libraries 1.0.1 API)

java.lang.Object
- org.fujion.websocket.Session

```
public class Session
extends Object
```
Container for core resources for a single client session (i.e., web socket connection).

Field Summary

Fields
Modifier and Type Field and Description

static String ATTR_SESSION

Fields
Modifier and Type	Field and Description
`static String`	`ATTR_SESSION`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Session(javax.servlet.ServletContext servletContext, org.springframework.web.socket.WebSocketSession socket)` Create a session, with references to its servlet context and web socket.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`_init(String pageId)` Initialize the session.
`boolean`	`addSessionListener(ISessionListener listener)` Register a session listener.
`protected void`	`destroy()` Destroy the session.
`long`	`getCreationTime()` Returns the session's time of creation.
`String`	`getId()` Returns the session's id, which is the same as the underlying web socket id.
`long`	`getLastActivity()` Returns the time of last activity for the session.
`Page`	`getPage()` Returns the page associated with the session.
`javax.servlet.ServletContext`	`getServletContext()` Returns the servlet context associated with the session.
`org.springframework.web.socket.WebSocketSession`	`getSocket()` Returns the web socket associated with the session.
`Synchronizer`	`getSynchronizer()` Returns the synchronizer associated with the session.
`protected void`	`notifySessionListeners(ClientInvocation invocation)` Notify all session listeners of a client invocation event.
`protected void`	`notifySessionListeners(ClientRequest request)` Notify all session listeners of a client request event.
`void`	`ping(String data)` Send a ping to the client.
`boolean`	`removeSessionListener(ISessionListener listener)` Unregister a session listener.
`void`	`updateLastActivity()` Updates the session's last activity.

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

- Field Detail
  - ATTR_SESSION
```
public static final String ATTR_SESSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Session
```
protected Session(javax.servlet.ServletContext servletContext,
                  org.springframework.web.socket.WebSocketSession socket)
```
    Create a session, with references to its servlet context and web socket.
    
    Parameters:
    
    servletContext - The servlet context.
    
    socket - The web socket.
- Method Detail
  - destroy
```
protected void destroy()
```
    Destroy the session. This destroys the associated page.
  - getId
```
public String getId()
```
    Returns the session's id, which is the same as the underlying web socket id.
    
    Returns:
    
    The session's id.
  - getCreationTime
```
public long getCreationTime()
```
    Returns the session's time of creation.
    
    Returns:
    
    The session's time of creation.
  - getLastActivity
```
public long getLastActivity()
```
    Returns the time of last activity for the session.
    
    Returns:
    
    The time of last activity.
  - updateLastActivity
```
public void updateLastActivity()
```
    Updates the session's last activity.
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    Returns the servlet context associated with the session.
    
    Returns:
    
    The servlet context.
  - getSocket
```
public org.springframework.web.socket.WebSocketSession getSocket()
```
    Returns the web socket associated with the session.
    
    Returns:
    
    The web socket.
  - getSynchronizer
```
public Synchronizer getSynchronizer()
```
    Returns the synchronizer associated with the session.
    
    Returns:
    
    The synchronizer.
  - getPage
```
public Page getPage()
```
    Returns the page associated with the session.
    
    Returns:
    
    The page.
  - addSessionListener
```
public boolean addSessionListener(ISessionListener listener)
```
    Register a session listener.
    
    Parameters:
    
    listener - Session listener to register.
    
    Returns:
    
    True if the operation was successful.
  - removeSessionListener
```
public boolean removeSessionListener(ISessionListener listener)
```
    Unregister a session listener.
    
    Parameters:
    
    listener - Session listener to unregister.
    
    Returns:
    
    True if the operation was successful.
  - notifySessionListeners
```
protected void notifySessionListeners(ClientRequest request)
```
    Notify all session listeners of a client request event.
    
    Parameters:
    
    request - The client request.
  - notifySessionListeners
```
protected void notifySessionListeners(ClientInvocation invocation)
```
    Notify all session listeners of a client invocation event.
    
    Parameters:
    
    invocation - The client invocation.
  - ping
```
public void ping(String data)
```
    Send a ping to the client.
    
    Parameters:
    
    data - Data to send with the ping.
  - _init
```
protected boolean _init(String pageId)
```
    Initialize the session. If already initialized, this only validates that the page id matches that of the associated page. Otherwise, it associates the session with the page specified by the page id.
    
    Parameters:
    
    pageId - The page id.
    
    Returns:
    
    True if initialization took place.

Class Session

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTR_SESSION

Constructor Detail

Session

Method Detail

destroy

getId

getCreationTime

getLastActivity

updateLastActivity

getServletContext

getSocket

getSynchronizer

getPage

addSessionListener

removeSessionListener

notifySessionListeners

notifySessionListeners

ping

_init