Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client

Interface UaSession

All Known Implementing Classes:
OpcUaSession
public interface UaSession

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Object
    getAttribute(@NonNull String name)
    Returns the attribute bound to name in this session, or null if no attribute is bound under that name.
    org.eclipse.milo.opcua.stack.core.types.builtin.NodeId
    getAuthenticationToken()
    Get the authentication token assigned by the server.
    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger
    getMaxRequestSize()
     
    org.eclipse.milo.opcua.stack.core.types.builtin.ByteString
    getServerCertificate()
     
    org.eclipse.milo.opcua.stack.core.types.builtin.ByteString
    getServerNonce()
     
    org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[]
    getServerSoftwareCertificates()
     
    org.eclipse.milo.opcua.stack.core.types.builtin.NodeId
    getSessionId()
    Get the session id assigned by the server.
    String
    getSessionName()
     
    Double
    getSessionTimeout()
    Get the revised session timeout, that is, the number of milliseconds a session may remain open without activity.
    @Nullable Object
    removeAttribute(@NonNull String name)
    Removes the attribute bound with the specified name from this session.
    @Nullable Object
    setAttribute(@NonNull String name, @NonNull Object value)
    Binds an attribute to this session, using the name specified.

  • Method Details

    • getAuthenticationToken

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getAuthenticationToken()
      Get the authentication token assigned by the server.
      Returns:
      a unique NodeId assigned by the server to the session.

    • getSessionId

      org.eclipse.milo.opcua.stack.core.types.builtin.NodeId getSessionId()
      Get the session id assigned by the server.

      This identifier is used to access the diagnostics information for the session in the server address space. It is also used in the audit logs and any events that report information related to the session.

      Returns:
      a unique NodeId assigned by the server to the session.

    • getSessionName

      String getSessionName()
      Returns:
      the human-readable name assigned to this session by the client.

    • getSessionTimeout

      Double getSessionTimeout()
      Get the revised session timeout, that is, the number of milliseconds a session may remain open without activity.
      Returns:
      the revised session timeout.

    • getMaxRequestSize

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxRequestSize()
      Returns:
      the maximum allowable size for any request sent to the server.

    • getServerNonce

      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getServerNonce()
      Returns:
      the last nonce received from the server.

    • getServerCertificate

      org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getServerCertificate()
      Returns:
      the server application instance certificate.

    • getServerSoftwareCertificates

      org.eclipse.milo.opcua.stack.core.types.structured.SignedSoftwareCertificate[] getServerSoftwareCertificates()
      Returns:
      the server SignedSoftwareCertificates.

    • getAttribute

      @Nullable Object getAttribute(@NonNull String name)
      Returns the attribute bound to name in this session, or null if no attribute is bound under that name.
      Parameters:
      name - the name the attribute is bound to.
      Returns:
      the attribute value.

    • setAttribute

      @Nullable Object setAttribute(@NonNull String name, @NonNull Object value)
      Binds an attribute to this session, using the name specified.

      If an object of the same name is already bound to the session, the object is replaced.

      Parameters:
      name - the name to bind the attribute to.
      value - the attribute value.
      Returns:
      the previously bound value, or null if none exists.

    • removeAttribute

      @Nullable Object removeAttribute(@NonNull String name)
      Removes the attribute bound with the specified name from this session.

      If the session does not have an attribute bound with the specified name, this method does nothing.

      Parameters:
      name - the name the attribute is bound to.
      Returns:
      the previously bound value, or null if none exists.