Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> acegisecurity >> providers >> [ rememberme overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.acegisecurity.providers.rememberme
Class RememberMeAuthenticationToken  

java.lang.Object
  org.acegisecurity.providers.AbstractAuthenticationToken
      org.acegisecurity.providers.rememberme.RememberMeAuthenticationToken

All Implemented Interfaces:

org.acegisecurity.Authentication, java.security.Principal, java.io.Serializable

---

public class RememberMeAuthenticationToken

extends org.acegisecurity.providers.AbstractAuthenticationToken

implements java.io.Serializable

Represents a remembered Authentication.

A remembered Authentication must provide a fully valid Authentication, including the GrantedAuthority[]s that apply.

Version:

$Id: RememberMeAuthenticationToken.java,v 1.4 2005/11/17 00:55:52 benalex Exp $

---

Field Summary
private  boolean	authenticated
private  GrantedAuthority[]	authorities
private  int	keyHash
private  java.lang.Object	principal

 

Constructor Summary
protected	RememberMeAuthenticationToken()
	RememberMeAuthenticationToken(java.lang.String key, java.lang.Object principal, GrantedAuthority[] authorities)           Constructor.

 

Method Summary
boolean	equals(java.lang.Object obj)           This method tests another Principal object for equality with this one.
GrantedAuthority[]	getAuthorities()           Set by an AuthenticationManager to indicate the authorities that the principal has been granted.
java.lang.Object	getCredentials()           Always returns an empty String
int	getKeyHash()
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 class org.acegisecurity.providers.AbstractAuthenticationToken

getDetails, getName, toString

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface java.security.Principal

hashCode

 

Field Detail

principal

private java.lang.Object principal

---

authorities

private GrantedAuthority[] authorities

---

keyHash

private int keyHash

---

authenticated

private boolean authenticated

Constructor Detail

RememberMeAuthenticationToken

public RememberMeAuthenticationToken(java.lang.String key,
                                     java.lang.Object principal,
                                     GrantedAuthority[] authorities)

Constructor.

---

RememberMeAuthenticationToken

protected RememberMeAuthenticationToken()

Method Detail

setAuthenticated

public void setAuthenticated(boolean isAuthenticated)

Description copied from interface: org.acegisecurity.Authentication

See Authentication.isAuthenticated()>Authentication.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.

Specified by:

setAuthenticated in interface org.acegisecurity.Authentication

---

isAuthenticated

public boolean isAuthenticated()

Description copied from interface: org.acegisecurity.Authentication

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.

Specified by:

isAuthenticated in interface org.acegisecurity.Authentication

---

getAuthorities

public GrantedAuthority[] getAuthorities()

Description copied from interface: org.acegisecurity.Authentication

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.

Specified by:

getAuthorities in interface org.acegisecurity.Authentication

---

getCredentials

public java.lang.Object getCredentials()

Always returns an empty String

Specified by:

getCredentials in interface org.acegisecurity.Authentication

---

getKeyHash

public int getKeyHash()

---

getPrincipal

public java.lang.Object getPrincipal()

Description copied from interface: org.acegisecurity.Authentication

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

Specified by:

getPrincipal in interface org.acegisecurity.Authentication

---

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: java.security.Principal

This method tests another Principal object for equality with this one.

Specified by:

equals in interface java.security.Principal

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> acegisecurity >> providers >> [ rememberme overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---