Package com.sun.identity.saml2.profile

Class IDPSession

  • public class IDPSession
extends Object
    This class represents a session in the identity provider side. It keeps track of information that is needed for single sign on as well as single log out.

    • Constructor Detail

      • IDPSession

        public IDPSession​(Object session)
        Constructor for a IDPSession.
        Parameters:
        session - the session object corresponding to the IDPSession

    • Method Detail

      • getSession

        public Object getSession()
        Returns the session object.
        Returns:
        the session object.

      • setSession

        public void setSession​(Object session)
        Sets the session object.
        Parameters:
        session - The session object.

      • getNameIDandSPpairs

        public List<NameIDandSPpair> getNameIDandSPpairs()
        Returns the list of NameID and SPEntityID pair of the session.
        Returns:
        the list of NameID and SPEntityID pair of the session

      • setPendingLogoutRequestID

        public void setPendingLogoutRequestID​(String id)
        Sets the pending log out request id of the session.
        Parameters:
        id - the request id

      • getPendingLogoutRequestID

        public String getPendingLogoutRequestID()
        Returns the pending log out request id of the session.
        Returns:
        id the pending log out request id

      • setOriginatingLogoutRequestBinding

        public void setOriginatingLogoutRequestBinding​(String originatingLogoutRequestBinding)
        Sets the original logout request binding.
        Parameters:
        originatingLogoutRequestBinding - the original logout request binding.

      • getOriginatingLogoutRequestBinding

        public String getOriginatingLogoutRequestBinding()
        Returns the original logout request binding.
        Returns:
        The original logout request binding.

      • setOriginatingLogoutRequestID

        public void setOriginatingLogoutRequestID​(String id)
        Sets the original log out request id of the session.
        Parameters:
        id - the request id

      • getOriginatingLogoutRequestID

        public String getOriginatingLogoutRequestID()
        Returns the original log out request id of the session.
        Returns:
        the original log out request id

      • setOriginatingLogoutSPEntityID

        public void setOriginatingLogoutSPEntityID​(String id)
        Sets the original log out SPEntityID of the session.
        Parameters:
        id - the SPEntityID

      • getOriginatingLogoutSPEntityID

        public String getOriginatingLogoutSPEntityID()
        Returns the original log out SPEntityID of the session.
        Returns:
        the original log out SPEntityID

      • setLogoutAll

        public void setLogoutAll​(boolean enable)
        Sets the logoutAll property.
        Parameters:
        enable - true or false

      • getLogoutAll

        public boolean getLogoutAll()
        Returns the logoutAll property.
        Returns:
        the logoutAll property.

      • getSessionPartners

        public List getSessionPartners()
        Returns list of session partners.
        Returns:
        list of session partners

      • addSessionPartner

        public void addSessionPartner​(SAML2SessionPartner sessionPartner)
        Adds a session partner.
        Parameters:
        sessionPartner - session partner to be added

      • getCurrentSessionPartner

        public SAML2SessionPartner getCurrentSessionPartner()
        Returns the first session partner of the list of session partners.
        Returns:
        the first session partner of the list

      • removeSessionPartner

        public void removeSessionPartner​(String sessionPartner)
        Removes a session partner.
        Parameters:
        sessionPartner - session partner to be removed

      • getAuthnContext

        public String getAuthnContext()
        Returns authentication context.
        Returns:
        authentication context
        See Also:
        setAuthnContext(String)

      • setAuthnContext

        public void setAuthnContext​(String authnContext)
        Sets authentication context.
        Parameters:
        authnContext - authentication context to be set
        See Also:
        getAuthnContext()

      • setMetaAlias

        public void setMetaAlias​(String metaAlias)
        Sets the IDP Meta Alias.
        Parameters:
        metaAlias - Meta Alias

      • getMetaAlias

        public String getMetaAlias()
        Returns the IDP Meta Alias.
        Returns:
        the IDP Meta Alias