Package com.microstrategy.webapi.acm

Class ACMSessionId

    • Method Detail

      • Clone

        public abstract ACMSessionId Clone()
                            throws MSTRWebAPIException
        Description copied from interface: IDSSXMLSessionId
        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
        Specified by:
        Clone in interface IDSSXMLSessionId
        Returns:
        the cloned Session Id
        Throws:
        MSTRWebAPIException

      • getSessionId

        public java.lang.String getSessionId()
        Description copied from interface: IDSSXMLSessionId
        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.
        Specified by:
        getSessionId in interface IDSSXMLSessionId
        Returns:
        the Session Id GUID

      • getIServerNodeName

        public java.lang.String getIServerNodeName()
        Description copied from interface: IDSSXMLSessionId
        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()
        Specified by:
        getIServerNodeName in interface IDSSXMLSessionId
        Returns:
        the IServer Node Name

      • getAugmentedSessionId

        public java.lang.String getAugmentedSessionId()
        Description copied from interface: IDSSXMLSessionId
        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.
        Specified by:
        getAugmentedSessionId in interface IDSSXMLSessionId
        Returns:
        the full augmented Session Id

      • getObscuredAugmentedSessionId

        public java.lang.String getObscuredAugmentedSessionId()
        Description copied from interface: IDSSXMLSessionId
        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
        Specified by:
        getObscuredAugmentedSessionId in interface IDSSXMLSessionId
        Returns:
        the obscured augmented Session Id

      • compareTo

        public int compareTo​(ACMSessionId iACMSessionId)
        Specified by:
        compareTo in interface java.lang.Comparable<ACMSessionId>

      • equals

        public boolean equals​(java.lang.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
        Overrides:
        equals in class java.lang.Object

      • hashCode

        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
        Overrides:
        hashCode in class java.lang.Object