org.jasig.cas.client.tomcat.v7

Class AbstractCasRealm

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.util.LifecycleMBeanBase

org.apache.catalina.realm.RealmBase

org.jasig.cas.client.tomcat.v7.AbstractCasRealm

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Lifecycle, org.apache.catalina.Realm, CasRealm

Direct Known Subclasses:

AssertionCasRealm, PropertiesCasRealm

public abstract class AbstractCasRealm
extends org.apache.catalina.realm.RealmBase
implements CasRealm

Base Realm implementation for all CAS realms.

Version:

$Revision$

Author:

Marvin S. Addison

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.realm.RealmBase

org.apache.catalina.realm.RealmBase.AllRolesMode

Field Summary

Fields inherited from class org.apache.catalina.realm.RealmBase

allRolesMode, container, containerLog, digest, digestEncoding, info, md, md5Encoder, md5Helper, realmPath, sm, stripRealmForGss, support, validate, x509UsernameRetriever, x509UsernameRetrieverClassName

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

mserver

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
AbstractCasRealm()

Method Summary

Modifier and Type	Method and Description
Principal	authenticate(Principal p) Authenticates the given principal.
protected abstract CasRealm	getDelegate()
String	getInfo()
protected String	getName()
protected String	getPassword(String userName)
protected Principal	getPrincipal(String userName)
String[]	getRoles(Principal p) Gets the roles defined for the given principal.
boolean	hasRole(Principal principal, String role) Determines whether the given principal possesses the given role.
boolean	hasRole(org.apache.catalina.Wrapper wrapper, Principal principal, String role) Tomcat 7.0.8 changed their APIs so hasRole(java.security.Principal, String) is only valid for 7.0.7 and below.
String	toString()

Methods inherited from class org.apache.catalina.realm.RealmBase

addPropertyChangeListener, authenticate, authenticate, authenticate, authenticate, backgroundProcess, compareCredentials, digest, Digest, findSecurityConstraints, getAllRolesMode, getContainer, getDigest, getDigest, getDigestCharset, getDigestEncoding, getDomainInternal, getObjectNameKeyProperties, getPrincipal, getPrincipal, getRealmPath, getRealmSuffix, getServer, getValidate, getX509UsernameRetrieverClassName, hasMessageDigest, hasResourcePermission, hasUserDataPermission, initInternal, isStripRealmForGss, main, removePropertyChangeListener, setAllRolesMode, setContainer, setDigest, setDigestEncoding, setRealmPath, setStripRealmForGss, setValidate, setX509UsernameRetrieverClassName, startInternal, stopInternal

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCasRealm

public AbstractCasRealm()

Method Detail

authenticate

public Principal authenticate(Principal p)

Authenticates the given principal.

Specified by:

authenticate in interface CasRealm

Parameters:

p - Principal to authenticate.

Returns:

New principal.

getRoles

public String[] getRoles(Principal p)

Gets the roles defined for the given principal.

Specified by:

getRoles in interface CasRealm

Parameters:

p - the principal to retrieve the roles for.

Returns:

Roles for given principal or empty array if none exist.

hasRole

public boolean hasRole(Principal principal,
                       String role)

Description copied from interface: CasRealm

Determines whether the given principal possesses the given role.

Specified by:

hasRole in interface CasRealm

Parameters:

principal - Principal to evaluate.

role - Role to test for possession.

Returns:

True if principal has given role, false otherwise.

hasRole

public boolean hasRole(org.apache.catalina.Wrapper wrapper,
                       Principal principal,
                       String role)

Tomcat 7.0.8 changed their APIs so hasRole(java.security.Principal, String) is only valid for 7.0.7 and below.

Specified by:

hasRole in interface org.apache.catalina.Realm

Overrides:

hasRole in class org.apache.catalina.realm.RealmBase

toString

public String toString()

Overrides:

toString in class org.apache.catalina.realm.RealmBase

getInfo

public String getInfo()

Specified by:

getInfo in interface org.apache.catalina.Realm

Overrides:

getInfo in class org.apache.catalina.realm.RealmBase

getName

protected String getName()

Specified by:

getName in class org.apache.catalina.realm.RealmBase

getPassword

protected String getPassword(String userName)

Specified by:

getPassword in class org.apache.catalina.realm.RealmBase

getPrincipal

protected Principal getPrincipal(String userName)

Specified by:

getPrincipal in class org.apache.catalina.realm.RealmBase

getDelegate

protected abstract CasRealm getDelegate()

Returns:

Delegate that all CasRealm operations are delegated to.