Session (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.server.Session

```
public class Session
extends Object
```
Client session information, managed by the OPC UA client. The session object is used to keep track of a client session, including diagnostic information.

Field Summary

Fields
Modifier and Type Field and Description

static Session INTERNAL_SESSION

protected List<SessionListener> listeners

Fields
Modifier and Type	Field and Description
`static Session`	`INTERNAL_SESSION`
`protected List<SessionListener>`	`listeners`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Session(SessionManager sessionManager, ApplicationIdentity clientIdentity, String sessionName, SecurityMode securityMode)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`activate(ServerUserIdentity userIdentity)` Activate the session.
`protected ByteString`	`addBrowseContinuationPoint(BrowseContinuationPoint c)`
`protected ByteString`	`addHistoryContinuationPoint(HistoryContinuationPoint historyContinuationPoint)`
`void`	`addSessionListener(SessionListener listener)` Add a Sessionlistener.
`protected void`	`addSubscription(Subscription s)`
`protected void`	`cancel()` This Service is used to cancel outstanding Service requests.
`protected void`	`close(boolean deleteSubscriptions)` This Service is used to terminate a Session.
`protected void`	`deactivate()` Set active=false.
`boolean`	`equals(Object obj)`
`static long`	`getActivationTimeout()` Activation timeout: if a new session is not activated soon enough, it is disposed.
`NodeId`	`getAuthenticationToken()` A unique identifier assigned by the Server to the Session.
`protected BrowseContinuationPoint`	`getBrowseContinuationPoint(ByteString continuationPoint)` Find the BrowseContinuationPoint object indexed with the byte array.
`ServerSecureChannel`	`getChannel()`
`ApplicationIdentity`	`getClientIdentity()` The identity of the client application.
`DateTime`	`getClientLastContactTime()` Last time we got a message from the client, telling us that it was alive.
`protected QualifiedName`	`getDefaultEncoding()` Default data encoding used in the session.
`Locale`	`getDefaultLocale()`
`protected HistoryContinuationPoint`	`getHistoryContinuationPoint(ByteString continuationPoint)` Find the HistoryContinuationPoint object indexed with the byte array.
`List<Locale>`	`getLocales()` Returns an unmodifiable List of the locales requested by the Client in ActivateSession.
`UnsignedInteger`	`getMaxResponseMessageSize()` Maximum size of response messages sent over the stack, as defined by the client.
`protected ByteString`	`getNewServerNonce(int minServerNonceLength)` Create a new serverNonce using minServerNonceLength.
`SecurityMode`	`getSecurityMode()` `SecurityMode` of this session.
`protected ByteString`	`getServerNonce()`
`SessionDiagnostics`	`getSessionDiagnostics()` Diagnostic information of the session.
`NodeId`	`getSessionId()`
`protected SessionManager`	`getSessionManager()`
`String`	`getSessionName()` Human readable string that identifies the Session.
`SessionSecurityDiagnostics`	`getSessionSecurityDiagnostics()` Security diagnostics of the session.
`double`	`getSessionTimeout()`
`int`	`getSubscriptionCount()` Current number of subscriptions in the session.
`protected Queue<Subscription>`	`getTransferredSubscriptions()`
`ServerUserIdentity`	`getUserIdentity()` The user identity that was used to activate the session.
`int`	`hashCode()`
`boolean`	`hasLocale(Locale locale)` Check if the session accepts a locale.
`boolean`	`hasSessionListener(SessionListener listener)` Check if a given listener is added
`boolean`	`isActive()`
`boolean`	`isClosed()` Returns true if this `Session` is closed, either by CloseSessionRequest from the client or any other reason, such as timeout.
`boolean`	`isTimeout()`
`void`	`removeSessionListener(SessionListener listener)` Remove a SessionListener.
`protected void`	`removeSubscription(Subscription s)`
`protected void`	`resetDiagnostics()` Resets the service diagnostics.
`static void`	`setActivationTimeout(long activationTimeout)` /** Activation timeout: if a new session is not activated soon enough, it is disposed.
`protected void`	`setChannel(ServerSecureChannel serverSecureChannel)`
`protected void`	`setLocaleIds(String[] localeIds)` The localeIDs defined by the client, to use in the session
`protected void`	`setMaxResponseMessageSize(UnsignedInteger maxResponseMessageSize)`
`protected void`	`setSessionName(String name)`
`protected void`	`setSessionTimeout(double requestedSessionTimeout)` Define the session timeout.
`String`	`toString()`
`protected void`	`updateDiagnostics()`

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

- Field Detail
  - INTERNAL_SESSION
```
public static final Session INTERNAL_SESSION
```
  - listeners
```
protected List<SessionListener> listeners
```
- Constructor Detail
  - Session
```
protected Session(SessionManager sessionManager,
                  ApplicationIdentity clientIdentity,
                  String sessionName,
                  SecurityMode securityMode)
```
- Method Detail
  - getActivationTimeout
```
public static long getActivationTimeout()
```
    Activation timeout: if a new session is not activated soon enough, it is disposed.
    Default: 10 s
    
    Returns:
    
    the activationTimeout
  - setActivationTimeout
```
public static void setActivationTimeout(long activationTimeout)
```
    /** Activation timeout: if a new session is not activated soon enough, it is disposed.
    Default: 10 s
    
    Parameters:
    
    activationTimeout - the new timeout. the activationTimeout to set
  - addSessionListener
```
public void addSessionListener(SessionListener listener)
```
    Add a Sessionlistener.
    
    Parameters:
    
    listener - listener to add.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getAuthenticationToken
```
public NodeId getAuthenticationToken()
```
    A unique identifier assigned by the Server to the Session. This identifier shall be passed in the RequestHeader of each request and is used with the SecureChannelId to determine whether a Client has access to the Session. This identifier shall not be reused in a way that the Client or the Server has a chance of confusing them with a previous or existing Session.
    
    Returns:
    
    the authenticationToken
  - getChannel
```
public ServerSecureChannel getChannel()
```
    Returns:
    
    the secure channel used by the session
  - getClientIdentity
```
public ApplicationIdentity getClientIdentity()
```
    The identity of the client application.
    
    Returns:
    
    the clientIdentity
  - getClientLastContactTime
```
public DateTime getClientLastContactTime()
```
    Last time we got a message from the client, telling us that it was alive.
    
    Returns:
    
    the clientLastContactTime
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Returns:
    
    the default locale requested by the client application.
  - getLocales
```
public List<Locale> getLocales()
```
    Returns an unmodifiable List of the locales requested by the Client in ActivateSession. The list is empty if the Client didn't specify any (i.e. was null/empty in the ActivateSession). If the same Session is ActivateSession'd again, this list will reflect the changes (if any).
  - getMaxResponseMessageSize
```
public UnsignedInteger getMaxResponseMessageSize()
```
    Maximum size of response messages sent over the stack, as defined by the client.
    
    Returns:
  - getSecurityMode
```
public SecurityMode getSecurityMode()
```
    SecurityMode of this session. NOTE! Related to the CreateSession part, not taking transport layer into account, e.g. even if this is SecurityMode.NONE, the transport layer might be encrypted. However this affects application level authentication, if SecurityMode.getMessageSecurityMode() is other than MessageSecurityMode.None, then each side shall trust eachothers cert or CreateSession would fail.
  - getSessionDiagnostics
```
public SessionDiagnostics getSessionDiagnostics()
```
    Diagnostic information of the session.
    
    Returns:
    
    the diagnostics
  - getSessionId
```
public NodeId getSessionId()
```
  - getSessionName
```
public String getSessionName()
```
    Human readable string that identifies the Session. The Server makes this name and the sessionId visible in its AddressSpace for diagnostic purposes. The Client should provide a name that is unique for the instance of the Client. If this parameter is not specified the Server will assign a value.
    
    Returns:
    
    The name of the session.
  - getSessionSecurityDiagnostics
```
public SessionSecurityDiagnostics getSessionSecurityDiagnostics()
```
    Security diagnostics of the session.
    
    Returns:
    
    the diagnostics
  - getSessionTimeout
```
public double getSessionTimeout()
```
  - getSubscriptionCount
```
public int getSubscriptionCount()
```
    Current number of subscriptions in the session.
    
    Returns:
  - getUserIdentity
```
public ServerUserIdentity getUserIdentity()
```
    The user identity that was used to activate the session.
    
    Returns:
    
    the userIdentity
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - hasLocale
```
public boolean hasLocale(Locale locale)
```
    Check if the session accepts a locale.
    
    Parameters:
    
    locale -
    
    Returns:
  - hasSessionListener
```
public boolean hasSessionListener(SessionListener listener)
```
    Check if a given listener is added
    
    Parameters:
    
    listener - listener to check
    
    Returns:
    
    true if it is added, false if not
  - isActive
```
public boolean isActive()
```
    Returns:
    
    the active
  - isClosed
```
public boolean isClosed()
```
    Returns true if this Session is closed, either by CloseSessionRequest from the client or any other reason, such as timeout. False otherwise.
  - isTimeout
```
public boolean isTimeout()
```
    Returns:
    
    true if the session has timed out because of too little activity.
  - removeSessionListener
```
public void removeSessionListener(SessionListener listener)
```
    Remove a SessionListener.
    
    Parameters:
    
    listener - listener to remove.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - activate
```
protected void activate(ServerUserIdentity userIdentity)
```
    Activate the session.
    
    Parameters:
    
    userIdentity - the new user identity
  - addBrowseContinuationPoint
```
protected ByteString addBrowseContinuationPoint(BrowseContinuationPoint c)
                                         throws StatusException
```
    Throws:
    
    StatusException
  - addHistoryContinuationPoint
```
protected ByteString addHistoryContinuationPoint(HistoryContinuationPoint historyContinuationPoint)
                                          throws StatusException
```
    Throws:
    
    StatusException
  - addSubscription
```
protected void addSubscription(Subscription s)
```
  - cancel
```
protected void cancel()
```
    This Service is used to cancel outstanding Service requests. Successfully canceled service requests shall respond with Bad_RequestCancelledByClient.
  - close
```
protected void close(boolean deleteSubscriptions)
```
    This Service is used to terminate a Session. The Server takes the following actions when it receives a CloseSession request: a) It stops accepting requests for the Session. All subsequent requests received for the Session are discarded. b) It returns negative responses with the StatusCode Bad_SessionClosed to all requests that are currently outstanding to provide for the timely return of the CloseSession response. Clients are urged to wait for all outstanding requests to complete before submitting the CloseSession request. c) It removes the entry for the Client in its SessionDiagnosticArray Variable.
    
    Parameters:
    
    deleteSubscriptions - Also remove all subscriptions, currently registered for the session.
  - deactivate
```
protected void deactivate()
```
    Set active=false.
  - getBrowseContinuationPoint
```
protected BrowseContinuationPoint getBrowseContinuationPoint(ByteString continuationPoint)
                                                      throws StatusException
```
    Find the BrowseContinuationPoint object indexed with the byte array. The ContinuationPoint is also removed from the Session when retrieved.
    
    Parameters:
    
    continuationPoint - the bytearray "index"
    
    Returns:
    
    the continuation point or null if the point is not found
    
    Throws:
    
    StatusException - Bad_ContinuationPointInvalid
  - getDefaultEncoding
```
protected QualifiedName getDefaultEncoding()
```
    Default data encoding used in the session. Used to encode ExtensionObjects that are sent to the client.
    
    Returns:
  - getHistoryContinuationPoint
```
protected HistoryContinuationPoint getHistoryContinuationPoint(ByteString continuationPoint)
                                                        throws StatusException
```
    Find the HistoryContinuationPoint object indexed with the byte array. The ContinuationPoint is also removed from the Session when retrieved.
    
    Parameters:
    
    continuationPoint - the bytearray "index"
    
    Returns:
    
    the continuation point or null if the point is not found
    
    Throws:
    
    StatusException - Bad_ContinuationPointInvalid
  - getNewServerNonce
```
protected ByteString getNewServerNonce(int minServerNonceLength)
```
    Create a new serverNonce using minServerNonceLength.
    
    Parameters:
    
    minServerNonceLength -
    
    Returns:
  - getServerNonce
```
protected ByteString getServerNonce()
```
    Returns:
    
    the last server nonce used to encrypt the data package.
  - getSessionManager
```
protected SessionManager getSessionManager()
```
    Returns:
    
    the sessionManager
  - getTransferredSubscriptions
```
protected Queue<Subscription> getTransferredSubscriptions()
```
    Returns:
    
    the transferredSubscriptions
  - removeSubscription
```
protected void removeSubscription(Subscription s)
```
  - resetDiagnostics
```
protected void resetDiagnostics()
```
    Resets the service diagnostics.
  - setChannel
```
protected void setChannel(ServerSecureChannel serverSecureChannel)
```
    Parameters:
    
    serverSecureChannel - the channel to set.
  - setLocaleIds
```
protected void setLocaleIds(String[] localeIds)
```
    The localeIDs defined by the client, to use in the session
    
    Parameters:
    
    localeIds -
  - setMaxResponseMessageSize
```
protected void setMaxResponseMessageSize(UnsignedInteger maxResponseMessageSize)
```
    Parameters:
    
    maxResponseMessageSize -
  - setSessionName
```
protected void setSessionName(String name)
```
    Parameters:
    
    name - the name to set
  - setSessionTimeout
```
protected void setSessionTimeout(double requestedSessionTimeout)
```
    Define the session timeout. The Server should attempt to honour the Client request for this parameter, but may negotiate this value up or down to meet its own constraints.
    
    Parameters:
    
    requestedSessionTimeout - The timeout requested by the Client. This may be revised to another value, which is then available from getSessionTimeout
  - updateDiagnostics
```
protected void updateDiagnostics()
```

Class Session

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INTERNAL_SESSION

listeners

Constructor Detail

Session

Method Detail

getActivationTimeout

setActivationTimeout

addSessionListener

equals

getAuthenticationToken

getChannel

getClientIdentity

getClientLastContactTime

getDefaultLocale

getLocales

getMaxResponseMessageSize

getSecurityMode

getSessionDiagnostics

getSessionId

getSessionName

getSessionSecurityDiagnostics

getSessionTimeout

getSubscriptionCount

getUserIdentity

hashCode

hasLocale

hasSessionListener

isActive

isClosed

isTimeout

removeSessionListener

toString

activate

addBrowseContinuationPoint

addHistoryContinuationPoint

addSubscription

cancel

close

deactivate

getBrowseContinuationPoint

getDefaultEncoding

getHistoryContinuationPoint

getNewServerNonce

getServerNonce

getSessionManager

getTransferredSubscriptions

removeSubscription

resetDiagnostics

setChannel

setLocaleIds

setMaxResponseMessageSize

setSessionName

setSessionTimeout

updateDiagnostics