Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.shrinkwrap.descriptor.api.webcommon30
Interface LoginConfigType<T>

All Superinterfaces:
  org.jboss.shrinkwrap.descriptor.api.Child<T>

All Known Implementing Classes:
  LoginConfigTypeImpl

    public interface LoginConfigType<T>

extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the `login-configType` xsd type

Original Documentation:

The login-configType 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.
Used in: web-app

Since:
  Generation date :2011-07-19T22:55:02.759+02:00
Author:
  Ralf Battenfeld

Method Summary
`FormLoginConfigType<LoginConfigType<T>>` | `formLoginConfig()` If not already created, a new `form-login-config` element will be created and returned.
`java.lang.String` | `getAuthMethod()` Returns the `auth-method` element
`java.lang.String` | `getRealmName()` Returns the `realm-name` element
`LoginConfigType<T>` | `removeAuthMethod()` Removes the `auth-method` element
`LoginConfigType<T>` | `removeFormLoginConfig()` Removes the `form-login-config` element
`LoginConfigType<T>` | `removeRealmName()` Removes the `realm-name` element
`LoginConfigType<T>` | `setAuthMethod(java.lang.String authMethod)` If not already created, a new `auth-method` element with the given value will be created.
`LoginConfigType<T>` | `setRealmName(java.lang.String realmName)` If not already created, a new `realm-name` element with the given value will be created.

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
`up`

Method Detail

### setAuthMethod

    LoginConfigType<T> setAuthMethod(java.lang.String authMethod)

  If not already created, a new `auth-method` element with the given value will be created. Otherwise, the existing `auth-method` element will be updated with the given value.

  Returns:
    the current instance of `LoginConfigType`

### removeAuthMethod

    LoginConfigType<T> removeAuthMethod()

  Removes the `auth-method` element

  Returns:
    the current instance of `LoginConfigType`

### getAuthMethod

    java.lang.String getAuthMethod()

  Returns the `auth-method` element

  Returns:
    the node defined for the element `auth-method`

### setRealmName

    LoginConfigType<T> setRealmName(java.lang.String realmName)

  If not already created, a new `realm-name` element with the given value will be created. Otherwise, the existing `realm-name` element will be updated with the given value.

  Returns:
    the current instance of `LoginConfigType`

### removeRealmName

    LoginConfigType<T> removeRealmName()

  Removes the `realm-name` element

  Returns:
    the current instance of `LoginConfigType`

### getRealmName

    java.lang.String getRealmName()

  Returns the `realm-name` element

  Returns:
    the node defined for the element `realm-name`

### removeFormLoginConfig

    LoginConfigType<T> removeFormLoginConfig()

  Removes the `form-login-config` element

  Returns:
    the current instance of `LoginConfigType`

### formLoginConfig

    FormLoginConfigType<LoginConfigType<T>> formLoginConfig()

  If not already created, a new `form-login-config` element will be created and returned. Otherwise, the existing `form-login-config` element will be returned.

  Returns:
    the node defined for the element `form-login-config`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD