Authentication

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> [ acegisecurity overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.acegisecurity.Authentication

SOURCE |

Download org.acegisecurity.Authentication

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.acegisecurity
Interface Authentication

All Superinterfaces:: java.security.Principal, java.io.Serializable

public interface Authentication
extends java.security.Principal, java.io.Serializable

Represents an authentication request.

An Authentication object is not considered authenticated until it is processed by an AuthenticationManager.

Stored in a request org.acegisecurity.context.security.SecurityContext.

Version:: $Id: Authentication.java,v 1.10 2005/11/17 00:55:49 benalex Exp $

Method Summary

GrantedAuthority[] getAuthorities()
          Set by an AuthenticationManager to indicate the authorities that the principal has been granted.

java.lang.Object getCredentials()
          The credentials that prove the principal is correct.

java.lang.Object getDetails()
          Stores additional details about the authentication request.

java.lang.Object getPrincipal()
          The identity of the principal being authenticated.

boolean isAuthenticated()
          Used to indicate to AbstractSecurityInterceptor whether it should present the authentication token to the AuthenticationManager.

void setAuthenticated(boolean isAuthenticated)
          See isAuthenticated() 55 for a full description.

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

setAuthenticated

public void setAuthenticated(boolean isAuthenticated)
                      throws java.lang.IllegalArgumentException

See isAuthenticated() 55 for a full description.

Implementations should always allow this method to be called with a false parameter, as this is used by various classes to specify the authentication token should not be trusted. If an implementation wishes to reject an invocation with a true parameter (which would indicate the authentication token is trusted - a potential security risk) the implementation should throw an java.lang.IllegalArgumentException.

isAuthenticated

public boolean isAuthenticated()

Used to indicate to AbstractSecurityInterceptor whether it should present the authentication token to the AuthenticationManager. Typically an AuthenticationManager (or, more often, one of its AuthenticationProviders) will return an immutable authentication token after successful authentication, in which case that token can safely return true to this method. Returning true will improve performance, as calling the AuthenticationManager for every request will no longer be necessary.

For security reasons, implementations of this interface should be very careful about returning true to this method unless they are either immutable, or have some way of ensuring the properties have not been changed since original creation.

getAuthorities

public GrantedAuthority[] getAuthorities()

Set by an AuthenticationManager to indicate the authorities that the principal has been granted. Note that classes should not rely on this value as being valid unless it has been set by a trusted AuthenticationManager.

getCredentials

public java.lang.Object getCredentials()

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

getDetails

public java.lang.Object getDetails()

Stores additional details about the authentication request. These might be an IP address, certificate serial number etc.

getPrincipal

public java.lang.Object getPrincipal()

The identity of the principal being authenticated. This is usually a username. Callers are expected to populate the principal.