| org.apache.catalina.Realm
All known Subclasses: org.apache.catalina.realm.RealmBase, org.apache.catalina.realm.JAASMemoryLoginModule,
| Realm | | public interface Realm (Code) | | 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) $ |
| Method Summary | |
| public void | addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component. | | 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 Principal | authenticate(String username, byte[] credentials)
Return the Principal associated with the specified username and
credentials, if there is one; otherwise return null. | | public Principal | authenticate(String username, String digest, String nonce, String nc, String cnonce, String qop, String realm, 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. | | public Principal | authenticate(X509Certificate certs)
Return the Principal associated with the specified chain of X509
client certificates. | | public void | backgroundProcess()
Execute a periodic task, such as reloading, etc. | | public SecurityConstraint[] | findSecurityConstraints(Request request, Context context)
Return the SecurityConstraints configured to guard the request URI for
this request, or null if there is no such constraint. | | public Container | getContainer()
Return the Container with which this Realm has been associated. | | public String | getInfo()
Return descriptive information about this Realm implementation and
the corresponding version number, in the format
<description>/<version>. | | public boolean | hasResourcePermission(Request request, Response response, SecurityConstraint[] constraint, Context context)
Perform access control based on the specified authorization constraint. | | public boolean | hasRole(Principal principal, String role)
Return true if the specified Principal has the specified
security role, within the context of this Realm; otherwise return
false. | | public boolean | hasUserDataPermission(Request request, Response response, SecurityConstraint[] constraint)
Enforce any user data constraint required by the security constraint
guarding this request URI. | | public void | removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component. | | public void | setContainer(Container container)
Set the Container with which this Realm has been associated. |
| addPropertyChangeListener | | public void addPropertyChangeListener(PropertyChangeListener listener)(Code) | | Add a property change listener to this component.
Parameters:
listener - The listener to add |
| 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 |
| authenticate | | public Principal authenticate(String username, byte[] 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 |
| authenticate | | public Principal authenticate(String username, String digest, String nonce, String nc, String cnonce, String qop, String realm, String md5a2)(Code) | | 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.
Parameters:
username - Username of the Principal to look up
Parameters:
digest - Digest which has been submitted by the client
Parameters:
nonce - Unique (or supposedly unique) token which has been usedfor this request
Parameters:
realm - Realm name
Parameters:
md5a2 - Second MD5 digest used to calculate the digest :MD5(Method + ":" + uri) |
| authenticate | | public Principal authenticate(X509Certificate certs)(Code) | | Return the Principal associated with the specified chain of X509
client certificates. If there is none, return null.
Parameters:
certs - Array of client certificates, with the first one inthe array being the certificate of the client itself. |
| backgroundProcess | | public void backgroundProcess()(Code) | | 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.
|
| findSecurityConstraints | | public SecurityConstraint[] findSecurityConstraints(Request request, Context context)(Code) | | Return the SecurityConstraints configured to guard the request URI for
this request, or null if there is no such constraint.
Parameters:
request - Request we are processing |
| getContainer | | public Container getContainer()(Code) | | Return the Container with which this Realm has been associated.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Realm implementation and
the corresponding version number, in the format
<description>/<version>.
|
| hasResourcePermission | | public boolean hasResourcePermission(Request request, Response response, SecurityConstraint[] constraint, Context context) throws IOException(Code) | | Perform access control based on the specified authorization constraint.
Return true if this constraint is satisfied and processing
should continue, or false otherwise.
Parameters:
request - Request we are processing
Parameters:
response - Response we are creating
Parameters:
constraint - Security constraint we are enforcing
Parameters:
context - The Context to which client of this class is attached.
exception:
IOException - if an input/output error occurs |
| hasRole | | public boolean hasRole(Principal principal, String role)(Code) | | Return true if the specified Principal has the specified
security role, within the context of this Realm; otherwise return
false.
Parameters:
principal - Principal for whom the role is to be checked
Parameters:
role - Security role to be checked |
| hasUserDataPermission | | public boolean hasUserDataPermission(Request request, Response response, SecurityConstraint[] constraint) throws IOException(Code) | | 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.
Parameters:
request - Request we are processing
Parameters:
response - Response we are creating
Parameters:
constraint - Security constraint being checked
exception:
IOException - if an input/output error occurs |
| removePropertyChangeListener | | public void removePropertyChangeListener(PropertyChangeListener listener)(Code) | | Remove a property change listener from this component.
Parameters:
listener - The listener to remove |
| setContainer | | public void setContainer(Container container)(Code) | | Set the Container with which this Realm has been associated.
Parameters:
container - The associated Container |
|
|