Brian Moseley > Wombat > Wombat::Deploy::SecurityCollection

Download:
Wombat-0.7.1.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Wombat::Deploy::SecurityCollection - web-resource-collection deployment descriptor element class

SYNOPSIS ^

DESCRIPTION ^

Representation of a web resource collection for a web application's security constraint, as specified in a web-resource-collection element in the deployment descriptor.

CONSTRUCTOR ^

new()

Construct and return a Wombat::Deploy::SecurityConstraint instance, initializing fields appropriately.

Parameters:

$name

the name of this SecurityCollection (optional)

$description

a description of this SecurityCollection (optional)

ACCESSOR METHODS ^

getDescription()

Return the description of this web resource collection.

setDescription($description)

Set the description of this web resource collection.

Parameters:

$description

the description to set

getName()

Get the name of this web resource collection.

setName($name)

Set the name of this web resource collection.

Parameters:

$name

the name to set

PUBLIC METHODS ^

addMethod($method)

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

Parameters:

$method

the method to add

hasMethod($method)

Return true if the specified HTTP request methodd is part of this web resource collection.

Parameters:

$method

the method to be checked

getMethods()

Return an array containing the names of the HTTP methods that are part of this web resource collection.

removeMethod($method)

Remove the specified HTTP request method from those that are part of this web resource collection.

Parameters:

$method

the name of the method to be removed

addPattern($pattern)

Add a URL pattern to be part of this web resource collection.

Parameters:

$pattern

the pattern to be added

hasPattern($pattern)

Return true if the specified pattern is aprt of this web resource collection.

Parameters:

$pattern

the pattern to be checked

getPatterns()

Return an array containing the URL patterns that are part of this web resource collection.

removePattern($pattern)

Remove the specified URL pattern from those that are part of this web resource collection.

Parameters:

$pattern

the pattern to be removed

AUTHOR ^

Brian Moseley, bcm@maz.org

syntax highlighting: