Package com.sun.enterprise.config.serverbeans

Interface AuthRealm

All Superinterfaces:

ConfigBeanProxy, PropertyBag

@FileRealmPropertyCheck
@LDAPRealmPropertyCheck
@JDBCRealmPropertyCheck
@SolarisRealmPropertyCheck
public interface AuthRealm
extends ConfigBeanProxy, PropertyBag

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AuthRealm.Duck

Method Summary

Modifier and Type	Method	Description
@NotNull String	getClassname()	Gets the value of the classname property.
String	getGroupMapping()
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") String	getName()	Gets the value of the name property.
List<Property>	getProperty()	Properties.
void	setClassname(String value)	Sets the value of the classname property.
void	setName(String value)	Sets the value of the name property.

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

Method Detail

getName

@NotNull
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*")
@NotNull @Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*") String getName()

Gets the value of the name property. Defines the name of this realm

Returns:

possible object is String

setName

void setName(String value)
      throws PropertyVetoException

Sets the value of the name property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getClassname

@NotNull
@JavaClassName
@NotNull String getClassname()

Gets the value of the classname property. Defines the java class which implements this realm

Returns:

possible object is String

setClassname

void setClassname(String value)
           throws PropertyVetoException

Sets the value of the classname property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getGroupMapping

@DuckTyped
String getGroupMapping()

getProperty

@PropertyDesc(name="jaas-context",description="jaas-contextfile,jdbcSpecifies the JAAS (Java Authentication and Authorization Service) context") @PropertyDesc(name="file",defaultValue="${com.sun.aas.instanceRoot}/config/keyfile",description="file realm. Specifies the file that stores user names, passwords, and group names.") @PropertyDesc(name="assign-groups",description="file, jdbc realms. Comma-separated list of group names.") @PropertyDesc(name="datasource-jndi",description="Specifies name of the jdbc-resource for the database") @PropertyDesc(name="user-table",description="Specifies the name of the user table in the database") @PropertyDesc(name="user-name-column",description="Specifies the name of the user name column in the database user table") @PropertyDesc(name="password-column",description="Specifies the name of the password column in the database user table") @PropertyDesc(name="group-table",description="Specifies the name of the group table in the database") @PropertyDesc(name="group-name-column",description="Specifies the name of the group name column in the database user table") @PropertyDesc(name="db-user",description="The database user name in the realm instead of that in the jdbc-connection-pool. Prevents other applications from looking up the database, getting a connection, and browsing the user table") @PropertyDesc(name="db-password",description="The database password in the realm instead of that in the jdbc-connection-pool. Prevents other applications from looking up the database, getting a connection, and browsing the user table") @PropertyDesc(name="digest-algorithm",defaultValue="MD5",values={"MD5","none","SHA"},description="Any algorithm supported in the JDK") @PropertyDesc(name="encoding",values={"Hex","Base64"},description="Specifies the encoding. If digest-algorithm is specified, the default is Hex, otherwise no encoding is specified") @PropertyDesc(name="charset",description="Specifies the charset for the digest algorithm")
List<Property> getProperty()

Properties.

Specified by:

getProperty in interface PropertyBag

Returns:

the property list