Class VSViewerParams


  • public class VSViewerParams
    extends java.lang.Object
    Class used to hold the information for the VS Viewer parameters and to parse the Query string in the VSViewer WebSocket URI.
    Author:
    Christopher Mindus
    • Field Summary

      Fields 
      Modifier and Type Field Description
      AppFactory app
      The application to use, null if not found.
      java.lang.String appID
      The Application ID, null if not found.
      java.lang.String error
      The error message, null for OK.
      java.lang.String hash
      The user hash when the user is returning.
      static java.lang.String SERVER_CONFIGURATION_ENVIRONMENT
      The Server configuration environment property: "env".
      SessionUserIdentifier user
      The session user identifier, null if not defined properly.
    • Constructor Summary

      Constructors 
      Constructor Description
      VSViewerParams​(ServerShell server, java.lang.String query)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SessionUserIdentifier assignSessionID​(java.lang.String sessionID)
      Assigns a new Session ID for this session.
      java.lang.String getParameterValue​(java.lang.String name)
      Gets a property that is defined as the "other" properties, e.g.
      java.lang.String toString()
      Returns a string representation of this VS Viewer parameters and its values.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • SERVER_CONFIGURATION_ENVIRONMENT

        public static final java.lang.String SERVER_CONFIGURATION_ENVIRONMENT
        The Server configuration environment property: "env".
        See Also:
        Constant Field Values
      • error

        public final java.lang.String error
        The error message, null for OK.
      • appID

        public final java.lang.String appID
        The Application ID, null if not found.
      • app

        public final AppFactory app
        The application to use, null if not found.
      • hash

        public final java.lang.String hash
        The user hash when the user is returning.
    • Constructor Detail

      • VSViewerParams

        public VSViewerParams​(ServerShell server,
                              java.lang.String query)
        Constructor.
        Parameters:
        server - The server instance.
        query - The Query string from the URI.
    • Method Detail

      • assignSessionID

        public SessionUserIdentifier assignSessionID​(java.lang.String sessionID)
        Assigns a new Session ID for this session. This changes the user instance to a new SessionUserIdentifier instance.
        Parameters:
        sessionID - The session ID.
        Returns:
        The new SessionUserIdentifier.
      • getParameterValue

        public java.lang.String getParameterValue​(java.lang.String name)
        Gets a property that is defined as the "other" properties, e.g. SERVER_CONFIGURATION_ENVIRONMENT for server configuration environment.
        Parameters:
        name - The parameter name, e.g. "env".
        Returns:
        The defined parameter value, or null if undefined.
      • toString

        public java.lang.String toString()
        Returns a string representation of this VS Viewer parameters and its values.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation.