org.eclipse.jst.j2ee.webapplication
Interface LoginConfig

All Superinterfaces:
J2EEEObject

public interface LoginConfig
extends J2EEEObject

The login-config element is used to configure the authentication method that should be used, the realm name that should be used for this application, and the attributes that are needed by the form login mechanism.


Method Summary
 AuthMethodKind getAuthMethod()
           
 java.lang.String getAuthorizationMethod()
          Returns the value of the 'Authorization Method' attribute
 FormLoginConfig getFormLoginConfig()
           
 java.lang.String getRealmName()
           
 WebApp getWebApp()
           
 boolean isSetAuthMethod()
          Returns whether the value of the 'Auth Method' attribute is set
 void setAuthMethod(AuthMethodKind value)
          Sets the value of the 'Auth Method' attribute
 void setAuthorizationMethod(java.lang.String value)
          Sets the value of the 'Authorization Method' attribute
 void setFormLoginConfig(FormLoginConfig value)
           
 void setRealmName(java.lang.String value)
           
 void setWebApp(WebApp value)
           
 void unsetAuthMethod()
          Unsets the value of the 'Auth Method' attribute
 

Method Detail

getAuthMethod

public AuthMethodKind getAuthMethod()
Returns:
The value of the AuthMethod attribute The auth-method element is used to configure the authentication mechanism for the web application. As a prerequisite to gaining access to any web resources which are protected by an authorization constraint, a user must have authenticated using the configured mechanism. Legal values for this element are "BASIC", "DIGEST", "FORM", or "CLIENT-CERT".

setAuthMethod

public void setAuthMethod(AuthMethodKind value)
Sets the value of the 'Auth Method' attribute.

Parameters:
value - the new value of the 'Auth Method' attribute.
See Also:
AuthMethodKind, isSetAuthMethod(), unsetAuthMethod(), getAuthMethod()

unsetAuthMethod

public void unsetAuthMethod()
Unsets the value of the 'Auth Method' attribute.

See Also:
isSetAuthMethod(), getAuthMethod(), setAuthMethod(AuthMethodKind)

isSetAuthMethod

public boolean isSetAuthMethod()
Returns whether the value of the 'Auth Method' attribute is set.

Returns:
whether the value of the 'Auth Method' attribute is set.
See Also:
unsetAuthMethod(), getAuthMethod(), setAuthMethod(AuthMethodKind)

getRealmName

public java.lang.String getRealmName()
Returns:
The value of the RealmName attribute The realm name element specifies the realm name to use in HTTP Basic authorization

setRealmName

public void setRealmName(java.lang.String value)
Parameters:
value - The new value of the RealmName attribute

getAuthorizationMethod

public java.lang.String getAuthorizationMethod()
Returns the value of the 'Authorization Method' attribute.

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

Returns:
the value of the 'Authorization Method' attribute.
See Also:
setAuthorizationMethod(String), WebapplicationPackage.getLoginConfig_AuthorizationMethod()

setAuthorizationMethod

public void setAuthorizationMethod(java.lang.String value)
Sets the value of the 'Authorization Method' attribute.

Parameters:
value - the new value of the 'Authorization Method' attribute.
See Also:
getAuthorizationMethod()

getWebApp

public WebApp getWebApp()
Returns:
The WebApp reference

setWebApp

public void setWebApp(WebApp value)

getFormLoginConfig

public FormLoginConfig getFormLoginConfig()
Returns:
The FormLoginConfig reference

setFormLoginConfig

public void setFormLoginConfig(FormLoginConfig value)