org.apache.catalina.deploy
public class SecurityConstraint extends Object implements Serializable
<security-constraint>
element in the
deployment descriptor.
WARNING: It is assumed that instances of this class will be created and modified only within the context of a single thread, before the instance is made visible to the remainder of the application. After that, only read access is expected. Therefore, none of the read and write access within this class is synchronized.
Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $
Constructor Summary | |
---|---|
SecurityConstraint()
Construct a new security constraint instance with default values. |
Method Summary | |
---|---|
void | addAuthRole(String authRole)
Add an authorization role, which is a role name that will be
permitted access to the resources protected by this security constraint.
|
void | addCollection(SecurityCollection collection)
Add a new web resource collection to those protected by this
security constraint.
|
boolean | findAuthRole(String role)
Return true if the specified role is permitted access to
the resources protected by this security constraint.
|
String[] | findAuthRoles()
Return the set of roles that are permitted access to the resources
protected by this security constraint. |
SecurityCollection | findCollection(String name)
Return the web resource collection for the specified name, if any;
otherwise, return null .
|
SecurityCollection[] | findCollections()
Return all of the web resource collections protected by this
security constraint. |
boolean | getAllRoles()
Was the "all roles" wildcard included in this authentication
constraint? |
boolean | getAuthConstraint()
Return the authorization constraint present flag for this security
constraint. |
String | getDisplayName()
Return the display name of this security constraint. |
String | getUserConstraint()
Return the user data constraint for this security constraint. |
boolean | included(String uri, String method)
Return true if the specified context-relative URI (and
associated HTTP method) are protected by this security constraint.
|
void | removeAuthRole(String authRole)
Remove the specified role from the set of roles permitted to access
the resources protected by this security constraint.
|
void | removeCollection(SecurityCollection collection)
Remove the specified web resource collection from those protected by
this security constraint.
|
void | setAuthConstraint(boolean authConstraint)
Set the authorization constraint present flag for this security
constraint. |
void | setDisplayName(String displayName)
Set the display name of this security constraint. |
void | setUserConstraint(String userConstraint)
Set the user data constraint for this security constraint.
|
String | toString()
Return a String representation of this security constraint. |
Parameters: authRole Role name to be added
Parameters: collection The new web resource collection
true
if the specified role is permitted access to
the resources protected by this security constraint.
Parameters: role Role name to be checked
null
.
Parameters: name Web resource collection name to return
true
if the specified context-relative URI (and
associated HTTP method) are protected by this security constraint.
Parameters: uri Context-relative URI to check method Request method being used
Parameters: authRole Role name to be removed
Parameters: collection Web resource collection to be removed
Parameters: userConstraint The new user data constraint