FileDocCategorySizeDatePackage
SecurityServiceConfig.javaAPI DocGlassfish v2 API9859Fri May 04 22:30:36 BST 2007com.sun.appserv.management.config

SecurityServiceConfig

public interface SecurityServiceConfig implements com.sun.appserv.management.base.Container, ConfigElement, PropertiesAccess
Configuration for the <security-service> element.

Fields Summary
public static final String
J2EE_TYPE
The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}.
Constructors Summary
Methods Summary
public AuditModuleConfigcreateAuditModuleConfig(java.lang.String name, java.lang.String className, boolean auditOn, java.util.Map reservedForFutureUse)
Create a new <audit-module>

param
name name of the <audit-module
param
className implementing class
param
auditOn true if auditing is on (property)
param
reservedForFutureUse reserved for future use

public AuthRealmConfigcreateAuthRealmConfig(java.lang.String name, java.lang.String classname, java.util.Map optional)
Create a new AuthRealmConfig. If you are creating a File Realm using {@link AuthRealmConfig#DEFAULT_REALM_CLASSNAME}, you will also want to specify the property {@link AuthRealmConfig#KEY_FILE_PROPERTY_KEY}, typically with a template String such as {@link AuthRealmConfig#KEY_FILE_PREFIX}my-key-file.

param
name name of the <auth-realm>
param
classname implementing class, eg {@link AuthRealmConfig#DEFAULT_REALM_CLASSNAME}
param
optional optional parameters (properties)
return
Returns a proxy to the created AuthRealmConfig MBean.

public JACCProviderConfigcreateJACCProviderConfig(java.lang.String name, java.lang.String policyProvider, java.lang.String policyConfigurationFactoryProvider, java.util.Map reservedForFutureUse)
Create a new <jacc-provider>

param
name name of the <jacc-provider>
param
policyProvider a classname
param
policyConfigurationFactoryProvider a classname
param
reservedForFutureUse reserved for future use
return
A proxy to the JACCProviderConfig MBean.

public MessageSecurityConfigcreateMessageSecurityConfig(java.lang.String authLayer, java.lang.String providerID, java.lang.String providerType, java.lang.String providerClassname, java.util.Map optional)
Create a new <message-security-config>. Because there must exist at least one {@link ProviderConfig}, you must specify the parameters for one such item. Additional providers may be created using {@link MessageSecurityConfig#createProviderConfig}.

Optional values include {@link MessageSecurityConfigKeys#DEFAULT_PROVIDER_KEY} and {@link MessageSecurityConfigKeys#DefaultClientProvider}.

See {@link MessageSecurityConfig#createProviderConfig} for more details on parameters

param
authLayer eg {@link MessageLayerValues#SOAP} or {@link MessageLayerValues#HTTP_SERVLET}
param
providerID choose a self-explanatory name for the provider
param
providerType either {@link ProviderConfig#PROVIDER_TYPE_CLIENT} or {@link ProviderConfig#PROVIDER_TYPE_SERVER}
param
providerClassname classname for the provider
param
optional
return
A proxy to the MessageSecurityConfig MBean.
see
MessageSecurityConfigKeys

public booleangetActivateDefaultPrincipalToRoleMapping()
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

public booleangetAuditEnabled()

public java.util.MapgetAuditModuleConfigMap()
Calls Container.getContaineeMap( XTypes.AUDIT_MODULE_CONFIG ).

return
Map of AuditModuleConfig MBean proxies, keyed by name.
see
com.sun.appserv.management.base.Container#getContaineeMap

public java.lang.StringgetAuditModules()

public java.util.MapgetAuthRealmConfigMap()
Calls Container.getContaineeMap( XTypes.AUTH_REALM_CONFIG ).

return
Map of AuthRealmConfig MBean proxies, keyed by name.
see
com.sun.appserv.management.base.Container#getContaineeMap

public java.lang.StringgetDefaultPrincipal()

public java.lang.StringgetDefaultPrincipalPassword()

public java.lang.StringgetDefaultRealm()

public java.lang.StringgetJACC()

public java.util.MapgetJACCProviderConfigMap()
Calls Container.getContaineeMap( XTypes.JACC_PROVIDER_CONFIG ).

return
Map of JACCProviderConfig MBean proxies , keyed by name.
see
com.sun.appserv.management.base.Container#getContaineeMap

public java.lang.StringgetMappedPrincipalClass()
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

public java.util.MapgetMessageSecurityConfigMap()
Calls Container.getContaineeMap( XTypes.MESSAGE_SECURITY_CONFIG ).

return
Map of MessageSecurityConfig MBean proxies, keyed by name.
see
com.sun.appserv.management.base.Container#getContaineeMap

public voidremoveAuditModuleConfig(java.lang.String name)
Removes an <audit-module> element.

param
name name of the audit-module

public voidremoveAuthRealmConfig(java.lang.String name)
Removes an auth-realm element.

param
name name of the auth-realm

public voidremoveJACCProviderConfig(java.lang.String name)
Removes a jacc-provider element.

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

public voidremoveMessageSecurityConfig(java.lang.String authLayer)
Removes message-security-config element.

param
authLayer

public voidsetActivateDefaultPrincipalToRoleMapping(boolean enabled)

see
#getActivateDefaultPrincipalToRoleMapping
since
AppServer 9.0

public voidsetAuditEnabled(boolean value)

public voidsetAuditModules(java.lang.String value)

public voidsetDefaultPrincipal(java.lang.String value)

public voidsetDefaultPrincipalPassword(java.lang.String value)

public voidsetDefaultRealm(java.lang.String value)

public voidsetJACC(java.lang.String value)

public voidsetMappedPrincipalClass(java.lang.String theClass)

see
#getMappedPrincipalClass
since
AppServer 9.0