org.apache.shiro.cas
Class CasToken

java.lang.Object
  extended by org.apache.shiro.cas.CasToken
All Implemented Interfaces:
Serializable, AuthenticationToken, RememberMeAuthenticationToken

public class CasToken
extends Object
implements RememberMeAuthenticationToken

This class represents a token for a CAS authentication (service ticket + user id + remember me).

Since:
1.2
See Also:
Serialized Form

Constructor Summary
CasToken(String ticket)
           
 
Method Summary
 Object getCredentials()
          Returns the credentials submitted by the user during the authentication process that verifies the submitted account identity.
 Object getPrincipal()
          Returns the account identity submitted during the authentication process.
 boolean isRememberMe()
          Returns true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.
 void setRememberMe(boolean isRememberMe)
           
 void setUserId(String userId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CasToken

public CasToken(String ticket)
Method Detail

getPrincipal

public Object getPrincipal()
Description copied from interface: AuthenticationToken
Returns the account identity submitted during the authentication process.

Most application authentications are username/password based and have this object represent a username. If this is the case for your application, take a look at the UsernamePasswordToken, as it is probably sufficient for your use.

Ultimately, the object returned is application specific and can represent any account identity (user id, X.509 certificate, etc).

Specified by:
getPrincipal in interface AuthenticationToken
Returns:
the account identity submitted during the authentication process.
See Also:
UsernamePasswordToken

getCredentials

public Object getCredentials()
Description copied from interface: AuthenticationToken
Returns the credentials submitted by the user during the authentication process that verifies the submitted account identity.

Most application authentications are username/password based and have this object represent a submitted password. If this is the case for your application, take a look at the UsernamePasswordToken, as it is probably sufficient for your use.

Ultimately, the credentials Object returned is application specific and can represent any credential mechanism.

Specified by:
getCredentials in interface AuthenticationToken
Returns:
the credential submitted by the user during the authentication process.

setUserId

public void setUserId(String userId)

isRememberMe

public boolean isRememberMe()
Description copied from interface: RememberMeAuthenticationToken
Returns true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.

Specified by:
isRememberMe in interface RememberMeAuthenticationToken
Returns:
true if the submitting user wishes their identity (principal(s)) to be remembered across sessions, false otherwise.

setRememberMe

public void setRememberMe(boolean isRememberMe)


Copyright © 2004-2016 The Apache Software Foundation. All Rights Reserved.