Package com.iplanet.sso

Interface SSOTokenEvent

@SupportedAll public interface SSOTokenEvent

The SSOTokenEvent is an interface that represents an SSO token event.The single sign on token event represents a change in SSOToken.

The following are possible SSO token event types:
  • SSO_TOKEN_IDLE_TIMEOUT,
  • SSO_TOKEN_MAX_TIMEOUT and
  • SSO_TOKEN_DESTROY
  • SSO_TOKEN_PROPERTY_CHANGED

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    SSO_TOKEN_DESTROY
    SSO Token destroy event.
    static final int
    SSO_TOKEN_IDLE_TIMEOUT
    SSO Token idle timeout event.
    static final int
    SSO_TOKEN_MAX_TIMEOUT
    SSO Token maximum time out event.
    static final int
    SSO_TOKEN_PROPERTY_CHANGED
    SSO Token property changed event.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getTime()
    Returns the time of this event.
    SSOToken
    getToken()
    Returns the SSOToken associated with the SSO Token event.
    int
    getType()
    Returns the type of this event.

  • Field Details

    • SSO_TOKEN_IDLE_TIMEOUT

      static final int SSO_TOKEN_IDLE_TIMEOUT
      SSO Token idle timeout event.
      See Also:

    • SSO_TOKEN_MAX_TIMEOUT

      static final int SSO_TOKEN_MAX_TIMEOUT
      SSO Token maximum time out event.
      See Also:

    • SSO_TOKEN_DESTROY

      static final int SSO_TOKEN_DESTROY
      SSO Token destroy event.
      See Also:

    • SSO_TOKEN_PROPERTY_CHANGED

      static final int SSO_TOKEN_PROPERTY_CHANGED
      SSO Token property changed event.
      See Also:

  • Method Details

    • getToken

      SSOToken getToken()
      Returns the SSOToken associated with the SSO Token event.
      Returns:
      SSOToken

    • getTime

      long getTime()
      Returns the time of this event.
      Returns:
      The event time as UTC milliseconds from the epoch.

    • getType

      int getType() throws SSOException
      Returns the type of this event.
      Returns:
      The type of this event. Possible types are :
      • SSO_TOKEN_IDLE_TIMEOUT
      • SSO_TOKEN_MAX_TIMEOUT
      • SSO_TOKEN_DESTROY
      • SSO_TOKEN_PROPERTY_CHANGED
      Throws:
      SSOException - if the SSOTokenEvent type is not one of the above.