org.jasig.cas.client.validation
Interface Assertion

All Superinterfaces:
Serializable
All Known Implementing Classes:
AssertionImpl

public interface Assertion
extends Serializable

Represents a response to a validation request.

Since:
3.1
Version:
$Revision$ $Date$
Author:
Scott Battaglia

Method Summary
 Map<String,Object> getAttributes()
          The key/value pairs associated with this assertion.
 Date getAuthenticationDate()
          The date the authentication actually occurred on.
 AttributePrincipal getPrincipal()
          The principal for which this assertion is valid.
 Date getValidFromDate()
          The date from which the assertion is valid from.
 Date getValidUntilDate()
          The date which the assertion is valid until.
 boolean isValid()
          Determines whether an Assertion is considered usable or not.
 

Method Detail

getValidFromDate

Date getValidFromDate()
The date from which the assertion is valid from.

Returns:
the valid from date.

getValidUntilDate

Date getValidUntilDate()
The date which the assertion is valid until.

Returns:
the valid until date.

getAuthenticationDate

Date getAuthenticationDate()
The date the authentication actually occurred on. If its unable to be determined, it should be set to the current time.

Returns:
the authentication date, or the current time if it can't be determined.

getAttributes

Map<String,Object> getAttributes()
The key/value pairs associated with this assertion.

Returns:
the map of attributes.

getPrincipal

AttributePrincipal getPrincipal()
The principal for which this assertion is valid.

Returns:
the principal.

isValid

boolean isValid()
Determines whether an Assertion is considered usable or not. A naive implementation may just check the date validity.

Returns:
true if its valid, false otherwise.
Since:
3.3.0 (though in 3.3.0, no one actually calls this)


Copyright © 2006-2015 Jasig. All Rights Reserved.