public
abstract
class
IDSSXMLSessionIdParser
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.webapi.IDSSXMLSessionIdParser |
 Known Direct Subclasses
|
Class Overview
IDSSXMLSessionIdParser is used to parse an augmented session id. It's useful when you don't need the SessionId object. Use IDSSXMLSessionId to both parse AND create a SessionId object.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| IDSSXMLSessionIdParser() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void | addLocale(int iLocale) | ||||||||||
| abstract void | addMessageId(String iMessageId) | ||||||||||
| abstract void | addProjectId(String iProjectId) | ||||||||||
| abstract void | addRetVal(int iRetVal) | ||||||||||
| static IDSSXMLSessionIdParser | builder(String iSessionId, String iNodeName, int iPort, IDSSXMLSessionId.TYPE iType) | ||||||||||
| abstract String | getAugmentedSessionId() | ||||||||||
| abstract String | getIServerNodeName() | ||||||||||
| static String |
getIServerNodeName(String iAugmentedSessionId)
getIServerNodeName efficiently parses out the IServer node name from an augmented session id
| ||||||||||
| abstract int | getLocale() | ||||||||||
| static Integer |
getLocale(String iAugmentedSessionId)
getLocale efficiently parses out the locale from an augmented session id
| ||||||||||
| abstract String | getMessageId() | ||||||||||
| static String |
getMessageId(String iAugmentedSessionId)
getMessageId efficiently parses out the message Id from an augmented session id
| ||||||||||
| static String | getPid(String iAugmentedSessionId) | ||||||||||
| static Integer | getPort(String iAugmentedSessionId) | ||||||||||
| abstract int | getPort() | ||||||||||
| abstract String | getProjectId() | ||||||||||
| static Integer |
getRetVal(String iAugmentedSessionId)
getRetVal efficiently parses out the return value from an augmented session id
| ||||||||||
| abstract int | getRetVal() | ||||||||||
| static String |
getSessionId(String iAugmentedSessionId)
getSessionId efficiently parses out the session id GUID from an augmented session id
| ||||||||||
| abstract String | getSessionId() | ||||||||||
| abstract IDSSXMLSessionId.TYPE | getType() | ||||||||||
| static IDSSXMLSessionId.TYPE | getType(String iAugmentedSessionId) | ||||||||||
| abstract boolean | hasLocale() | ||||||||||
| abstract boolean | hasMessageId() | ||||||||||
| abstract boolean | hasProjectId() | ||||||||||
| abstract boolean | hasRetVal() | ||||||||||
| static IDSSXMLSessionIdParser |
instance(String iAugmentedSessionId)
instance is a factory of the IDSSXMLSessionIdParser
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public IDSSXMLSessionIdParser ()
Public Methods
public static IDSSXMLSessionIdParser builder (String iSessionId, String iNodeName, int iPort, IDSSXMLSessionId.TYPE iType)
Throws
| MSTRWebAPIException |
|---|
public abstract String getAugmentedSessionId ()
public abstract String getIServerNodeName ()
public static String getIServerNodeName (String iAugmentedSessionId)
getIServerNodeName efficiently parses out the IServer node name from an augmented session id
public static Integer getLocale (String iAugmentedSessionId)
getLocale efficiently parses out the locale from an augmented session id
public static String getMessageId (String iAugmentedSessionId)
getMessageId efficiently parses out the message Id from an augmented session id
public static String getPid (String iAugmentedSessionId)
public static Integer getPort (String iAugmentedSessionId)
public abstract int getPort ()
public static Integer getRetVal (String iAugmentedSessionId)
getRetVal efficiently parses out the return value from an augmented session id
public static String getSessionId (String iAugmentedSessionId)
getSessionId efficiently parses out the session id GUID from an augmented session id
public abstract String getSessionId ()
public abstract boolean hasLocale ()
public abstract boolean hasMessageId ()
public abstract boolean hasProjectId ()
public abstract boolean hasRetVal ()
public static IDSSXMLSessionIdParser instance (String iAugmentedSessionId)
instance is a factory of the IDSSXMLSessionIdParser
Returns
- a new instance
Throws
| MSTRWebAPIException |
|---|