Home » apache-tomcat-6.0.26-src » org.apache » catalina » deploy » [javadoc | source]
org.apache.catalina.deploy
public class: SecurityConstraint [javadoc | source]
java.lang.Object
   org.apache.catalina.deploy.SecurityConstraint

All Implemented Interfaces:
    Serializable

Representation of a security constraint element for a web application, as represented in a <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.

Constructor:
 public SecurityConstraint() 
Method from org.apache.catalina.deploy.SecurityConstraint Summary:
addAuthRole,   addCollection,   findAuthRole,   findAuthRoles,   findCollection,   findCollections,   getAllRoles,   getAuthConstraint,   getDisplayName,   getUserConstraint,   included,   removeAuthRole,   removeCollection,   setAuthConstraint,   setDisplayName,   setUserConstraint,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.catalina.deploy.SecurityConstraint Detail:
 public  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.
 public  void addCollection(SecurityCollection collection) 
    Add a new web resource collection to those protected by this security constraint.
 public boolean findAuthRole(String role) 
    Return true if the specified role is permitted access to the resources protected by this security constraint.
 public String[] findAuthRoles() 
    Return the set of roles that are permitted access to the resources protected by this security constraint. If none have been defined, a zero-length array is returned (which implies that all authenticated users are permitted access).
 public SecurityCollection findCollection(String name) 
    Return the web resource collection for the specified name, if any; otherwise, return null.
 public SecurityCollection[] findCollections() 
    Return all of the web resource collections protected by this security constraint. If there are none, a zero-length array is returned.
 public boolean getAllRoles() 
    Was the "all roles" wildcard included in this authentication constraint?
 public boolean getAuthConstraint() 
    Return the authorization constraint present flag for this security constraint.
 public String getDisplayName() 
    Return the display name of this security constraint.
 public String getUserConstraint() 
    Return the user data constraint for this security constraint.
 public boolean included(String uri,
    String method) 
    Return true if the specified context-relative URI (and associated HTTP method) are protected by this security constraint.
 public  void removeAuthRole(String authRole) 
    Remove the specified role from the set of roles permitted to access the resources protected by this security constraint.
 public  void removeCollection(SecurityCollection collection) 
    Remove the specified web resource collection from those protected by this security constraint.
 public  void setAuthConstraint(boolean authConstraint) 
    Set the authorization constraint present flag for this security constraint.
 public  void setDisplayName(String displayName) 
    Set the display name of this security constraint.
 public  void setUserConstraint(String userConstraint) 
    Set the user data constraint for this security constraint.
 public String toString() 
    Return a String representation of this security constraint.