SecurityCollection (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.tomcat.util.descriptor.web.SecurityCollection

All Implemented Interfaces:

java.io.Serializable
```
public class SecurityCollection
extends java.lang.Object
implements java.io.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.

Author:

Craig R. McClanahan

See Also:
Serialized Form

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMethod(java.lang.String method)` Add an HTTP request method to be explicitly part of this web resource collection.
`void`	`addOmittedMethod(java.lang.String method)` Add an HTTP request method to the methods explicitly excluded from this web resource collection.
`void`	`addPattern(java.lang.String pattern)` Add a URL pattern to be part of this web resource collection.
`void`	`addPatternDecoded(java.lang.String pattern)`
`boolean`	`findMethod(java.lang.String method)` Return `true` if the specified HTTP request method is part of this web resource collection.
`java.lang.String[]`	`findMethods()` Return the set of HTTP request methods that are part of this web resource collection, or a zero-length array if no methods have been explicitly included.
`java.lang.String[]`	`findOmittedMethods()` Return the set of HTTP request methods that are explicitly excluded from this web resource collection, or a zero-length array if no request methods are excluded.
`boolean`	`findPattern(java.lang.String pattern)` Is the specified pattern part of this web resource collection?
`java.lang.String[]`	`findPatterns()` Return the set of URL patterns that are part of this web resource collection.
`java.lang.String`	`getDescription()` Return the description of this web resource collection.
`java.lang.String`	`getEncoding()` Obtain the encoding of the XML source that was used to populated this object.
`java.lang.String`	`getName()` Return the name of this web resource collection.
`boolean`	`isFromDescriptor()` Return if this constraint was defined in a deployment descriptor.
`void`	`removeMethod(java.lang.String method)` Remove the specified HTTP request method from those that are part of this web resource collection.
`void`	`removeOmittedMethod(java.lang.String method)` Remove the specified HTTP request method from those that are explicitly excluded from this web resource collection.
`void`	`removePattern(java.lang.String pattern)` Remove the specified URL pattern from those that are part of this web resource collection.
`void`	`setDescription(java.lang.String description)` Set the description of this web resource collection.
`void`	`setEncoding(java.lang.String encoding)`
`void`	`setFromDescriptor(boolean isFromDescriptor)` Set if this constraint was defined in a deployment descriptor.
`void`	`setName(java.lang.String name)` Set the name of this web resource collection
`java.lang.String`	`toString()` Return a String representation of this security collection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SecurityCollection
```
public SecurityCollection()
```
    Construct a new security collection instance with default values.
  - SecurityCollection
```
public SecurityCollection(java.lang.String name,
                  java.lang.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
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
  - getEncoding
```
public java.lang.String getEncoding()
```
    Obtain the encoding of the XML source that was used to populated this object.
    
    Returns:
    The encoding of the associated XML source or UTF-8 if the encoding could not be determined
  - getDescription
```
public java.lang.String getDescription()
```
    Return the description of this web resource collection.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Set the description of this web resource collection.
    
    Parameters:
    description - The new description
  - getName
```
public java.lang.String getName()
```
    Return the name of this web resource collection.
  - setName
```
public void setName(java.lang.String name)
```
    Set the name of this web resource collection
    
    Parameters:
    name - The new name
  - isFromDescriptor
```
public boolean isFromDescriptor()
```
    Return if this constraint was defined in a deployment descriptor.
  - setFromDescriptor
```
public void setFromDescriptor(boolean isFromDescriptor)
```
    Set if this constraint was defined in a deployment descriptor.
  - addMethod
```
public void addMethod(java.lang.String method)
```
    Add an HTTP request method to be explicitly part of this web resource collection.
  - addOmittedMethod
```
public void addOmittedMethod(java.lang.String method)
```
    Add an HTTP request method to the methods explicitly excluded from this web resource collection.
  - addPattern
```
public void addPattern(java.lang.String pattern)
```
    Add a URL pattern to be part of this web resource collection.
  - addPatternDecoded
```
public void addPatternDecoded(java.lang.String pattern)
```
  - findMethod
```
public boolean findMethod(java.lang.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 java.lang.String[] findMethods()
```
    Return the set of HTTP request methods that are part of this web resource collection, or a zero-length array if no methods have been explicitly included.
  - findOmittedMethods
```
public java.lang.String[] findOmittedMethods()
```
    Return the set of HTTP request methods that are explicitly excluded from this web resource collection, or a zero-length array if no request methods are excluded.
  - findPattern
```
public boolean findPattern(java.lang.String pattern)
```
    Is the specified pattern part of this web resource collection?
    
    Parameters:
    pattern - Pattern to be compared
  - findPatterns
```
public java.lang.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(java.lang.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
  - removeOmittedMethod
```
public void removeOmittedMethod(java.lang.String method)
```
    Remove the specified HTTP request method from those that are explicitly excluded from this web resource collection.
    
    Parameters:
    method - Request method to be removed
  - removePattern
```
public void removePattern(java.lang.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 java.lang.String toString()
```
    Return a String representation of this security collection.
    
    Overrides:
    
    toString in class java.lang.Object

Class SecurityCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SecurityCollection

SecurityCollection

Method Detail

setEncoding

getEncoding

getDescription

setDescription

getName

setName

isFromDescriptor

setFromDescriptor

addMethod

addOmittedMethod

addPattern

addPatternDecoded

findMethod

findMethods

findOmittedMethods

findPattern

findPatterns

removeMethod

removeOmittedMethod

removePattern

toString