org.apache.catalina.deploy
Class SecurityCollection

java.lang.Object
  org.apache.catalina.deploy.SecurityCollection

All Implemented Interfaces:

Serializable

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:

$Id: SecurityCollection.java 987920 2010-08-22 15:34:34Z markt $

Author:

Craig R. McClanahan

See Also:

Serialized Form

Constructor Summary

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

void	addMethod(String method) Add an HTTP request method to be explicitly part of this web resource collection.
void	addOmittedMethod(String method) Add an HTTP request method to the methods explicitly excluded from 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.
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.
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(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.
boolean	isFromDescriptor() Return if this constraint was defined in a deployment descriptor.
void	removeMethod(String method) Remove the specified HTTP request method from those that are part of this web resource collection.
void	removeOmittedMethod(String method) Remove the specified HTTP request method from those that are explicitly excluded from 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	setFromDescriptor(boolean isFromDescriptor) Set if this constraint was defined in a deployment descriptor.
void	setName(String name) Set the name of this web resource collection
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(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

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(String method)

Add an HTTP request method to be explicitly part of this web resource collection.

addOmittedMethod

public void addOmittedMethod(String method)

Add an HTTP request method to the methods explicitly excluded from 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 no methods have been explicitly included.

findOmittedMethods

public 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(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

removeOmittedMethod

public void removeOmittedMethod(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(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