org.jasig.cas.client.tomcat.v7
Class PropertiesCasRealm

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
                  org.jasig.cas.client.tomcat.v7.PropertiesCasRealm

All Implemented Interfaces:

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

public class PropertiesCasRealm
extends AbstractCasRealm

Tomcat Realm that implements CasRealm backed by properties file containing usernames/and roles of the following format:

 username1=role1,role2,role3
 username2=role1
 username3=role2,role3
 

User authentication succeeds if the name of the given principal exists as a username in the properties file.

Since:

3.1.12

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, support, validate

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

PropertiesCasRealm()

Method Summary

protected CasRealm	getDelegate()
void	setPropertiesFilePath(String path)
protected void	startInternal()

Methods inherited from class org.jasig.cas.client.tomcat.v7.AbstractCasRealm

authenticate, getInfo, getName, getPassword, getPrincipal, getRoles, hasRole, hasRole, toString

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

addPropertyChangeListener, authenticate, authenticate, authenticate, backgroundProcess, digest, Digest, findSecurityConstraints, getAllRolesMode, getContainer, getDigest, getDigest, getDigestEncoding, getDomainInternal, getObjectNameKeyProperties, getPrincipal, getRealmPath, getRealmSuffix, getServer, getValidate, hasMessageDigest, hasResourcePermission, hasUserDataPermission, initInternal, main, removePropertyChangeListener, setAllRolesMode, setContainer, setDigest, setDigestEncoding, setRealmPath, setValidate, 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

PropertiesCasRealm

public PropertiesCasRealm()

Method Detail

setPropertiesFilePath

public void setPropertiesFilePath(String path)

Parameters:

path - Path to properties file container username/role data.

startInternal

protected void startInternal()
                      throws org.apache.catalina.LifecycleException

Overrides:

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

Throws:

org.apache.catalina.LifecycleException

getDelegate

protected CasRealm getDelegate()

Specified by:

getDelegate in class AbstractCasRealm

Returns:

Delegate that all CasRealm operations are delegated to.