Package com.microstrategy.webapi

Class IDSSXMLSessionIdParser

  • Direct Known Subclasses:
    ACMSessionIdParser
    public abstract class IDSSXMLSessionIdParser
extends java.lang.Object
    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.

    • Constructor Detail

      • IDSSXMLSessionIdParser

        public IDSSXMLSessionIdParser()

    • Method Detail

      • convertToConfigSessionId

        public static IDSSXMLSessionId.IConfigSessionId convertToConfigSessionId​(IDSSXMLSessionId iSessionId)
                                                                  throws MSTRWebAPIException
        convertToConfigSessionId will convert a session id into specifically a configuration session id.
        This is possible because of the SIMPLIFIED SESSION feature where there is only one session on the IServer and it can be used as either a configuration session or a project session.
        Parameters:
        iSessionId -
        Returns:
        Configuration Session Id according to the SIMPLIFIED SESSION feature
        Throws:
        MSTRWebAPIException

      • convertToProjectSessionId

        public static IDSSXMLSessionId.IProjectSessionId convertToProjectSessionId​(IDSSXMLSessionId iSessionId,
                                                                           java.lang.String iProjectId)
                                                                    throws MSTRWebAPIException
        convertToProjectSessionId will convert a session id into specifically a project session id.
        This is possible because of the SIMPLIFIED SESSION feature where there is only one session on the IServer and it can be used as either a configuration session or a project session.
        Parameters:
        iSessionId -
        iProjectId -
        Returns:
        Configuration Session Id according to the SIMPLIFIED SESSION feature
        Throws:
        MSTRWebAPIException

      • getAugmentedSessionId

        public abstract java.lang.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

      • getObscuredAugmentedSessionId

        public abstract java.lang.String getObscuredAugmentedSessionId()
        getObscuredAugmentedSessionId returns as a string the augmentedSessionId, except that the IServer session id is obscured. This is suitable for logging.

        This
        A633E7CEC88C42727B6EEC22795DEE6DDFM-WIN-VS15-7:1033^1~00000000000000000000000000000000#BC53E7CEC88C42727B6EEC22795DA974@34952$MASTER
        becomes
        A633E...DFM-WIN-VS15-7:1033^1~00000000000000000000000000000000#BC53E7CEC88C42727B6EEC22795DA974@34952$MASTER
        Returns:
        the obscured augmented Session Id

      • getSessionId

        public abstract java.lang.String getSessionId()

      • getSessionId

        public static java.lang.String getSessionId​(java.lang.String iAugmentedSessionId)
        getSessionId efficiently parses out the session id GUID from an augmented session id
        Parameters:
        iAugmentedSessionId -
        Returns:

      • getIServerNodeName

        public abstract java.lang.String getIServerNodeName()

      • getIServerNodeName

        public static java.lang.String getIServerNodeName​(java.lang.String iAugmentedSessionId)
        getIServerNodeName efficiently parses out the IServer node name from an augmented session id
        Parameters:
        iAugmentedSessionId -
        Returns:

      • getPort

        public abstract int getPort()

      • getPort

        public static java.lang.Integer getPort​(java.lang.String iAugmentedSessionId)

      • addLocale

        public abstract void addLocale​(int iLocale)

      • hasLocale

        public abstract boolean hasLocale()

      • getLocaleOpt

        public abstract java.util.Optional<java.lang.Integer> getLocaleOpt()

      • getLocale

        public static java.lang.Integer getLocale​(java.lang.String iAugmentedSessionId)
        getLocale efficiently parses out the locale from an augmented session id
        Parameters:
        iAugmentedSessionId -
        Returns:

      • addRetVal

        public abstract void addRetVal​(int iRetVal)

      • hasRetVal

        public abstract boolean hasRetVal()

      • getRetValOpt

        public abstract java.util.Optional<java.lang.Integer> getRetValOpt()

      • getRetVal

        public static java.lang.Integer getRetVal​(java.lang.String iAugmentedSessionId)
        getRetVal efficiently parses out the return value from an augmented session id
        Parameters:
        iAugmentedSessionId -
        Returns:

      • addMessageId

        public abstract void addMessageId​(java.lang.String iMessageId)

      • hasMessageId

        public abstract boolean hasMessageId()

      • getMessageIdOpt

        public abstract java.util.Optional<java.lang.String> getMessageIdOpt()

      • getMessageId

        public static java.lang.String getMessageId​(java.lang.String iAugmentedSessionId)
        getMessageId efficiently parses out the message Id from an augmented session id
        Parameters:
        iAugmentedSessionId -
        Returns:

      • addProjectId

        public abstract void addProjectId​(java.lang.String iProjectId)

      • hasProjectId

        public abstract boolean hasProjectId()

      • getProjectIdOpt

        public abstract java.util.Optional<java.lang.String> getProjectIdOpt()

      • getPid

        public static java.lang.String getPid​(java.lang.String iAugmentedSessionId)

      • addSSProjectId

        public abstract void addSSProjectId​(java.lang.String iSSProjectId)

      • hasSSProjectId

        public abstract boolean hasSSProjectId()

      • getSSProjectIdOpt

        public abstract java.util.Optional<java.lang.String> getSSProjectIdOpt()

      • getSSPid

        public static java.lang.String getSSPid​(java.lang.String iAugmentedSessionId)