Brian Moseley > Wombat > Wombat::Deploy::SecurityConstraint

Download:
Wombat-0.7.1.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Wombat::Deploy::SecurityConstraint - security-constraint deployment descriptor element class

SYNOPSIS ^

DESCRIPTION ^

Representation of a security constraint object for a web application, as specified in a security-constraint element in the deployment descriptor.

CONSTRUCTOR ^

new()

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

ACCESSOR METHODS ^

getAllRoles()

Return a flag indicating if the "all roles" wildcard is included in this SecurityConstraint.

getAuthConstraint()

Return a flag indication if an authorization constraint is included in this SecurityConstraint. This is necessary to distinguish between an auth-constraint with no roles (signifying no direct access at all) and the lack of auth-constraint (which implies no access control checking).

setAuthConstraint($flag)

Set a flag indicating if an authorization constraint is included in this SecurityConstraint.

Parameters:

$flag

a boolean value

getDisplayName()

Return the display name of this SecurityConstraint.

setDisplayName($displayName)

Set the display name of this SecurityCosntraint.

Parameters:

$displayName

the display name

getUserConstraint()

Return the user data constraint for this SecurityConstraint.

setUserConstraint($userConstraint)

Set the user data constraint for this SecurityConstraint. Must be one of NONE, INTEGRAL or CONFIDENTIAL.

Parameters:

$userConstraint

the user data constraint

PUBLIC METHODS ^

addAuthRole($authRole)

Add an authorization role, which is a role name that will be permitted access to the resources protected by this SecurityConstraint.

Parameters:

$authRole

the role name to be added

hasAuthRole($role)

Return true if the specified role is permitted access to the resources protected by this SecurityConstraint.

Parameters:

$role

the role name to be checked

getAuthRoles()

Return an array containing the names of the roles that are permitted access to the resources protected by this SecurityConstraint.

removeAuthRole($role)

Remove the specified role from the set of roles permitted to access the resources protected by this SecurityConstraint.

Parameters:

$role

the name of the role to be removed

addCollection($collection)

Add a new web resource collection to those protected by this SecurityConstraint.

Parameters:

$collection

the Wombat::Deploy::SecurityConstraint to be added

getCollection($name)

Return the named web resource collection or undef.

Parameters:

$name

the name of the web resource collection

getCollections()

Return an array containing the web resource collections protected by this SecurityConstraint.

removeCollection($collection)

Remove the specified web resource collection from those protected by this SecurityConstraint.

Parameters:

$collection

the Wombat::Deploy::SecurityCollection to be removed

included($uri, $method)

Return true if the specified context-relative URI and associated HTTP method are protected by this SecurityConstraint.

Parameters:

$uri

the uri to check

$method

the method being used

SEE ALSO ^

Wombat::Deploy::SecurityCollection

AUTHOR ^

Brian Moseley, bcm@maz.org

syntax highlighting: