WSCSession (WebRTC Session Controller Android API Reference)

java.lang.Object
- oracle.wsc.android.session.WSCSession

```
public final class WSCSession
extends Object
```
WSCSession represents a session between the client and the WebRTC Session Controller server. A client application is expected to create only one session towards the WebRTC Session Controller server for each user. A session may have one or more sub-sessions.

When receiving an incoming message from WebRTC Session Controller, the session dispatches the message to the appropriate package handler like, CallPackage in order to process the message.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WSCSession.Builder` Builder for WSCSession class.
`static interface`	`WSCSession.ConnectionCallback` Callback for connection notification.
`static class`	`WSCSession.Observer` Observer for session state change.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_ACK_INTERVAL` Integer property in milliseconds for message ACK interval.
`static String`	`PROP_BUSY_PING_INTERVAL` Integer property in milliseconds for busy ping interval.
`static String`	`PROP_IDLE_PING_INTERVAL` Integer property in milliseconds for idle ping interval.
`static String`	`PROP_RECONNECT_INTERVAL` Integer property in milliseconds for reconnect interval.
`static String`	`PROP_RECONNECT_TIME` Integer property in milliseconds for reconnect time.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the session.
`String`	`generateCorrelationId()` Generate a correlation ID based on current outbound sequence number of this session. For example, if the current outbound sequence number is 100, "c101" is returned by calling this method.
`String`	`generateSubSessionId()` Generates random UUID according to RFC 4122 v4.
`IceServerConfig`	`getIceServerConfig()` Gets the ICE server handler.
`long`	`getLastActiveTime()`
`Package`	`getPackage(String packageType)` Gets the package.
`Collection`	`getPackages()` Gets the packages.
`Object`	`getProperty(String name)` Gets a property.
`String`	`getSessionId()` Gets the session id.
`SessionState`	`getSessionState()` Gets the session state.
`SubSession`	`getSubSession(String id)` Gets the subsession.
`Collection`	`getSubSessions()` Gets the subsessions.
`List`	`getSystemIceServers()` Gets system ICE servers.
`String`	`getUserName()` Gets the user name.
`void`	`hibernate(HibernateParams params)` Initiates a hibernate request towards the server.
`boolean`	`isSessionClosed()` Checks if the session is in one of the Closed state.
`void`	`putSubSession(SubSession subSession)` Adds a sub session to WSCSession.
`void`	`removeSubSession(String id)` Removes a sub session from WSCSession.
`void`	`sendMessage(Frame message)` Sends the message to WebRTC Session Controller server over a WebSocket.
`String`	`suspend()` Suspends wsc session.
`String`	`toString()`

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

- Field Detail
  - PROP_ACK_INTERVAL
```
public static final String PROP_ACK_INTERVAL
```
    Integer property in milliseconds for message ACK interval. Default is 60000 (60 seconds).
    
    See Also:
    
    Constant Field Values
  - PROP_BUSY_PING_INTERVAL
```
public static final String PROP_BUSY_PING_INTERVAL
```
    Integer property in milliseconds for busy ping interval. Default is 10000 (10 seconds).
    
    See Also:
    
    Constant Field Values
  - PROP_IDLE_PING_INTERVAL
```
public static final String PROP_IDLE_PING_INTERVAL
```
    Integer property in milliseconds for idle ping interval. Default is 20000 (20 seconds).
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_INTERVAL
```
public static final String PROP_RECONNECT_INTERVAL
```
    Integer property in milliseconds for reconnect interval. Default is 10000 (10 seconds). This interval determines how often a reconnect should be attempted when the connection is lost.
    
    See Also:
    
    Constant Field Values
  - PROP_RECONNECT_TIME
```
public static final String PROP_RECONNECT_TIME
```
    Integer property in milliseconds for reconnect time. Default is 60000 (60 seconds). This time specifies for the maximum reconnect period after which reconnect attempts are stopped and session is closed. This value should not be greater than the Server side value of "WebSocket Disconnect Time Limit".
    
    See Also:
    
    Constant Field Values
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPackage
```
public Package getPackage(String packageType)
```
    Gets the package.
    
    Parameters:
    
    packageType - the package type
    
    Returns:
    
    the package
  - getPackages
```
public Collection getPackages()
```
    Gets the packages.
    
    Returns:
    
    the packages
  - sendMessage
```
public void sendMessage(Frame message)
```
    Sends the message to WebRTC Session Controller server over a WebSocket.
    
    Parameters:
    
    message - A json message
  - putSubSession
```
public void putSubSession(SubSession subSession)
```
    Adds a sub session to WSCSession.
    
    Parameters:
    
    subSession - Sub session
  - removeSubSession
```
public void removeSubSession(String id)
```
    Removes a sub session from WSCSession.
    
    Parameters:
    
    id - Sub session identifier
  - getSubSession
```
public SubSession getSubSession(String id)
```
    Gets the subsession.
    
    Parameters:
    
    id - the id
    
    Returns:
    
    the sub session
  - getSubSessions
```
public Collection getSubSessions()
```
    Gets the subsessions.
    
    Returns:
    
    the subsessions
  - generateCorrelationId
```
public String generateCorrelationId()
```
    Generate a correlation ID based on current outbound sequence number of this session.
    For example, if the current outbound sequence number is 100, "c101" is returned by calling this method. Calling this method does not change value of current outbound sequence number itself.
    
    Returns:
    
    correlation-id
  - generateSubSessionId
```
public String generateSubSessionId()
```
    Generates random UUID according to RFC 4122 v4.
    
    Returns:
    
    subsession id
  - getUserName
```
public String getUserName()
```
    Gets the user name.
    
    Returns:
    
    the user name
  - getIceServerConfig
```
public IceServerConfig getIceServerConfig()
```
    Gets the ICE server handler.
    
    Returns:
    
    the ICE server handler
  - getSystemIceServers
```
public List getSystemIceServers()
```
    Gets system ICE servers.
    
    Returns:
    
    List of ICE servers
  - getSessionId
```
public String getSessionId()
```
    Gets the session id.
    
    Returns:
    
    the session id
  - getLastActiveTime
```
public long getLastActiveTime()
```
  - getSessionState
```
public SessionState getSessionState()
```
    Gets the session state.
    
    Returns:
    
    State
  - hibernate
```
public void hibernate(HibernateParams params)
```
    Initiates a hibernate request towards the server. The deviceToken should have been passed during the session creation process. If not, an exception will be thrown.
    
    Parameters:
    
    params - hibernation params
  - isSessionClosed
```
public boolean isSessionClosed()
```
    Checks if the session is in one of the Closed state.
    
    Returns:
    
    true if closed
  - close
```
public void close()
```
    Closes the session.
  - getProperty
```
public Object getProperty(String name)
```
    Gets a property.
    
    Parameters:
    
    name - Property name
    
    Returns:
    
    Value or null if not set
  - suspend
```
public String suspend()
```
    Suspends wsc session. Invoke this method will trigger a WebSocket abnormal close and also return session data used by rehydration.
    
    Returns:
    
    JSON format session data String.

Class WSCSession

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_ACK_INTERVAL

PROP_BUSY_PING_INTERVAL

PROP_IDLE_PING_INTERVAL

PROP_RECONNECT_INTERVAL

PROP_RECONNECT_TIME

Method Detail

toString

getPackage

getPackages

sendMessage

putSubSession

removeSubSession

getSubSession

getSubSessions

generateCorrelationId

generateSubSessionId

getUserName

getIceServerConfig

getSystemIceServers

getSessionId

getLastActiveTime

getSessionState

hibernate

isSessionClosed

close

getProperty

suspend