org.exist.http.realm
Class XmldbRealm

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

public class XmldbRealm

extends org.apache.catalina.realm.RealmBase

See Also:

Serialized Form

Nested Class Summary

protected class

XmldbRealm.DefaultXmldbPrinciple

Field Summary

protected java.lang.String	info Descriptive information about this Realm implementation.
protected static java.lang.String	name Descriptive information about this Realm implementation.

Constructor Summary

XmldbRealm()

Method Summary

java.security.Principal	authenticate(java.lang.String username, java.lang.String credentials) Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.
java.lang.String	getBasedir()
java.lang.String	getConfiguration()
java.lang.String	getDriver()
java.lang.String	getInfo() Return descriptive information about this Realm implementation and the corresponding version number, in the format <description>/<version>.
protected java.lang.String	getName() Return a short name for this Realm implementation.
protected java.lang.String	getPassword(java.lang.String username) Return the password associated with the given principal's user name.
protected java.security.Principal	getPrincipal(java.lang.String username) Return the Principal associated with the given user name.
java.lang.String	getUri()
void	setBasedir(java.lang.String basedir)
void	setConfiguration(java.lang.String configuration)
void	setDriver(java.lang.String driver)
void	setUri(java.lang.String uri)
void	start() Prepare for active use of the public methods of this Component.
void	startExistDb()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

info

protected final java.lang.String info

Descriptive information about this Realm implementation.

See Also:

Constant Field Values

name

protected static final java.lang.String name

Descriptive information about this Realm implementation.

See Also:

Constant Field Values

Constructor Detail

XmldbRealm

public XmldbRealm()

Method Detail

getInfo

public java.lang.String getInfo()

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

authenticate

public java.security.Principal authenticate(java.lang.String username,
                                            java.lang.String credentials)

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

Parameters:

username - Username of the Principal to look up

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

getName

protected java.lang.String getName()

Return a short name for this Realm implementation.

getPassword

protected java.lang.String getPassword(java.lang.String username)

Return the password associated with the given principal's user name.

getPrincipal

protected java.security.Principal getPrincipal(java.lang.String username)

Return the Principal associated with the given user name.

start

public void start()
           throws LifecycleException

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

Throws:

LifecycleException - if this component detects a fatal error that prevents it from being started

stop

public void stop()
          throws LifecycleException

Throws:

LifecycleException

startExistDb

public void startExistDb()
                  throws LifecycleException

Throws:

LifecycleException

getBasedir

public java.lang.String getBasedir()

Returns:

Returns the basedir.

setBasedir

public void setBasedir(java.lang.String basedir)

Parameters:

basedir - The basedir to set.

getConfiguration

public java.lang.String getConfiguration()

Returns:

Returns the configuration.

setConfiguration

public void setConfiguration(java.lang.String configuration)

Parameters:

configuration - The configuration to set.

getDriver

public java.lang.String getDriver()

Returns:

Returns the driver.

setDriver

public void setDriver(java.lang.String driver)

Parameters:

driver - The driver to set.

getUri

public java.lang.String getUri()

Returns:

Returns the uri.

setUri

public void setUri(java.lang.String uri)

Parameters:

uri - The uri to set.