public class

StaticSession

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.StaticSession

This class is deprecated.
Functionality afforded by this class has been superceded by WebAppSessionManager and the external security feature.

Class Overview

The StaticSession class contains the definition of a single static session which might represent a template for sessions partially defined with default information.

Summary

Constants
String ATT_AUTH_MODE
String ATT_NAME
String ATT_PASSWORD
String ATT_PROJECT_NAME
String ATT_SERVER_NAME
String ATT_USER_NAME
int AUTH_MODE_FIELD_MISSING Flag for indicating auth mode field is missing from the session information
String NODE_SESSION Identifier on the configuration file for elements that will become StaticSession instances
int PASSWORD_FIELD_MISSING Flag for indicating password field is missing from the session information
int PORT_NUMBER_FIELD_MISSING Flag for indicating port number field is missing from the session information
int PROJECT_NAME_FIELD_MISSING Flag for indicating project name field is missing from the session information
int SERVER_NAME_FIELD_MISSING Flag for indicating server name field is missing from the session information
int USER_NAME_FIELD_MISSING Flag for indicating user name field is missing from the session information
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
StaticSession()
Class constructor.
StaticSession(Node root)
Class constructor.
StaticSession(String sessionName, String userName, String password, String serverName, String projectName)
Class constructor.
StaticSession(String sessionName, String serverName, String projectName, int port)
Class constructor.
Public Methods
int getAuthenticationMode()
Return the value of the authentication mode property
int getMissingFields()
Return a flag which value is set according to the fields missing from this instance definition
String getPassword()
Return the value of the password property
int getPort()
Return the value of the port property
String getProjectName()
Return the value of the project name property
String getServerName()
Return the value of the server name property
String getSessionName()
Return the value of the session name property
String getUserName()
Return the value of the user name property
void setAuthenticationMode(int authMode)
Set the value for the authentication mode property
void setPassword(String password)
Set the value for the password property
void setPort(int port)
Set the value for the port property
void setProjectName(String projectName)
Set the value for the project name property
void setServerName(String serverName)
Set the value for the server name property
void setSessionName(String sessionName)
Set the value for the session name -unique identifier- property
void setUserName(String userName)
Set the value for the user name property
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
void initFromXML(Node root, String sourceKey, CustomizationInfo c)
Initialize the attributes and child elements from the values in the given Node
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_AUTH_MODE

Constant Value: "auth-mode"

public static final String ATT_NAME

Constant Value: "name"

public static final String ATT_PASSWORD

Constant Value: "password"

public static final String ATT_PROJECT_NAME

Constant Value: "project-name"

public static final String ATT_SERVER_NAME

Constant Value: "server-name"

public static final String ATT_USER_NAME

Constant Value: "user-name"

public static final int AUTH_MODE_FIELD_MISSING

Flag for indicating auth mode field is missing from the session information

Constant Value: 32 (0x00000020)

public static final String NODE_SESSION

Identifier on the configuration file for elements that will become StaticSession instances

Constant Value: "session"

public static final int PASSWORD_FIELD_MISSING

Flag for indicating password field is missing from the session information

Constant Value: 2 (0x00000002)

public static final int PORT_NUMBER_FIELD_MISSING

Flag for indicating port number field is missing from the session information

Constant Value: 16 (0x00000010)

public static final int PROJECT_NAME_FIELD_MISSING

Flag for indicating project name field is missing from the session information

Constant Value: 8 (0x00000008)

public static final int SERVER_NAME_FIELD_MISSING

Flag for indicating server name field is missing from the session information

Constant Value: 4 (0x00000004)

public static final int USER_NAME_FIELD_MISSING

Flag for indicating user name field is missing from the session information

Constant Value: 1 (0x00000001)

Public Constructors

public StaticSession ()

Class constructor. Initializes a new -empty- instance of the StaticSession class.

public StaticSession (Node root)

Class constructor. Initialize a new instance of the StaticSession class with information from the XML node.

Parameters
root Node instance representing the static session element.

public StaticSession (String sessionName, String userName, String password, String serverName, String projectName)

Class constructor. Initializes the instance setting its properties to the information set as parameter.

Parameters
sessionName name -unique identifier- of the session
userName name of the user
password password for the login
serverName name of the server
projectName name of the project

public StaticSession (String sessionName, String serverName, String projectName, int port)

Class constructor. Initializes the instance setting its properties to the information set as parameter.

Parameters
sessionName name -unique identifier- of the session
serverName name of the server
projectName name of the project
port port number for the session

Public Methods

public int getAuthenticationMode ()

Return the value of the authentication mode property

Returns

public int getMissingFields ()

Return a flag which value is set according to the fields missing from this instance definition

Returns
  • an int value with a flag value indicating which fields are missing from the session definition.

public String getPassword ()

Return the value of the password property

Returns
  • a String value with the password corresponding to the login

public int getPort ()

Return the value of the port property

Returns
  • a int value with the port corresponding to the login

public String getProjectName ()

Return the value of the project name property

Returns
  • a String value with the name of the project

public String getServerName ()

Return the value of the server name property

Returns
  • a String value with the name of the server

public String getSessionName ()

Return the value of the session name property

Returns
  • a String value with the name -identifier- of the session

public String getUserName ()

Return the value of the user name property

Returns
  • a String value with the name of the user (UID / Login)

public void setAuthenticationMode (int authMode)

Set the value for the authentication mode property

Parameters
authMode authentication mode for the login. A value of the EnumDSSXMLAuthModes enumeration.

public void setPassword (String password)

Set the value for the password property

Parameters
password password for the login

public void setPort (int port)

Set the value for the port property

Parameters
port port for the login

public void setProjectName (String projectName)

Set the value for the project name property

Parameters
projectName name of the project

public void setServerName (String serverName)

Set the value for the server name property

Parameters
serverName name of the server

public void setSessionName (String sessionName)

Set the value for the session name -unique identifier- property

Parameters
sessionName name -unique identifier- of the session

public void setUserName (String userName)

Set the value for the user name property

Parameters
userName name of the user

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

protected void initFromXML (Node root, String sourceKey, CustomizationInfo c)

Initialize the attributes and child elements from the values in the given Node

Parameters
root The DOM Node from where the information is read
sourceKey The key that identifies the ElementSource where the values are being read
c CustomizationInfo class where the ElementSource was loaded from.