Package com.iizix.server.vsviewer

Class VSViewerParams

java.lang.Object
com.iizix.server.vsviewer.VSViewerParams
public class VSViewerParams extends 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 Details

    • SERVER_CONFIGURATION_ENVIRONMENT

      public static final String SERVER_CONFIGURATION_ENVIRONMENT
      The Server configuration environment property: "env".
      See Also:

    • error

      public final String error
      The error message, null for OK.

    • appID

      public final String appID
      The Application ID, null if not found.

    • app

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

    • user

      public SessionUserIdentifier user
      The session user identifier, null if not defined properly.

    • hash

      public final String hash
      The user hash when the user is returning.

  • Constructor Details

    • VSViewerParams

      public VSViewerParams(ServerShell server, String query)
      Constructor.
      Parameters:
      server - The server instance.
      query - The Query string from the URI.

  • Method Details

    • assignSessionID

      public SessionUserIdentifier assignSessionID(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 String getParameterValue(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 String toString()
      Returns a string representation of this VS Viewer parameters and its values.
      Overrides:
      toString in class Object
      Returns:
      A string representation.