3.3.5 /client-container/auth-realm

/client-container/auth-realm specifies the optional configuration for a JAAS authentication realm.

Description

/client-container/auth-realm specifies the optional configuration for a JAAS authentication realm. JAAS is available on the ACC.

The authentication realms require provider-specific properties, which vary depending on the requirement of a particular implementation.

Dependencies of elements and attributes

The auth-realm element usage depends on the value of the name attribute of the auth-realm element.

Repetition pattern

0 or 1 time

Specifiable attributes

Attribute name	Description	Specifiable values	Default value^#	Dependencies	Repetition pattern
`name`	Defines the name of this realm. The following realms are supported: `file` Stores user information in a file. This is the default realm when you first install the Application Server. `ldap` Stores user information in an LDAP directory. `jdbc` Stores user information in a database. In the JDBC realm, the server gets user credentials from a database. The Java EE Server uses the database information and the enabled JDBC realm option in the configuration file. For digest authentication, a JDBC realm must be created with `jdbcDigestRealm` as the JAAS context. `certificate` Sets up the user identity in the Java EE Server security context, and populates it with user data obtained from cryptographically verified client certificates.	Type: `String` `{file \| ldap \| jdbc \| certificate}`	No default value	N/A	Only one time
`classname`	Defines the Java class which implements this realm.	Type: `String` `{com.sun.enterprise.security.auth.realm.file.FileRealm \| com.sun.enterprise.security.auth.realm.certificate.CertificateRealm \| com.sun.enterprise.security.auth.realm.jdbc.JDBCRealm \| com.sun.enterprise.security.auth.realm.ldap.LDAPRealm \| com.sun.enterprise.security.auth.realm.ldap.PamRealm \| Any custom realm.}`	No default value	N/A	Only one time

Attribute name

Description

Specifiable values

Default value^#

Dependencies

Repetition pattern

name

Defines the name of this realm.

The following realms are supported:

file

Stores user information in a file. This is the default realm when you first install the Application Server.
ldap

Stores user information in an LDAP directory.
jdbc

Stores user information in a database.

In the JDBC realm, the server gets user credentials from a database. The Java EE Server uses the database information and the enabled JDBC realm option in the configuration file. For digest authentication, a JDBC realm must be created with jdbcDigestRealm as the JAAS context.
certificate

Sets up the user identity in the Java EE Server security context, and populates it with user data obtained from cryptographically verified client certificates.

Type: String

{file | ldap | jdbc | certificate}

No default value

N/A

Only one time

classname

Defines the Java class which implements this realm.

Type: String

{com.sun.enterprise.security.auth.realm.file.FileRealm | com.sun.enterprise.security.auth.realm.certificate.CertificateRealm | com.sun.enterprise.security.auth.realm.jdbc.JDBCRealm | com.sun.enterprise.security.auth.realm.ldap.LDAPRealm | com.sun.enterprise.security.auth.realm.ldap.PamRealm | Any custom realm.}

No default value

N/A

Only one time

Legend:

N/A: Not applicable

#: This is the default value that is set when a definition item is excluded.

To Page Top