com.sun.appserv.management.config
Interface SecurityServiceConfig

All Superinterfaces:

AMX, AMXConfig, AMXMBeanLogging, ConfigElement, Container, NotificationBroadcaster, NotificationEmitter, PropertiesAccess

public interface SecurityServiceConfig
extends PropertiesAccess, ConfigElement, Container

Configuration for the <security-service> element.

Field Summary

static String

J2EE_TYPE The j2eeType as returned by AMX.getJ2EEType().

Fields inherited from interface com.sun.appserv.management.config.PropertiesAccess

PROPERTY_PREFIX

Fields inherited from interface com.sun.appserv.management.config.AMXConfig

CONFIG_CREATED_NOTIFICATION_TYPE, CONFIG_OBJECT_NAME_KEY, CONFIG_REMOVED_NOTIFICATION_TYPE

Fields inherited from interface com.sun.appserv.management.base.AMX

FULL_TYPE_DELIM, GROUP_CONFIGURATION, GROUP_JSR77, GROUP_MONITORING, GROUP_OTHER, GROUP_UTILITY, J2EE_TYPE_KEY, JMX_DOMAIN, NAME_KEY, NO_NAME, NOTIFICATION_PREFIX, NULL_NAME

Fields inherited from interface com.sun.appserv.management.base.Container

ATTR_CONTAINEE_J2EE_TYPES

Method Summary

AuditModuleConfig	createAuditModuleConfig(String name, String className, boolean auditOn, Map<String,String> reservedForFutureUse) Create a new <audit-module>
AuthRealmConfig	createAuthRealmConfig(String name, String classname, Map<String,String> optional) Create a new AuthRealmConfig.
JACCProviderConfig	createJACCProviderConfig(String name, String policyProvider, String policyConfigurationFactoryProvider, Map reservedForFutureUse) Create a new <jacc-provider>
MessageSecurityConfig	createMessageSecurityConfig(String authLayer, Map<String,String> reserved) Create a new <message-security-config>
boolean	getActivateDefaultPrincipalToRoleMapping() Causes the appserver to apply a default principal to role mapping, to any application that does not have an application specific mapping defined.
String	getAnonymousRole()
boolean	getAuditEnabled()
Map<String,AuditModuleConfig>	getAuditModuleConfigMap() Calls Container.getContaineeMap( XTypes.AUDIT_MODULE_CONFIG ).
String	getAuditModules()
Map<String,AuthRealmConfig>	getAuthRealmConfigMap() Calls Container.getContaineeMap( XTypes.AUTH_REALM_CONFIG ).
String	getDefaultPrincipal()
String	getDefaultPrincipalPassword()
String	getDefaultRealm()
String	getJACC()
Map<String,JACCProviderConfig>	getJACCProviderConfigMap() Calls Container.getContaineeMap( XTypes.JACC_PROVIDER_CONFIG ).
String	getMappedPrincipalClass() This attribute is used to customize the java.security.Principal implementation class used in the default principal to role mapping.
Map<String,MessageSecurityConfig>	getMessageSecurityConfigMap() Calls Container.getContaineeMap( XTypes.MESSAGE_SECURITY_CONFIG ).
void	removeAuditModuleConfig(String name) Removes an <audit-module> element.
void	removeAuthRealmConfig(String name) Removes an auth-realm element.
void	removeJACCProviderConfig(String name) Removes a jacc-provider element.
void	removeMessageSecurityConfig(String authLayer) Removes message-security-config element.
void	setActivateDefaultPrincipalToRoleMapping(boolean enabled)
void	setAnonymousRole(String value)
void	setAuditEnabled(boolean value)
void	setAuditModules(String value)
void	setDefaultPrincipal(String value)
void	setDefaultPrincipalPassword(String value)
void	setDefaultRealm(String value)
void	setJACC(String value)
void	setMappedPrincipalClass(String theClass)

Methods inherited from interface com.sun.appserv.management.config.PropertiesAccess

createProperty, existsProperty, getProperties, getPropertyNames, getPropertyValue, removeProperty, setPropertyValue

Methods inherited from interface com.sun.appserv.management.base.AMX

getContainer, getDomainRoot, getFullType, getGroup, getJ2EEType, getName, isDAS

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface com.sun.appserv.management.base.AMXMBeanLogging

getMBeanLoggerName, getMBeanLogLevel, setMBeanLogLevel

Methods inherited from interface com.sun.appserv.management.base.Container

getByNameContaineeSet, getContainee, getContainee, getContaineeJ2EETypes, getContaineeMap, getContaineeSet, getContaineeSet, getContaineeSet, getMultiContaineeMap

Field Detail

J2EE_TYPE

static final String J2EE_TYPE

The j2eeType as returned by AMX.getJ2EEType().

See Also:

Constant Field Values

Method Detail

getAnonymousRole

String getAnonymousRole()

setAnonymousRole

void setAnonymousRole(String value)

getAuditEnabled

boolean getAuditEnabled()

setAuditEnabled

void setAuditEnabled(boolean value)

getAuditModules

String getAuditModules()

setAuditModules

void setAuditModules(String value)

getDefaultPrincipalPassword

String getDefaultPrincipalPassword()

setDefaultPrincipalPassword

void setDefaultPrincipalPassword(String value)

getDefaultPrincipal

String getDefaultPrincipal()

setDefaultPrincipal

void setDefaultPrincipal(String value)

getDefaultRealm

String getDefaultRealm()

setDefaultRealm

void setDefaultRealm(String value)

getJACC

String getJACC()

setJACC

void setJACC(String value)

getMappedPrincipalClass

String getMappedPrincipalClass()

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.

Since:

AppServer 9.0

setMappedPrincipalClass

void setMappedPrincipalClass(String theClass)

Since:

AppServer 9.0

See Also:

getMappedPrincipalClass()

getActivateDefaultPrincipalToRoleMapping

boolean getActivateDefaultPrincipalToRoleMapping()

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 Tomcat servlet container. It is off by default.

Since:

AppServer 9.0

setActivateDefaultPrincipalToRoleMapping

void setActivateDefaultPrincipalToRoleMapping(boolean enabled)

Since:

AppServer 9.0

See Also:

getActivateDefaultPrincipalToRoleMapping()

getJACCProviderConfigMap

Map<String,JACCProviderConfig> getJACCProviderConfigMap()

Calls Container.getContaineeMap( XTypes.JACC_PROVIDER_CONFIG ).

Returns:

Map of JACCProviderConfig MBean proxies , keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createJACCProviderConfig

JACCProviderConfig createJACCProviderConfig(String name,
                                            String policyProvider,
                                            String policyConfigurationFactoryProvider,
                                            Map reservedForFutureUse)

Create a new <jacc-provider>

Parameters:

name - name of the <jacc-provider>

policyProvider - a classname

policyConfigurationFactoryProvider - a classname

reservedForFutureUse - reserved for future use

Returns:

A proxy to the JACCProviderConfig MBean.

removeJACCProviderConfig

void removeJACCProviderConfig(String name)

Removes a jacc-provider element.

Parameters:

name - The name (id) of the jacc-provider to be removed.

getAuthRealmConfigMap

Map<String,AuthRealmConfig> getAuthRealmConfigMap()

Calls Container.getContaineeMap( XTypes.AUTH_REALM_CONFIG ).

Returns:

Map of AuthRealmConfig MBean proxies, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createAuthRealmConfig

AuthRealmConfig createAuthRealmConfig(String name,
                                      String classname,
                                      Map<String,String> optional)

Create a new AuthRealmConfig. If you are creating a File Realm using AuthRealmConfig.DEFAULT_REALM_CLASSNAME, you will also want to specify the property AuthRealmConfig.KEY_FILE_PROPERTY_KEY, typically with a template String such as AuthRealmConfig.KEY_FILE_PREFIXmy-key-file.

Parameters:

name - name of the <auth-realm>

classname - implementing class, eg AuthRealmConfig.DEFAULT_REALM_CLASSNAME

optional - optional parameters (properties)

Returns:

Returns a proxy to the created AuthRealmConfig MBean.

removeAuthRealmConfig

void removeAuthRealmConfig(String name)

Removes an auth-realm element.

Parameters:

name - name of the auth-realm

getAuditModuleConfigMap

Map<String,AuditModuleConfig> getAuditModuleConfigMap()

Calls Container.getContaineeMap( XTypes.AUDIT_MODULE_CONFIG ).

Returns:

Map of AuditModuleConfig MBean proxies, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createAuditModuleConfig

AuditModuleConfig createAuditModuleConfig(String name,
                                          String className,
                                          boolean auditOn,
                                          Map<String,String> reservedForFutureUse)

Create a new <audit-module>

Parameters:

name - name of the <audit-module

className - implementing class

auditOn - true if auditing is on (property)

reservedForFutureUse - reserved for future use

removeAuditModuleConfig

void removeAuditModuleConfig(String name)

Removes an <audit-module> element.

Parameters:

name - name of the audit-module

getMessageSecurityConfigMap

Map<String,MessageSecurityConfig> getMessageSecurityConfigMap()

Calls Container.getContaineeMap( XTypes.MESSAGE_SECURITY_CONFIG ).

Returns:

Map of MessageSecurityConfig MBean proxies, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createMessageSecurityConfig

MessageSecurityConfig createMessageSecurityConfig(String authLayer,
                                                  Map<String,String> reserved)

Create a new <message-security-config>

Parameters:

authLayer -

reserved -

Returns:

A proxy to the MessageSecurityConfig MBean.

See Also:

MessageSecurityConfigKeys

removeMessageSecurityConfig

void removeMessageSecurityConfig(String authLayer)

Removes message-security-config element.

Parameters:

authLayer -