com.iplanet.sso
Interface SSOTokenEvent


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:


Field Summary
static int SSO_TOKEN_DESTROY
          SSO Token destroy event.
static int SSO_TOKEN_IDLE_TIMEOUT
          SSO Token idle timeout event.
static int SSO_TOKEN_MAX_TIMEOUT
          SSO Token maximum time out event.
static int SSO_TOKEN_PROPERTY_CHANGED
          SSO Token property changed event.
 
Method Summary
 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 Detail

SSO_TOKEN_IDLE_TIMEOUT

static final int SSO_TOKEN_IDLE_TIMEOUT
SSO Token idle timeout event.

See Also:
Constant Field Values

SSO_TOKEN_MAX_TIMEOUT

static final int SSO_TOKEN_MAX_TIMEOUT
SSO Token maximum time out event.

See Also:
Constant Field Values

SSO_TOKEN_DESTROY

static final int SSO_TOKEN_DESTROY
SSO Token destroy event.

See Also:
Constant Field Values

SSO_TOKEN_PROPERTY_CHANGED

static final int SSO_TOKEN_PROPERTY_CHANGED
SSO Token property changed event.

See Also:
Constant Field Values
Method Detail

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
  • and
  • SSO_TOKEN_PROPERTY_CHANGED
Throws:
SSOException - if the SSOTokenEvent type is not one of the above.