com.sun.enterprise.config.serverbeans

Interface SecurityService

All Superinterfaces:

ConfigBeanProxy, PropertyBag

public interface SecurityService
extends ConfigBeanProxy, PropertyBag

The security service element defines parameters and configuration information needed by the core J2EE security service. Some container-specific security configuration elements are in the various container configuration elements and not here. SSL configuration is also elsewhere. At this time the security service configuration consists of a set of authentication realms. A number of top-level attributes are defined as well

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

ConfigBeanProxy.Duck

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag

PropertyBag.Duck

Method Summary

Modifier and Type	Method and Description
String	getActivateDefaultPrincipalToRoleMapping() Gets the value of the activateDefaultPrincipalToRoleMapping property.
String	getAnonymousRole() Gets the value of the anonymousRole property.
String	getAuditEnabled() Gets the value of the auditEnabled property.
List<AuditModule>	getAuditModule() Gets the value of the auditModule property.
String	getAuditModules() Gets the value of the auditModules property.
List<AuthRealm>	getAuthRealm() Gets the value of the authRealm property.
String	getDefaultPrincipal() Gets the value of the defaultPrincipal property.
String	getDefaultPrincipalPassword() Gets the value of the defaultPrincipalPassword property.
String	getDefaultRealm() Gets the value of the defaultRealm property.
String	getJacc() Gets the value of the jacc property.
List<JaccProvider>	getJaccProvider() Gets the value of the jaccProvider property.
String	getMappedPrincipalClass() Customizes the java.security.Principal implementation class used when activate-default-principal-to-role-mapping is set to true.
List<MessageSecurityConfig>	getMessageSecurityConfig() Gets the value of the messageSecurityConfig property.
List<Property>	getProperty() Properties as per PropertyBag
void	setActivateDefaultPrincipalToRoleMapping(String value) Sets the value of the activateDefaultPrincipalToRoleMapping property.
void	setAnonymousRole(String value) Sets the value of the anonymousRole property.
void	setAuditEnabled(String value) Sets the value of the auditEnabled property.
void	setAuditModules(String value) Sets the value of the auditModules property.
void	setDefaultPrincipal(String value) Sets the value of the defaultPrincipal property.
void	setDefaultPrincipalPassword(String value) Sets the value of the defaultPrincipalPassword property.
void	setDefaultRealm(String value) Sets the value of the defaultRealm property.
void	setJacc(String value) Sets the value of the jacc property.
void	setMappedPrincipalClass(String value) Sets the value of the mappedPrincipalClass 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

getDefaultRealm

String getDefaultRealm()

Gets the value of the defaultRealm property. Specifies which realm (by name) is used by default when no realm is specifically requested. The file realm is the common default

Returns:

possible object is String

setDefaultRealm

void setDefaultRealm(String value)
              throws PropertyVetoException

Sets the value of the defaultRealm property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDefaultPrincipal

String getDefaultPrincipal()

Gets the value of the defaultPrincipal property. Used as the identity of default security contexts when necessary and no principal is provided

Returns:

possible object is String

setDefaultPrincipal

void setDefaultPrincipal(String value)
                  throws PropertyVetoException

Sets the value of the defaultPrincipal property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDefaultPrincipalPassword

String getDefaultPrincipalPassword()

Gets the value of the defaultPrincipalPassword property. Password of default principal

Returns:

possible object is String

setDefaultPrincipalPassword

void setDefaultPrincipalPassword(String value)
                          throws PropertyVetoException

Sets the value of the defaultPrincipalPassword property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAnonymousRole

String getAnonymousRole()

Gets the value of the anonymousRole property. This attribute is deprecated.

Returns:

possible object is String

setAnonymousRole

void setAnonymousRole(String value)
               throws PropertyVetoException

Sets the value of the anonymousRole property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAuditEnabled

String getAuditEnabled()

Gets the value of the auditEnabled property. If true, additional access logging is performed to provide audit information

Returns:

possible object is String

setAuditEnabled

void setAuditEnabled(String value)
              throws PropertyVetoException

Sets the value of the auditEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getJacc

String getJacc()

Gets the value of the jacc property. Specifies the name of the jacc-provider element to use for setting up the JACC infrastructure. The default value "default" does not need to be changed unless adding a custom JACC provider.

Returns:

possible object is String

setJacc

void setJacc(String value)
      throws PropertyVetoException

Sets the value of the jacc property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAuditModules

String getAuditModules()

Gets the value of the auditModules property. Optional list of audit provider modules which will be used by the audit subsystem. Default value refers to the internal log-based audit module

Returns:

possible object is String

setAuditModules

void setAuditModules(String value)
              throws PropertyVetoException

Sets the value of the auditModules property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getActivateDefaultPrincipalToRoleMapping

String getActivateDefaultPrincipalToRoleMapping()

Gets the value of the activateDefaultPrincipalToRoleMapping property. Causes the appserver to apply a default principal to role mapping, to any application that does not have an application specific mapping defined.

Every role is mapped to a same-named (as the role) instance of a java.security.Principal implementation class (see mapped-principal-class) This behavior is similar to that of the Tomcat servlet container.

It is on by default.

Returns:

possible object is String

setActivateDefaultPrincipalToRoleMapping

void setActivateDefaultPrincipalToRoleMapping(String value)
                                       throws PropertyVetoException

Sets the value of the activateDefaultPrincipalToRoleMapping property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getMappedPrincipalClass

String getMappedPrincipalClass()

Customizes the java.security.Principal implementation class used when activate-default-principal-to-role-mapping is set to true. Should the default be set to com.sun.enterprise.deployment.Group? This attribute is used to customize the java.security.Principal implementation class used in the default principal to role mapping. This attribute is optional. When it is not specified, com.sun.enterprise.deployment.Group implementation of java.security.Principal is used. The value of this attribute is only relevant when the activate-default principal-to-role-mapping attribute is set to true

Returns:

possible object is String

setMappedPrincipalClass

void setMappedPrincipalClass(String value)
                      throws PropertyVetoException

Sets the value of the mappedPrincipalClass property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAuthRealm

List<AuthRealm> getAuthRealm()

Gets the value of the authRealm property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the authRealm property.

For example, to add a new item, do as follows:

    getAuthRealm().add(newItem);
 

Objects of the following type(s) are allowed in the list AuthRealm

getJaccProvider

List<JaccProvider> getJaccProvider()

Gets the value of the jaccProvider property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the jaccProvider property.

For example, to add a new item, do as follows:

    getJaccProvider().add(newItem);
 

Objects of the following type(s) are allowed in the list JaccProvider

getAuditModule

List<AuditModule> getAuditModule()

Gets the value of the auditModule property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the auditModule property.

For example, to add a new item, do as follows:

    getAuditModule().add(newItem);
 

Objects of the following type(s) are allowed in the list AuditModule

getMessageSecurityConfig

List<MessageSecurityConfig> getMessageSecurityConfig()

Gets the value of the messageSecurityConfig property. Optional list of layer specific lists of configured message security providers.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the messageSecurityConfig property.

For example, to add a new item, do as follows:

    getMessageSecurityConfig().add(newItem);
 

Objects of the following type(s) are allowed in the list MessageSecurityConfig

getProperty

@ToDo(priority=IMPORTANT,
      details="Provide PropertyDesc for legal props")
 @PropertiesDesc(props={})
List<Property> getProperty()

Properties as per PropertyBag

Specified by:

getProperty in interface PropertyBag

Returns:

the property list