public abstract class

ACMSessionId

extends Object
implements IDSSXMLSessionId
java.lang.Object
   ↳ com.microstrategy.webapi.acm.ACMSessionId
Known Direct Subclasses

Class Overview

ACMSessionId is the implementation of the IDSSXMLSessionId

Summary

Nested Classes
class ACMSessionId.ConfigSessionId  
class ACMSessionId.MasterSessionId  
class ACMSessionId.ProjectSessionId  
Public Constructors
ACMSessionId(String iAugmentedSessionId, IDSSXMLSessionId.TYPE iType)
ACMSessionId(IDSSXMLSessionIdParser iSessionIdParser)
Public Methods
abstract ACMSessionId Clone()
Clone will create a new copy of the IDSSXMLSessionId.
void addLocale(int iLocale)
void addMessageId(String iMessageId)
void addProjectId(String iProjectId)
void addRetVal(int iRetVal)
abstract IDSSXMLSessionId.IConfigSessionId castConfigSessionId()
castConfigSessionId returns the IConfigSessionId already cast.
abstract IDSSXMLSessionId.IProjectSessionId castProjectSessionId()
castProjectSessionId returns the IPsid already cast.
boolean equals(Object iThat)
equals compares ONLY the Session Id proper.
String getAugmentedSessionId()
getAugmentedSessionId returns as a string the full sessionID including the IServer node name, locale, return value, message id,and/or the project id.
String getIServerNodeName()
getIServerNodeName extracts the IServer node name from the sessionID.
int getLocale()
getLocale extracts the locale from the sessionID.
String getMessageId()
getMessageId extracts the message id from the sessionID.
int getPort()
String getProjectId()
getProjectId extracts the project id from the sessionID.
int getRetVal()
getRetVal extracts the return value from the sessionID.
String getSessionId()
getSessionId extracts only the 32 character GUID.
IDSSXMLSessionId.TYPE getType()
getType returns what type of SessionId this is.
boolean hasLocale()
boolean hasMessageId()
boolean hasProjectId()
boolean hasRetVal()
int hashCode()
hash hashes ONLY the Session Id proper.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.webapi.IDSSXMLSessionId

Public Constructors

public ACMSessionId (String iAugmentedSessionId, IDSSXMLSessionId.TYPE iType)

Throws
MSTRWebAPIException

public ACMSessionId (IDSSXMLSessionIdParser iSessionIdParser)

Throws
MSTRWebAPIException

Public Methods

public abstract ACMSessionId Clone ()

Clone will create a new copy of the IDSSXMLSessionId. This is good because the ConfigSessionIds and ProjectSessionIds are held inside a number of maps and will be accessed on different threads. To avoid locking, it is good to create a Clone that you can use temporarily

Returns
  • the cloned Session Id
Throws
MSTRWebAPIException

public void addLocale (int iLocale)

Throws
MSTRWebAPIException

public void addMessageId (String iMessageId)

Throws
MSTRWebAPIException

public void addProjectId (String iProjectId)

Throws
MSTRWebAPIException

public void addRetVal (int iRetVal)

Throws
MSTRWebAPIException

public abstract IDSSXMLSessionId.IConfigSessionId castConfigSessionId ()

castConfigSessionId returns the IConfigSessionId already cast. If this object is not a ConfigSessionId it will throw MSTRWebAPIException. To avoid the throw use getType to find out what type it is before casting

Returns
  • the cast Configuration Session Id
Throws
MSTRWebAPIException

public abstract IDSSXMLSessionId.IProjectSessionId castProjectSessionId ()

castProjectSessionId returns the IPsid already cast. If this object is not a ProjectSessionId it will throw MSTRWebAPIException. To avoid the throw use getType to find out what type it is before casting

Returns
  • the cast Project Session Id
Throws
MSTRWebAPIException

public boolean equals (Object iThat)

equals compares ONLY the Session Id proper. It does not check the augmented parts. That's because the real Session Id does not include the augmented parts. The augmented parts are superfluous

public String getAugmentedSessionId ()

getAugmentedSessionId returns as a string the full sessionID including the IServer node name, locale, return value, message id,and/or the project id. This string can be used by methods in the Web SDK. It is important to not make any assumptions about the contents and/or syntax of the string.

Returns
  • the full augmented Session Id

public String getIServerNodeName ()

getIServerNodeName extracts the IServer node name from the sessionID. It will throw if it is not part of the sessionID. To avoid the throw, first use hasIServerNodeName()

Returns
  • the IServer Node Name

public int getLocale ()

getLocale extracts the locale from the sessionID. It will throw if it is not part of the sessionID. To avoid the throw, first use hasLocale()

Returns
  • the Locale
Throws
MSTRWebAPIException

public String getMessageId ()

getMessageId extracts the message id from the sessionID. It will throw if it is not part of the sessionID. To avoid the throw, first use hasMessageId()

Returns
  • the Message Id
Throws
MSTRWebAPIException

public int getPort ()

public String getProjectId ()

getProjectId extracts the project id from the sessionID. It will throw if it is not part of the sessionID. To avoid the throw, first use hasPid()

Returns
  • the Project Id
Throws
MSTRWebAPIException

public int getRetVal ()

getRetVal extracts the return value from the sessionID. It will throw if it is not part of the sessionID. To avoid the throw, first use hasRetVal()

Returns
  • the RetVal
Throws
MSTRWebAPIException

public String getSessionId ()

getSessionId extracts only the 32 character GUID. This is the only portion of the sessionID that is guaranteed to exists (note this method does not throw). If that portion is missing, then the IDSSXMLSessionId object will throw during construction.

Returns
  • the Session Id GUID

public IDSSXMLSessionId.TYPE getType ()

getType returns what type of SessionId this is. It is either MasterSessionId, ConfigSessionId, or Psid

Returns
  • The Session Id type

public boolean hasLocale ()

public boolean hasMessageId ()

public boolean hasProjectId ()

public boolean hasRetVal ()

public int hashCode ()

hash hashes ONLY the Session Id proper. It does not hash the augmented parts. That's because the real Session Id does not include the augmented parts. The augmented parts are superfluous