atg.servlet.security

Class FormLoginSession

java.lang.Object

atg.servlet.security.FormLoginSession

public class FormLoginSession
extends java.lang.Object

The FormLoginSession stores information about whether an attempt is being made to log in to a form.

If the desitination property of a FormLoginSession is null then there is no current for login taking place for the session.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
FormLoginSession()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDestination() Returns The destination URI which caused this form login session to take place
java.lang.String	getErrorURI() Returns The URI of the error page to handle errors with the form authorization
java.lang.String	getFormURI() Returns The URI of the login form
LoginUserAuthority	getLoginUserAuthority() Returns The login User Authority to be used when handling this form login
java.lang.String[]	getRoles() Returns The roles that the user must be in for the specified user authority for the form login to have been successful
void	setDestination(java.lang.String pDestination) Sets The destination URI which caused this form login session to take place
void	setErrorURI(java.lang.String pErrorURI) Sets The URI of the error page to handle errors with the form authorization
void	setFormURI(java.lang.String pFormURI) Sets The URI of the login form
void	setLoginUserAuthority(LoginUserAuthority pLoginUserAuthority) Sets The login User Authority to be used when handling this form login
void	setRoles(java.lang.String[] pRoles) Sets The roles that the user must be in for the specified user authority for the form login to have been successful

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

FormLoginSession

public FormLoginSession()

Method Detail

setDestination

public void setDestination(java.lang.String pDestination)

Sets The destination URI which caused this form login session to take place

getDestination

public java.lang.String getDestination()

Returns The destination URI which caused this form login session to take place

setLoginUserAuthority

public void setLoginUserAuthority(LoginUserAuthority pLoginUserAuthority)

Sets The login User Authority to be used when handling this form login

getLoginUserAuthority

public LoginUserAuthority getLoginUserAuthority()

Returns The login User Authority to be used when handling this form login

setFormURI

public void setFormURI(java.lang.String pFormURI)

Sets The URI of the login form

getFormURI

public java.lang.String getFormURI()

Returns The URI of the login form

setErrorURI

public void setErrorURI(java.lang.String pErrorURI)

Sets The URI of the error page to handle errors with the form authorization

getErrorURI

public java.lang.String getErrorURI()

Returns The URI of the error page to handle errors with the form authorization

setRoles

public void setRoles(java.lang.String[] pRoles)

Sets The roles that the user must be in for the specified user authority for the form login to have been successful

getRoles

public java.lang.String[] getRoles()

Returns The roles that the user must be in for the specified user authority for the form login to have been successful