FileDocCategorySizeDatePackage
Realm.javaAPI DocApache Tomcat 6.0.147565Fri Jul 20 04:20:32 BST 2007org.apache.catalina

Realm

public interface Realm
A Realm is a read-only facade for an underlying security realm used to authenticate individual users, and identify the security roles associated with those users. Realms can be attached at any Container level, but will typically only be attached to a Context, or higher level, Container.
author
Craig R. McClanahan
version
$Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $

Fields Summary
Constructors Summary
Methods Summary
public voidaddPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener to this component.

param
listener The listener to add

public java.security.Principalauthenticate(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.

param
username Username of the Principal to look up
param
credentials Password or other credentials to use in authenticating this username

public java.security.Principalauthenticate(java.lang.String username, byte[] credentials)
Return the Principal associated with the specified username and credentials, if there is one; otherwise return null.

param
username Username of the Principal to look up
param
credentials Password or other credentials to use in authenticating this username

public java.security.Principalauthenticate(java.lang.String username, java.lang.String digest, java.lang.String nonce, java.lang.String nc, java.lang.String cnonce, java.lang.String qop, java.lang.String realm, java.lang.String md5a2)
Return the Principal associated with the specified username, which matches the digest calculated using the given parameters using the method described in RFC 2069; otherwise return null.

param
username Username of the Principal to look up
param
digest Digest which has been submitted by the client
param
nonce Unique (or supposedly unique) token which has been used for this request
param
realm Realm name
param
md5a2 Second MD5 digest used to calculate the digest : MD5(Method + ":" + uri)

public java.security.Principalauthenticate(java.security.cert.X509Certificate[] certs)
Return the Principal associated with the specified chain of X509 client certificates. If there is none, return null.

param
certs Array of client certificates, with the first one in the array being the certificate of the client itself.

public voidbackgroundProcess()
Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.

public org.apache.catalina.deploy.SecurityConstraint[]findSecurityConstraints(org.apache.catalina.connector.Request request, Context context)
Return the SecurityConstraints configured to guard the request URI for this request, or null if there is no such constraint.

param
request Request we are processing

public ContainergetContainer()
Return the Container with which this Realm has been associated.

public java.lang.StringgetInfo()
Return descriptive information about this Realm implementation and the corresponding version number, in the format <description>/<version>.

public booleanhasResourcePermission(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response, org.apache.catalina.deploy.SecurityConstraint[] constraint, Context context)
Perform access control based on the specified authorization constraint. Return true if this constraint is satisfied and processing should continue, or false otherwise.

param
request Request we are processing
param
response Response we are creating
param
constraint Security constraint we are enforcing
param
context The Context to which client of this class is attached.
exception
IOException if an input/output error occurs

public booleanhasRole(java.security.Principal principal, java.lang.String role)
Return true if the specified Principal has the specified security role, within the context of this Realm; otherwise return false.

param
principal Principal for whom the role is to be checked
param
role Security role to be checked

public booleanhasUserDataPermission(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response, org.apache.catalina.deploy.SecurityConstraint[] constraint)
Enforce any user data constraint required by the security constraint guarding this request URI. Return true if this constraint was not violated and processing should continue, or false if we have created a response already.

param
request Request we are processing
param
response Response we are creating
param
constraint Security constraint being checked
exception
IOException if an input/output error occurs

public voidremovePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener from this component.

param
listener The listener to remove

public voidsetContainer(Container container)
Set the Container with which this Realm has been associated.

param
container The associated Container