| java.lang.Object
 org.apache.catalina.realm.RealmBase
org.apache.catalina.realm.UserDatabaseRealm
| UserDatabaseRealm | | public class UserDatabaseRealm extends RealmBase (Code) | | Implementation of
Realm that is based on an implementation of
UserDatabase made available through the global JNDI resources
configured for this instance of Catalina. Set the resourceName
parameter to the global JNDI resources name for the configured instance
of UserDatabase that we should consult.
author:
Craig R. McClanahan
version:
$Revision: 1.8 $ $Date: 2002/06/09 02:19:43 $
since:
4.1 |
| Field Summary | |
| protected UserDatabase | database
The UserDatabase we will use to authenticate users
and identify associated roles. | | final protected String | info
Descriptive information about this Realm implementation. | | final protected static String | name
Descriptive information about this Realm implementation. | | protected String | resourceName
The global JNDI name of the UserDatabase resource
we will be utilizing. |
| Method Summary | |
| public Principal | authenticate(String username, String credentials)
Return the Principal associated with the specified username and
credentials, if there is one; otherwise return null. | | public String | getInfo()
Return descriptive information about this Realm implementation and
the corresponding version number, in the format
<description>/<version>. | | protected String | getName()
Return a short name for this Realm implementation. | | protected String | getPassword(String username)
Return the password associated with the given principal's user name. | | protected Principal | getPrincipal(String username)
Return the Principal associated with the given user name. | | public String | getResourceName()
Return the global JNDI name of the UserDatabase resource
we will be using. | | public void | setResourceName(String resourceName)
Set the global JNDI name of the UserDatabase resource
we will be using. | | public synchronized void | start()
Prepare for active use of the public methods of this Component. | | public synchronized void | stop()
Gracefully shut down active use of the public methods of this Component. |
| database | | protected UserDatabase database(Code) | | The UserDatabase we will use to authenticate users
and identify associated roles.
|
| info | | final protected String info(Code) | | Descriptive information about this Realm implementation.
|
| name | | final protected static String name(Code) | | Descriptive information about this Realm implementation.
|
| resourceName | | protected String resourceName(Code) | | The global JNDI name of the UserDatabase resource
we will be utilizing.
|
| authenticate | | public Principal authenticate(String username, String credentials)(Code) | | 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
Parameters:
credentials - Password or other credentials to use inauthenticating this username |
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Realm implementation and
the corresponding version number, in the format
<description>/<version>.
|
| getName | | protected String getName()(Code) | | Return a short name for this Realm implementation.
|
| getPassword | | protected String getPassword(String username)(Code) | | Return the password associated with the given principal's user name.
|
| getPrincipal | | protected Principal getPrincipal(String username)(Code) | | Return the Principal associated with the given user name.
|
| getResourceName | | public String getResourceName()(Code) | | Return the global JNDI name of the UserDatabase resource
we will be using.
|
| setResourceName | | public void setResourceName(String resourceName)(Code) | | Set the global JNDI name of the UserDatabase resource
we will be using.
Parameters:
resourceName - The new global JNDI name |
| start | | public synchronized void start() throws LifecycleException(Code) | | Prepare for active use of the public methods of this Component.
exception:
LifecycleException - if this component detects a fatal errorthat prevents it from being started |
| stop | | public synchronized void stop() throws LifecycleException(Code) | | Gracefully shut down active use of the public methods of this Component.
exception:
LifecycleException - if this component detects a fatal errorthat needs to be reported |
| Methods inherited from org.apache.catalina.realm.RealmBase | final public static String Digest(String credentials, String algorithm)(Code)(Java Doc)
public void addLifecycleListener(LifecycleListener listener)(Code)(Java Doc)
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public Principal authenticate(String username, String credentials)(Code)(Java Doc)
public Principal authenticate(String username, byte[] credentials)(Code)(Java Doc)
public Principal authenticate(String username, String clientDigest, String nOnce, String nc, String cnonce, String qop, String realm, String md5a2)(Code)(Java Doc)
public Principal authenticate(X509Certificate certs)(Code)(Java Doc)
protected String digest(String credentials)(Code)(Java Doc)
public LifecycleListener[] findLifecycleListeners()(Code)(Java Doc)
public Container getContainer()(Code)(Java Doc)
public int getDebug()(Code)(Java Doc)
public String getDigest()(Code)(Java Doc)
protected String getDigest(String username, String realmName)(Code)(Java Doc)
public String getInfo()(Code)(Java Doc)
abstract protected String getName()(Code)(Java Doc)
abstract protected String getPassword(String username)(Code)(Java Doc)
abstract protected Principal getPrincipal(String username)(Code)(Java Doc)
public boolean getValidate()(Code)(Java Doc)
protected boolean hasMessageDigest()(Code)(Java Doc)
public boolean hasRole(Principal principal, String role)(Code)(Java Doc)
protected void log(String message)(Code)(Java Doc)
protected void log(String message, Throwable throwable)(Code)(Java Doc)
public static void main(String args)(Code)(Java Doc)
public void removeLifecycleListener(LifecycleListener listener)(Code)(Java Doc)
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public void setContainer(Container container)(Code)(Java Doc)
public void setDebug(int debug)(Code)(Java Doc)
public void setDigest(String digest)(Code)(Java Doc)
public void setValidate(boolean validate)(Code)(Java Doc)
public void start() throws LifecycleException(Code)(Java Doc)
public void stop() throws LifecycleException(Code)(Java Doc)
|
|
|