Package org.forgerock.android.auth

Interface SingleSignOnManager

  • All Implemented Interfaces:
    
public interface SingleSignOnManager

    Manage SSO related attributes

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract void persist(SSOToken token) Persist the Token to storage
      abstract void persist(Collection<String> cookies) Persist the Cookies to storage
      abstract void clear() Remove the stored Token and Cookies
      abstract SSOToken getToken() Retrieve the Token
      abstract Collection<String> getCookies() Retrieve the Stored cookies
      abstract boolean hasToken() Check if token exists in the storage.
      abstract void revoke(FRListener<Void> listener) Revoke the SSO Session
      boolean isBroadcastEnabled() Check if broadcast to other Apps in the SSO Group is enabled.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • persist

         abstract void persist(SSOToken token)

        Persist the Token to storage

        Parameters:
        token - The SSO Token

      • persist

         abstract void persist(Collection<String> cookies)

        Persist the Cookies to storage

        Parameters:
        cookies - The cookies `Set-Cookie` HTTP header value

      • clear

         abstract void clear()

        Remove the stored Token and Cookies

      • hasToken

         abstract boolean hasToken()

        Check if token exists in the storage.

        Returns:

        True if token exists, otherwise false

      • revoke

         abstract void revoke(FRListener<Void> listener)

        Revoke the SSO Session

        Parameters:
        listener - Listener to listen for token revocation event.

      • isBroadcastEnabled

         boolean isBroadcastEnabled()

        Check if broadcast to other Apps in the SSO Group is enabled.