org.eclipse.modisco.jee.webapp.webapp25
Interface FormLoginConfigType


public interface FormLoginConfigType

A representation of the model object 'Form Login Config Type'. The form-login-configType specifies the login and error pages that should be used in form based login. If form based authentication is not used, these elements are ignored. Used in: login-config

The following features are supported:

See Also:
Webapp25Package.getFormLoginConfigType()
Generated:
Model:
extendedMetaData="name='form-login-configType' kind='elementOnly'"

Method Summary
 WarPathType getFormErrorPage()
          Returns the value of the 'Form Error Page' containment reference.
 WarPathType getFormLoginPage()
          Returns the value of the 'Form Login Page' containment reference.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 void setFormErrorPage(WarPathType value)
          Sets the value of the 'Form Error Page' containment reference.
 void setFormLoginPage(WarPathType value)
          Sets the value of the 'Form Login Page' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 

Method Detail

getFormLoginPage

WarPathType getFormLoginPage()
Returns the value of the 'Form Login Page' containment reference. The form-login-page element defines the location in the web app where the page that can be used for login can be found. The path begins with a leading / and is interpreted relative to the root of the WAR.

Returns:
the value of the 'Form Login Page' containment reference.
See Also:
setFormLoginPage(WarPathType), Webapp25Package.getFormLoginConfigType_FormLoginPage()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='form-login-page' namespace='http://java.sun.com/xml/ns/javaee'"

setFormLoginPage

void setFormLoginPage(WarPathType value)
Sets the value of the 'Form Login Page' containment reference.

Parameters:
value - the new value of the 'Form Login Page' containment reference.
See Also:
getFormLoginPage()
Generated:

getFormErrorPage

WarPathType getFormErrorPage()
Returns the value of the 'Form Error Page' containment reference. The form-error-page element defines the location in the web app where the error page that is displayed when login is not successful can be found. The path begins with a leading / and is interpreted relative to the root of the WAR.

Returns:
the value of the 'Form Error Page' containment reference.
See Also:
setFormErrorPage(WarPathType), Webapp25Package.getFormLoginConfigType_FormErrorPage()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='form-error-page' namespace='http://java.sun.com/xml/ns/javaee'"

setFormErrorPage

void setFormErrorPage(WarPathType value)
Sets the value of the 'Form Error Page' containment reference.

Parameters:
value - the new value of the 'Form Error Page' containment reference.
See Also:
getFormErrorPage()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), Webapp25Package.getFormLoginConfigType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: