Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.acegisecurity.runas
Class RunAsUserToken  view RunAsUserToken download RunAsUserToken.java

java.lang.Object
  extended byorg.acegisecurity.providers.AbstractAuthenticationToken
      extended byorg.acegisecurity.runas.RunAsUserToken
All Implemented Interfaces:
org.acegisecurity.Authentication, java.security.Principal, java.io.Serializable

public class RunAsUserToken
extends org.acegisecurity.providers.AbstractAuthenticationToken

An immutable org.acegisecurity.Authentication implementation that supports RunAsManagerImpl.

Version:
$Id: RunAsUserToken.java,v 1.5 2005/11/17 00:55:51 benalex Exp $

Field Summary
private  boolean authenticated
           
private  GrantedAuthority[] authorities
           
private  java.lang.Object credentials
           
private  int keyHash
           
private  java.lang.Class originalAuthentication
           
private  java.lang.Object principal
           
 
Constructor Summary
protected RunAsUserToken()
           
  RunAsUserToken(java.lang.String key, java.lang.Object principal, java.lang.Object credentials, GrantedAuthority[] authorities, java.lang.Class originalAuthentication)
           
 
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.
 int getKeyHash()
           
 java.lang.Class getOriginalAuthentication()
           
 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.
 java.lang.String toString()
          This method returns a String representation of this Principal.
 
Methods inherited from class org.acegisecurity.providers.AbstractAuthenticationToken
equals, getDetails, getName
 
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

originalAuthentication

private java.lang.Class originalAuthentication

credentials

private java.lang.Object credentials

principal

private java.lang.Object principal

authorities

private GrantedAuthority[] authorities

keyHash

private int keyHash

authenticated

private boolean authenticated
Constructor Detail

RunAsUserToken

public RunAsUserToken(java.lang.String key,
                      java.lang.Object principal,
                      java.lang.Object credentials,
                      GrantedAuthority[] authorities,
                      java.lang.Class originalAuthentication)

RunAsUserToken

protected RunAsUserToken()
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.


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.


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.


getCredentials

public java.lang.Object getCredentials()
Description copied from interface: org.acegisecurity.Authentication
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.


getKeyHash

public int getKeyHash()

getOriginalAuthentication

public java.lang.Class getOriginalAuthentication()

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.


toString

public java.lang.String toString()
Description copied from interface: java.security.Principal
This method returns a String representation of this Principal.