public class

ACMSessionIdParser

extends IDSSXMLSessionIdParser
java.lang.Object
   ↳ com.microstrategy.webapi.IDSSXMLSessionIdParser
     ↳ com.microstrategy.webapi.acm.ACMSessionIdParser

Class Overview

ACMSessionIdParser is the implementation of the IDSSXMLSessionId
ACMSessionIdParser is the ONLY place that knows about the content and syntax of the sessionId.

The Syntax:
(1) The 32 character GUID that represents the sessionID as given out by IServer is the first 32 characters in the sessionID
(2) If the string is less than 32 characters, then this cannot represent a GUID and the constructor will throw an exception
(3) There are six possible delimiters (:^~#@$)
(4) The 33rd character up to the end of the string or the first delimiter, whichever comes first, is the machine name
(5) The machine name must exist
(6) The parameter after ":" and up to the end of the string or the next delimiter is the locale
(7) The locale may not exist
(8) The parameter after "^" and up to the end of the string or the next delimiter is the return value
(9) The return value may not exist
(10) The parameter after "~" and up to the end of the string or the next delimiter is the message id
(11) The message idmay not exist
(12) The parameter after "#" and up to the end of the string or the next delimiter is the project id
(13) The project id may not exist
(14) The parameter after "@" and up to the end of the string or the next delimiter is the port associated with the machine (15) The port must exist (16) The parameter after "$" and up to the end of the string or the next delimiter is the session type ("MASTER", "CONFIG", "PROJECT") (17) The type must exist (18) The parameter after "*" and up to the end of the string or the next delimiter is the should close ("CLOSE", "DONTCLOSE") (19) The should close value may not exist. The default is CLOSE (18) If any parameter has invalid syntax then the entire sessionID is assumed invalid

Valid sessionID examples:
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7:1033^1~00000000000000000000000000000000#BC53E7CEC88C42727B6EEC22795DA974@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DD@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7:1033@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7^1@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7~00000000000000000000000000000000@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7#BC53E7CEC88C42727B6EEC22795DA974@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7:1033#BC53E7CEC88C42727B6EEC22795DA974@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7:1033^1@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7:1033~00000000000000000000000000000000@34952$MASTER
A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7:1033~00000000000000000000000000000000@34952$MASTER*DONTCLOSE

Summary

Public Constructors
ACMSessionIdParser(String iAugmentedSessionId, IDSSXMLSessionId.TYPE iType)
ACMSessionIdParser(String iAugmentedSessionId)
Public Methods
void addLocale(int iLocale)
void addMessageId(String iMessageId)
void addProjectId(String iProjectId)
void addRetVal(int iRetVal)
String getAugmentedSessionId()
String getIServerNodeName()
int getLocale()
String getMessageId()
int getPort()
String getProjectId()
int getRetVal()
String getSessionId()
IDSSXMLSessionId.TYPE getType()
boolean hasLocale()
boolean hasMessageId()
boolean hasProjectId()
boolean hasRetVal()
[Expand]
Inherited Methods
From class com.microstrategy.webapi.IDSSXMLSessionIdParser
From class java.lang.Object

Public Constructors

public ACMSessionIdParser (String iAugmentedSessionId, IDSSXMLSessionId.TYPE iType)

public ACMSessionIdParser (String iAugmentedSessionId)

Public Methods

public void addLocale (int iLocale)

public void addMessageId (String iMessageId)

public void addProjectId (String iProjectId)

public void addRetVal (int iRetVal)

public String getAugmentedSessionId ()

public String getIServerNodeName ()

public int getLocale ()

public String getMessageId ()

public int getPort ()

public String getProjectId ()

public int getRetVal ()

public String getSessionId ()

public IDSSXMLSessionId.TYPE getType ()

public boolean hasLocale ()

public boolean hasMessageId ()

public boolean hasProjectId ()

public boolean hasRetVal ()