Brian Moseley > Wombat > Wombat::Deploy::LoginConfig

Download:
Wombat-0.7.1.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Wombat::Deploy::LoginConfig - login-config deployment descriptor element class

SYNOPSIS ^

DESCRIPTION ^

Representation of a login configuration object for a web application, as specified in a login-config element in the deployment descriptor.

CONSTRUCTOR ^

new()

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

Parameters:

$authMethod

the authentication method

$realmName

the realm name

$loginPage

the URI of the login page

$errorPage

the URI of the error page

ACCESSOR METHODS ^

getAuthMethod()

Return the authentication method to use for application login.

setAuthMethod($authMethod)

Set the authentication method to use for application login. Must be one of BASIC, DIGEST, FORM, or CLIENT-CERT.

Parameters:

$authMethod

the authentication method

getErrorPage()

Return the URI of the error page for form login.

setErrorPage($errorPage)

Set the URI of the error page for form login. The URI must be specified relative to the context (ie beginning with a '/').

Parameters:

$errorPage

the error page URI

getLoginPage()

Return the URI of the login page for form login.

setLoginPage($loginPage)

Set the URI of the login page for form login. The URI must be specified relative to the context (ie beginning with a '/').

Parameters:

$loginPage

the login page URI

getRealmName()

Return the name of the realm in which users will be authenticated.

setRealmName($realmName)

Set the name of the realm in which users will be authenticated.

Parameters:

$realmName

the name of the realm

AUTHOR ^

Brian Moseley, bcm@maz.org

syntax highlighting: