org.exist.http.realm
Class XmldbRealm

java.lang.Object
  org.apache.catalina.realm.RealmBase
      org.exist.http.realm.XmldbRealm

All Implemented Interfaces:

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

public class XmldbRealm
extends org.apache.catalina.realm.RealmBase

Field Summary

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

XmldbRealm()

Method Summary

Principal	authenticate(String username, String credentials) Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.
String	getBasedir()
String	getConfiguration()
String	getDriver()
String	getInfo() Return descriptive information about this Realm implementation and the corresponding version number, in the format <description>/<version>.
String	getUri()
void	setBasedir(String basedir)
void	setConfiguration(String configuration)
void	setDriver(String driver)
void	setUri(String uri)
void	start() Prepare for active use of the public methods of this Component.
void	startExistDb()
void	stop()

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

addLifecycleListener, addPropertyChangeListener, authenticate, authenticate, authenticate, destroy, Digest, findLifecycleListeners, findSecurityConstraints, getContainer, getController, getDebug, getDigest, getDomain, getObjectName, getType, getValidate, hasResourcePermission, hasRole, hasUserDataPermission, init, main, postDeregister, postRegister, preDeregister, preRegister, removeLifecycleListener, removePropertyChangeListener, setContainer, setController, setDebug, setDigest, setValidate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmldbRealm

public XmldbRealm()

Method Detail

getInfo

public String getInfo()

Return descriptive information about this Realm implementation and the corresponding version number, in the format <description>/<version>.

Specified by:

getInfo in interface org.apache.catalina.Realm

Overrides:

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

authenticate

public Principal authenticate(String username,
                              String credentials)

Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.

Specified by:

authenticate in interface org.apache.catalina.Realm

Overrides:

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

Parameters:

username - Username of the Principal to look up

credentials - Password or other credentials to use in authenticating this username

start

public void start()
           throws org.apache.catalina.LifecycleException

Prepare for active use of the public methods of this Component.

Specified by:

start in interface org.apache.catalina.Lifecycle

Overrides:

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

Throws:

org.apache.catalina.LifecycleException - if this component detects a fatal error that prevents it from being started

stop

public void stop()
          throws org.apache.catalina.LifecycleException

Specified by:

stop in interface org.apache.catalina.Lifecycle

Overrides:

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

Throws:

org.apache.catalina.LifecycleException

startExistDb

public void startExistDb()
                  throws org.apache.catalina.LifecycleException

Throws:

org.apache.catalina.LifecycleException

getBasedir

public String getBasedir()

Returns:

Returns the basedir.

setBasedir

public void setBasedir(String basedir)

Parameters:

basedir - The basedir to set.

getConfiguration

public String getConfiguration()

Returns:

Returns the configuration.

setConfiguration

public void setConfiguration(String configuration)

Parameters:

configuration - The configuration to set.

getDriver

public String getDriver()

Returns:

Returns the driver.

setDriver

public void setDriver(String driver)

Parameters:

driver - The driver to set.

getUri

public String getUri()

Returns:

Returns the uri.

setUri

public void setUri(String uri)

Parameters:

uri - The uri to set.