Package org.apache.catalina.deploy

Class SecurityCollection

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    SecurityCollectionDecorator
    public class SecurityCollection
extends Object
implements Serializable
    Representation of a web resource collection for a web application's security constraint, as represented in a <web-resource-collection> 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: 1.2 $ $Date: 2005/12/08 01:27:42 $
    Author:
    Craig R. McClanahan
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      SecurityCollection()
      Construct a new security collection instance with default values.
      SecurityCollection​(String name)
      Construct a new security collection instance with specified values.
      SecurityCollection​(String name, String description)
      Construct a new security collection instance with specified values.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addMethod​(String method)
      Add an HTTP request method to be part of this web resource collection.
      void addMethodOmission​(String methodOmission)
      Add an HTTP request method omission to be part of this web resource collection.
      void addPattern​(String pattern)
      Add a URL pattern to be part of this web resource collection.
      boolean findMethod​(String method)
      Return true if the specified HTTP request method is part of this web resource collection.
      boolean findMethodOmission​(String methodOmission)
      Return true if the specified HTTP request method omission is part of this web resource collection.
      String[] findMethodOmissions()
      Return the set of HTTP request method omissions that are part of this web resource collection.
      String[] findMethods()
      Return the set of HTTP request methods that are part of this web resource collection, or a zero-length array if all request methods are included.
      boolean findPattern​(String pattern)
      Is the specified pattern part of this web resource collection?
      String[] findPatterns()
      Return the set of URL patterns that are part of this web resource collection.
      String getDescription()
      Return the description of this web resource collection.
      String getName()
      Return the name of this web resource collection.
      void removeMethod​(String method)
      Remove the specified HTTP request method from those that are part of this web resource collection.
      void removeMethodOmission​(String methodOmission)
      Remove the specified HTTP request method omission from those that are part of this web resource collection.
      void removePattern​(String pattern)
      Remove the specified URL pattern from those that are part of this web resource collection.
      void setDescription​(String description)
      Set the description of this web resource collection.
      void setName​(String name)
      Set the name of this web resource collection
      String toString()
      Return a String representation of this security collection.

    • Constructor Detail

      • SecurityCollection

        public SecurityCollection()
        Construct a new security collection instance with default values.

      • SecurityCollection

        public SecurityCollection​(String name)
        Construct a new security collection instance with specified values.
        Parameters:
        name - Name of this security collection

      • SecurityCollection

        public SecurityCollection​(String name,
                          String description)
        Construct a new security collection instance with specified values.
        Parameters:
        name - Name of this security collection
        description - Description of this security collection

    • Method Detail

      • getDescription

        public String getDescription()
        Return the description of this web resource collection.

      • setDescription

        public void setDescription​(String description)
        Set the description of this web resource collection.
        Parameters:
        description - The new description

      • getName

        public String getName()
        Return the name of this web resource collection.

      • setName

        public void setName​(String name)
        Set the name of this web resource collection
        Parameters:
        name - The new name

      • addMethod

        public void addMethod​(String method)
        Add an HTTP request method to be part of this web resource collection.

      • addMethodOmission

        public void addMethodOmission​(String methodOmission)
        Add an HTTP request method omission to be part of this web resource collection.

      • addPattern

        public void addPattern​(String pattern)
        Add a URL pattern to be part of this web resource collection.

      • findMethod

        public boolean findMethod​(String method)
        Return true if the specified HTTP request method is part of this web resource collection.
        Parameters:
        method - Request method to check

      • findMethods

        public String[] findMethods()
        Return the set of HTTP request methods that are part of this web resource collection, or a zero-length array if all request methods are included.

      • findMethodOmission

        public boolean findMethodOmission​(String methodOmission)
        Return true if the specified HTTP request method omission is part of this web resource collection.
        Parameters:
        method - Request method to check

      • findMethodOmissions

        public String[] findMethodOmissions()
        Return the set of HTTP request method omissions that are part of this web resource collection.

      • findPattern

        public boolean findPattern​(String pattern)
        Is the specified pattern part of this web resource collection?
        Parameters:
        pattern - Pattern to be compared

      • findPatterns

        public String[] findPatterns()
        Return the set of URL patterns that are part of this web resource collection. If none have been specified, a zero-length array is returned.

      • removeMethod

        public void removeMethod​(String method)
        Remove the specified HTTP request method from those that are part of this web resource collection.
        Parameters:
        method - Request method to be removed

      • removeMethodOmission

        public void removeMethodOmission​(String methodOmission)
        Remove the specified HTTP request method omission from those that are part of this web resource collection.
        Parameters:
        method - Request method to be removed

      • removePattern

        public void removePattern​(String pattern)
        Remove the specified URL pattern from those that are part of this web resource collection.
        Parameters:
        pattern - Pattern to be removed

      • toString

        public String toString()
        Return a String representation of this security collection.
        Overrides:
        toString in class Object