com.sun.appserv.management.config
Interface DomainConfig

All Superinterfaces:

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

public interface DomainConfig
extends PropertiesAccess, SystemPropertiesAccess, ConfigElement, Container, ConfigRemover

Configuration for the <domain> element.

All configuration resides in a tree rooted at this .

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.SystemPropertiesAccess

SYSTEM_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

AdminObjectResourceConfig	createAdminObjectResourceConfig(String jndiName, String resType, String resAdapter, Map<String,String> optional) Creates a new <admin-object-resource>.
ClusterConfig	createClusterConfig(String name, Map<String,String> optional) Create a new ClusterConfig which refers to a copy of the default-config.
ClusterConfig	createClusterConfig(String name, String referencedConfigName, Map<String,String> optional) Create a new ClusterConfig.
ClusteredServerConfig	createClusteredServerConfig(String name, String clusterName, String nodeAgentName, Map<String,String> optional) Creates a new <server> that belongs to a cluster.
ConfigConfig	createConfigConfig(String name, Map<String,String> optional) Create a new <config> element.
ConnectorConnectionPoolConfig	createConnectorConnectionPoolConfig(String name, String resourceAdapterName, String connectionDefinitionName, Map<String,String> optional) Creates a new <connector-connection-pool> Valid keys in optional map include: ConnectorConnectionPoolConfigKeys.STEADY_POOL_SIZE_KEY ConnectorConnectionPoolConfigKeys.MAX_POOL_SIZE_KEY ConnectorConnectionPoolConfigKeys.MAX_WAIT_TIME_IN_MILLIS_KEY ConnectorConnectionPoolConfigKeys.POOL_RESIZE_QUANTITY_KEY ConnectorConnectionPoolConfigKeys.IDLE_TIMEOUT_IN_SECONDS_KEY ConnectorConnectionPoolConfigKeys.FAIL_ALL_CONNECTIONS_KEY ConnectorConnectionPoolConfigKeys.TRANSACTION_SUPPORT_KEY #TRANSACTION_SUPPORT_KEY
ConnectorResourceConfig	createConnectorResourceConfig(String jndiName, String poolName, Map<String,String> optional) Creates a new <connector-resource> Legal optional keys include: ResourceConfigKeys#ENABLED_KEY
CustomMBeanConfig	createCustomMBeanConfig(String name, String implClassname, String objectName, boolean enabled, Map<String,String> reserved) Create a new CustomMBeanConfig.
CustomResourceConfig	createCustomResourceConfig(String jndiName, String resType, String factoryClass, Map<String,String> optional) Creates a new custom resource.
JDBCConnectionPoolConfig	createJDBCConnectionPoolConfig(String name, String datasourceClassname, Map<String,String> optional) Create a new <jdbc-connection-pool>.
JDBCConnectionPoolConfig	createJDBCConnectionPoolConfig(String name, String connectionValidationMethod, String datasourceClassname, boolean failAllConnections, int idleTimeoutSeconds, boolean connectionValidationRequired, boolean isolationLevelGuaranteed, String transactionIsolationLevel, int maxPoolSize, int maxWaitTimeMillis, int poolResizeQuantity, String resType, int steadyPoolSize, String databaseName, String databaseUserName, String databasePassword, Map<String,String> reservedForFutureUse) Create a new <jdbc-connection-pool>.
JDBCResourceConfig	createJDBCResourceConfig(String jndiName, String poolName, Map<String,String> optional) Create a new <jdbc-resource> Optional parameters include: ResourceConfigKeys.ENABLED_KEY
JNDIResourceConfig	createJNDIResourceConfig(String jndiName, String jndiLookupName, String resType, String factoryClass, Map<String,String> optional) Creates a new <external-jndi-resource>.
LBConfig	createLBConfig(String name, Map<String,String> params) Creates a new lb-config.
LifecycleModuleConfig	createLifecycleModuleConfig(String name, String description, String classname, String classpath, String loadOrder, boolean isFailureFatal, boolean enabled, Map<String,String> reserved) Create a new lifecycle module.
LoadBalancerConfig	createLoadBalancerConfig(String name, String lbConfigName, boolean autoApplyEnabled, Map<String,String> optional) Create a new LoadBalancer.
MailResourceConfig	createMailResourceConfig(String jndiName, String host, String user, String from, Map<String,String> optional) Create a new <mail-resource>.
PersistenceManagerFactoryResourceConfig	createPersistenceManagerFactoryResourceConfig(String jndiName, Map<String,String> optional) Create a new persistence manager factory resource.
ResourceAdapterConfig	createResourceAdapterConfig(String resourceAdapterName, Map<String,String> optional) Legal options include: ResourceAdapterConfigKeys.THREAD_POOL_IDS_KEY
StandaloneServerConfig	createStandaloneServerConfig(String name, String nodeAgentName, String configName, Map<String,String> optional) Create a new <server> given an existing config and node-agent.
Map<String,AdminObjectResourceConfig>	getAdminObjectResourceConfigMap() Calls Container.getContaineeMap( XTypes.ADMIN_OBJECT_RESOURCE_CONFIG ).
Map<String,AppClientModuleConfig>	getAppClientModuleConfigMap()
String	getApplicationRoot()
Map<String,ClusterConfig>	getClusterConfigMap() Calls Container.getContaineeMap( XTypes.CLUSTER_CONFIG ).
Map<String,ClusteredServerConfig>	getClusteredServerConfigMap() Calls Container.getContaineeMap( XTypes.CLUSTERED_SERVER_CONFIG ).
Map<String,ConfigConfig>	getConfigConfigMap() Calls Container.getContaineeMap( XTypes.CONFIG_CONFIG ).
Map<String,ConnectorConnectionPoolConfig>	getConnectorConnectionPoolConfigMap() Calls Container.getContaineeMap( XTypes.CONNECTOR_CONNECTION_POOL_CONFIG ).
Map<String,ConnectorResourceConfig>	getConnectorResourceConfigMap() Calls Container.getContaineeMap( XTypes.CONNECTOR_RESOURCE_CONFIG ).
Map<String,CustomMBeanConfig>	getCustomMBeanConfigMap()
Map<String,CustomResourceConfig>	getCustomResourceConfigMap() Calls Container.getContaineeMap( XTypes.CUSTOM_RESOURCE_CONFIG ).
Map<String,EJBModuleConfig>	getEJBModuleConfigMap()
Map<String,J2EEApplicationConfig>	getJ2EEApplicationConfigMap()
Map<String,JDBCConnectionPoolConfig>	getJDBCConnectionPoolConfigMap() Calls Container.getContaineeMap( XTypes.JDBC_CONNECTION_POOL_CONFIG ).
Map<String,JDBCResourceConfig>	getJDBCResourceConfigMap() Calls Container.getContaineeMap( XTypes.JDBC_RESOURCE_CONFIG ).
Map<String,JNDIResourceConfig>	getJNDIResourceConfigMap() Calls Container.getContaineeMap( XTypes.JNDI_RESOURCE_CONFIG ).
Map<String,LBConfig>	getLBConfigMap() Calls Container.getContaineeMap( XTypes.LB_CONFIG ).
Map<String,LifecycleModuleConfig>	getLifecycleModuleConfigMap()
Map<String,LoadBalancerConfig>	getLoadBalancerConfigMap() Calls Container.getContaineeMap( XTypes.LOAD_BALANCER_CONFIG).
String	getLocale()
String	getLogRoot()
Map<String,MailResourceConfig>	getMailResourceConfigMap() Calls Container.getContaineeMap( XTypes.MAIL_RESOURCE_CONFIG ).
Map<String,NodeAgentConfig>	getNodeAgentConfigMap() Calls Container.getContaineeMap( XTypes.NODE_AGENT_CONFIG ).
Map<String,PersistenceManagerFactoryResourceConfig>	getPersistenceManagerFactoryResourceConfigMap() Calls Container.getContaineeMap( XTypes.PERSISTENCE_MANAGER_FACTORY_RESOURCE_CONFIG ).
Map<String,RARModuleConfig>	getRARModuleConfigMap()
Map<String,ResourceAdapterConfig>	getResourceAdapterConfigMap() Calls Container.getContaineeMap( XTypes.RESOURCE_ADAPTER_CONFIG ).
ResourceConfig	getResourceConfig(String name) Get a ResourceConfig of any kind.
Map<String,ServerConfig>	getServerConfigMap() Combines the results of getStandaloneServerConfigMap() and getClusteredServerConfigMap().
Map<String,StandaloneServerConfig>	getStandaloneServerConfigMap() Calls Container.getContaineeMap( XTypes.STANDALONE_SERVER_CONFIG ).
Map<String,WebModuleConfig>	getWebModuleConfigMap()
void	removeAdminObjectResourceConfig(String jndiName) Removes an admin object resource.
void	removeClusterConfig(String name) Remove an existing <cluster>.
void	removeClusteredServerConfig(String name)
void	removeConfigConfig(String name) Remove a config.
void	removeConnectorConnectionPoolConfig(String name) Removes a connector connection pool.
void	removeConnectorResourceConfig(String jndiName) Removes a connector resource.
void	removeCustomMBeanConfig(String name) Remove a CustomMBeanConfig.
void	removeCustomResourceConfig(String name) Removes a custom resource.
void	removeJDBCConnectionPoolConfig(String jdbcConnectionPoolName) Remove the <jdbc-connection-pool>.
void	removeJDBCResourceConfig(String jndiName) Removes a jdbc resource.
void	removeJNDIResourceConfig(String jndiName) Remove the <external-jndi-resource>.
void	removeLBConfig(String name) Removes a lb-config.
void	removeLifecycleModuleConfig(String name) Removes an existing lifecycle module.
void	removeLoadBalancerConfig(String name) Remove an existing <LoadBalancerConfig>.
void	removeMailResourceConfig(String jndiName) Removes a mail resource.
void	removePersistenceManagerFactoryResourceConfig(String jndiName) Removes a persistence manager factory resource.
void	removeResourceAdapterConfig(String resourceAdapterName)
void	removeStandaloneServerConfig(String name)
void	setApplicationRoot(String value)
void	setLocale(String value)
void	setLogRoot(String value)

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.config.SystemPropertiesAccess

createSystemProperty, existsSystemProperty, getSystemProperties, getSystemPropertyNames, getSystemPropertyValue, removeSystemProperty, setSystemPropertyValue

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

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

removeConfig

Field Detail

J2EE_TYPE

static final String J2EE_TYPE

The j2eeType as returned by AMX.getJ2EEType().

See Also:

Constant Field Values

Method Detail

createStandaloneServerConfig

StandaloneServerConfig createStandaloneServerConfig(String name,
                                                    String nodeAgentName,
                                                    String configName,
                                                    Map<String,String> optional)

Create a new <server> given an existing config and node-agent. These are required parameters for the server instance to be created.

Parameters:

name - the name of the server to create

nodeAgentName - the node agent that the server will reference

configName - the config that the server will reference

optional - properties for this new server This is a Map object consisting of key/value for a given property, that can be applied to this server instance. The Map may also contain additional properties that can be applied to this server instance.

Note that Properties that relate to ports of listeners are stored as system-properties and have specific key names and must be specified to override values defined in the config to any of the relevant ports - this is particularly required when the instance being created is on the same machine as other instances in the domain.

Legal property keys are those found in ServerConfigKeys.

Returns:

A proxy to the StandaloneServerConfig MBean that manages the newly created server

getNodeAgentConfigMap

Map<String,NodeAgentConfig> getNodeAgentConfigMap()

Calls Container.getContaineeMap( XTypes.NODE_AGENT_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

getConfigConfigMap

Map<String,ConfigConfig> getConfigConfigMap()

Calls Container.getContaineeMap( XTypes.CONFIG_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createConfigConfig

ConfigConfig createConfigConfig(String name,
                                Map<String,String> optional)

Create a new <config> element. Legal keys in the optional Map include:

• ConfigConfigKeys.DYNAMIC_RECONFIGURATION_ENABLED_KEY
• ConfigConfigKeys.SRC_CONFIG_NAME_KEY

A new config is created by copying an existing one. Unless a specific config is specified via ConfigConfigKeys.SRC_CONFIG_NAME_KEY, the default config as given by ConfigConfigKeys.DEFAULT_SRC_CONFIG_NAME will be copied.

Depending on the context in which the config is to be used, it may or may not conflict with values found in other configs.

Parameters:

name - name of the <config>

optional - optional attributes for config creation

Returns:

Returns a proxy to the ConfigConfig MBean.

See Also:

ConfigConfigKeys

removeConfigConfig

void removeConfigConfig(String name)

Remove a config. This will fail if any or refers to it.

Parameters:

name - The config name.

getStandaloneServerConfigMap

Map<String,StandaloneServerConfig> getStandaloneServerConfigMap()

Calls Container.getContaineeMap( XTypes.STANDALONE_SERVER_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

getClusteredServerConfigMap

Map<String,ClusteredServerConfig> getClusteredServerConfigMap()

Calls Container.getContaineeMap( XTypes.CLUSTERED_SERVER_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

removeStandaloneServerConfig

void removeStandaloneServerConfig(String name)

removeClusteredServerConfig

void removeClusteredServerConfig(String name)

createClusteredServerConfig

ClusteredServerConfig createClusteredServerConfig(String name,
                                                  String clusterName,
                                                  String nodeAgentName,
                                                  Map<String,String> optional)

Creates a new <server> that belongs to a cluster.

Parameters:

name - Name of the server.

nodeAgentName - Name of the node agent that should manage this instance

clusterName - Name of the cluster to which this server should belong.

Note that it is prefereable to pass in an existing nodeagent's name. A non-existent nodeagent name can be passed in but this nodeagent's hostname attribute will be marked as "localhost" as an assumption is made that the nodeagent is local. The nodeagent should be created through the create-node-agent command using the Command Line Interface(CLI) on the machine where this instance is intended to reside after this create() operation. Prior to starting this instance, that nodeagent will have to be started using the CLI command start-node-agent.

optional - Attributes and properties for this new server.

Note that Properties that relate to ports of listeners are stored as system-properties and have specific key names and must be specified to override values defined in the config to any of the relevant ports - this is particularly required when the instance being created is on the same machine as other instances in the domain.

Legal keys are those defined in ServerConfigKeys.

Returns:

A proxy to the ClusteredServerConfig MBean.

getServerConfigMap

Map<String,ServerConfig> getServerConfigMap()

Combines the results of getStandaloneServerConfigMap() and getClusteredServerConfigMap().

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

getClusterConfigMap

Map<String,ClusterConfig> getClusterConfigMap()

Calls Container.getContaineeMap( XTypes.CLUSTER_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createClusterConfig

ClusterConfig createClusterConfig(String name,
                                  String referencedConfigName,
                                  Map<String,String> optional)

Create a new ClusterConfig. The 'referencedConfigName' must be non-null and must not be "default-config" or "server-config". If it is desired to create a new ClusterConfig which uses a copy of default-config, use the createClusterConfig( name, reserved ) form.

Parameters:

name - the name of the cluster to create.

referencedConfigName - the non-null name of the config to reference.

optional - optional values, properties only

Returns:

a ClusterConfig

createClusterConfig

ClusterConfig createClusterConfig(String name,
                                  Map<String,String> optional)

Create a new ClusterConfig which refers to a copy of the default-config.

Parameters:

name - the name of the cluster to create.

optional - optional values, properties only

Returns:

a ClusterConfig

removeClusterConfig

void removeClusterConfig(String name)

Remove an existing <cluster>.

Parameters:

name - the name of the cluster to remove.

getLoadBalancerConfigMap

Map<String,LoadBalancerConfig> getLoadBalancerConfigMap()

Calls Container.getContaineeMap( XTypes.LOAD_BALANCER_CONFIG).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createLoadBalancerConfig

LoadBalancerConfig createLoadBalancerConfig(String name,
                                            String lbConfigName,
                                            boolean autoApplyEnabled,
                                            Map<String,String> optional)

Create a new LoadBalancer. The 'lbConfigName' and 'name' must be non-null.

Parameters:

name - the name of the load balancer to create

lbConfigName - the non-null name of the lb config to reference.

autoApplyEnabled - flag to indicate if the LB changes are pushed immediately to the physical load balancer. Defaults to false

optional - optional values, properties only

Returns:

a LoadBalancer

removeLoadBalancerConfig

void removeLoadBalancerConfig(String name)

Remove an existing <LoadBalancerConfig>.

Parameters:

name - the name of the load-balancer to remove.

getLBConfigMap

Map<String,LBConfig> getLBConfigMap()

Calls Container.getContaineeMap( XTypes.LB_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createLBConfig

LBConfig createLBConfig(String name,
                        Map<String,String> params)

Creates a new lb-config. Legal options include:

• LBConfigKeys.RESPONSE_TIMEOUT_IN_SECONDS_KEY
• LBConfigKeys.HTTPS_ROUTING_KEY
• LBConfigKeys.RELOAD_POLL_INTERVAL_IN_SECONDS_KEY
• LBConfigKeys.MONITORING_ENABLED_KEY
• LBConfigKeys.ROUTE_COOKIE_ENABLED_KEY

Parameters:

name - The name of the load balancer configuration.

params - Remaining attributes for creation of a new lb-config.

Returns:

A proxy to the LBConfig MBean that manages the newly created lb-config.

See Also:

LBConfigKeys

removeLBConfig

void removeLBConfig(String name)

Removes a lb-config.

Parameters:

name - The name of the load balancer configuration.

getApplicationRoot

String getApplicationRoot()

setApplicationRoot

void setApplicationRoot(String value)

getLocale

String getLocale()

setLocale

void setLocale(String value)

getLogRoot

String getLogRoot()

setLogRoot

void setLogRoot(String value)

getCustomResourceConfigMap

Map<String,CustomResourceConfig> getCustomResourceConfigMap()

Calls Container.getContaineeMap( XTypes.CUSTOM_RESOURCE_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createCustomResourceConfig

CustomResourceConfig createCustomResourceConfig(String jndiName,
                                                String resType,
                                                String factoryClass,
                                                Map<String,String> optional)

Creates a new custom resource.

• ResourceConfigKeys.ENABLED_KEY

Parameters:

jndiName -

resType -

factoryClass -

optional - optional Attributes (may be null )

Returns:

A proxy to the CustomResourceConfig MBean.

removeCustomResourceConfig

void removeCustomResourceConfig(String name)

Removes a custom resource.

Parameters:

name - The name of the custom resource.

getJNDIResourceConfigMap

Map<String,JNDIResourceConfig> getJNDIResourceConfigMap()

Calls Container.getContaineeMap( XTypes.JNDI_RESOURCE_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createJNDIResourceConfig

JNDIResourceConfig createJNDIResourceConfig(String jndiName,
                                            String jndiLookupName,
                                            String resType,
                                            String factoryClass,
                                            Map<String,String> optional)

Creates a new <external-jndi-resource>. Optional values include:

• ResourceConfigKeys.ENABLED_KEY

Parameters:

jndiName -

jndiLookupName -

resType -

factoryClass -

optional - optional Attributes (may be null )

Returns:

a JNDIResourceConfig

removeJNDIResourceConfig

void removeJNDIResourceConfig(String jndiName)

Remove the <external-jndi-resource>.

Parameters:

jndiName - The jndi name of the external jndi resource to be removed.

getPersistenceManagerFactoryResourceConfigMap

Map<String,PersistenceManagerFactoryResourceConfig> getPersistenceManagerFactoryResourceConfigMap()

Calls Container.getContaineeMap( XTypes.PERSISTENCE_MANAGER_FACTORY_RESOURCE_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createPersistenceManagerFactoryResourceConfig

PersistenceManagerFactoryResourceConfig createPersistenceManagerFactoryResourceConfig(String jndiName,
                                                                                      Map<String,String> optional)

Create a new persistence manager factory resource. Optional values include:

• PersistenceManagerFactoryResourceConfigKeys.FACTORY_CLASS_KEY
• PersistenceManagerFactoryResourceConfigKeys.JDBC_RESOURCE_JNDI_NAME_KEY
• ResourceConfigKeys.ENABLED_KEY

Parameters:

jndiName -

optional - optional Attributes (may be null )

Returns:

A proxy to the PersistenceManagerFactoryResourceConfig MBean that manages the newly created resource.

See Also:

PersistenceManagerFactoryResourceConfigKeys

removePersistenceManagerFactoryResourceConfig

void removePersistenceManagerFactoryResourceConfig(String jndiName)

Removes a persistence manager factory resource.

Parameters:

jndiName -

getJDBCResourceConfigMap

Map<String,JDBCResourceConfig> getJDBCResourceConfigMap()

Calls Container.getContaineeMap( XTypes.JDBC_RESOURCE_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createJDBCResourceConfig

JDBCResourceConfig createJDBCResourceConfig(String jndiName,
                                            String poolName,
                                            Map<String,String> optional)

Create a new <jdbc-resource> Optional parameters include:

• ResourceConfigKeys.ENABLED_KEY

Parameters:

jndiName -

poolName -

optional - optional Attributes (may be null )

Returns:

A proxy to the JDBCResourceConfig MBean that manages the newly created jdbc-resource.

removeJDBCResourceConfig

void removeJDBCResourceConfig(String jndiName)

Removes a jdbc resource.

Parameters:

jndiName -

getJDBCConnectionPoolConfigMap

Map<String,JDBCConnectionPoolConfig> getJDBCConnectionPoolConfigMap()

Calls Container.getContaineeMap( XTypes.JDBC_CONNECTION_POOL_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createJDBCConnectionPoolConfig

JDBCConnectionPoolConfig createJDBCConnectionPoolConfig(String name,
                                                        String connectionValidationMethod,
                                                        String datasourceClassname,
                                                        boolean failAllConnections,
                                                        int idleTimeoutSeconds,
                                                        boolean connectionValidationRequired,
                                                        boolean isolationLevelGuaranteed,
                                                        String transactionIsolationLevel,
                                                        int maxPoolSize,
                                                        int maxWaitTimeMillis,
                                                        int poolResizeQuantity,
                                                        String resType,
                                                        int steadyPoolSize,
                                                        String databaseName,
                                                        String databaseUserName,
                                                        String databasePassword,
                                                        Map<String,String> reservedForFutureUse)

Create a new <jdbc-connection-pool>.

Parameters:

name - name of the <jdbc-connection-pool>

connectionValidationMethod -

datasourceClassname -

failAllConnections -

idleTimeoutSeconds -

connectionValidationRequired -

isolationLevelGuaranteed -

transactionIsolationLevel -

maxPoolSize -

maxWaitTimeMillis -

poolResizeQuantity -

resType -

steadyPoolSize -

databaseName -

databaseUserName -

databasePassword -

reservedForFutureUse - reserved for future use

Returns:

a JDBCConnectionPoolConfig

createJDBCConnectionPoolConfig

JDBCConnectionPoolConfig createJDBCConnectionPoolConfig(String name,
                                                        String datasourceClassname,
                                                        Map<String,String> optional)

Create a new <jdbc-connection-pool>. Legal optional attributes include:

• JDBCConnectionPoolConfigKeys.CONNECTION_VALIDATION_METHOD_KEY
• JDBCConnectionPoolConfigKeys.VALIDATION_TABLE_NAME_KEY
• JDBCConnectionPoolConfigKeys.FAIL_ALL_CONNECTIONS_KEY
• JDBCConnectionPoolConfigKeys.IDLE_TIMEOUT_IN_SECONDS_KEY
• JDBCConnectionPoolConfigKeys.IS_CONNECTION_VALIDATION_REQUIRED_KEY
• JDBCConnectionPoolConfigKeys.IS_ISOLATION_LEVEL_GUARANTEED_KEY
• JDBCConnectionPoolConfigKeys.TRANSACTION_ISOLATION_LEVEL_KEY
• JDBCConnectionPoolConfigKeys.MAX_POOL_SIZE_KEY
• JDBCConnectionPoolConfigKeys.MAX_WAIT_TIME_MILLIS_KEY
• JDBCConnectionPoolConfigKeys.POOL_RESIZE_QUANTITY_KEY
• JDBCConnectionPoolConfigKeys.RES_TYPE_KEY
• JDBCConnectionPoolConfigKeys.STEADY_POOL_SIZE_KEY
• JDBCConnectionPoolConfigKeys.DATABASE_NAME_KEY
• JDBCConnectionPoolConfigKeys.DATABASE_USER_KEY
• JDBCConnectionPoolConfigKeys.DATABASE_PASSWORD_KEY

Parameters:

name - name of the <jdbc-connection-pool>

datasourceClassname -

optional - optional parameters

Returns:

a JDBCConnectionPoolConfig

removeJDBCConnectionPoolConfig

void removeJDBCConnectionPoolConfig(String jdbcConnectionPoolName)

Remove the <jdbc-connection-pool>.

Parameters:

jdbcConnectionPoolName -

getConnectorResourceConfigMap

Map<String,ConnectorResourceConfig> getConnectorResourceConfigMap()

Calls Container.getContaineeMap( XTypes.CONNECTOR_RESOURCE_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createConnectorResourceConfig

ConnectorResourceConfig createConnectorResourceConfig(String jndiName,
                                                      String poolName,
                                                      Map<String,String> optional)

Creates a new <connector-resource> Legal optional keys include:

• ResourceConfigKeys#ENABLED_KEY

Parameters:

jndiName -

poolName -

optional - optional parameters (may be null).

removeConnectorResourceConfig

void removeConnectorResourceConfig(String jndiName)

Removes a connector resource.

Parameters:

jndiName -

getConnectorConnectionPoolConfigMap

Map<String,ConnectorConnectionPoolConfig> getConnectorConnectionPoolConfigMap()

Calls Container.getContaineeMap( XTypes.CONNECTOR_CONNECTION_POOL_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createConnectorConnectionPoolConfig

ConnectorConnectionPoolConfig createConnectorConnectionPoolConfig(String name,
                                                                  String resourceAdapterName,
                                                                  String connectionDefinitionName,
                                                                  Map<String,String> optional)

Creates a new <connector-connection-pool> Valid keys in optional map include:

• ConnectorConnectionPoolConfigKeys.STEADY_POOL_SIZE_KEY
• ConnectorConnectionPoolConfigKeys.MAX_POOL_SIZE_KEY
• ConnectorConnectionPoolConfigKeys.MAX_WAIT_TIME_IN_MILLIS_KEY
• ConnectorConnectionPoolConfigKeys.POOL_RESIZE_QUANTITY_KEY
• ConnectorConnectionPoolConfigKeys.IDLE_TIMEOUT_IN_SECONDS_KEY
• ConnectorConnectionPoolConfigKeys.FAIL_ALL_CONNECTIONS_KEY
• ConnectorConnectionPoolConfigKeys.TRANSACTION_SUPPORT_KEY
• #TRANSACTION_SUPPORT_KEY

Parameters:

name - pool name.

resourceAdapterName -

connectionDefinitionName - unique name, identifying one connection-definition in a Resource Adapter.

optional -

Returns:

A proxy to the ConnectorConnectionPoolConfig MBean that manages the newly created connector-connection-pool element.

See Also:

ConnectorConnectionPoolConfigKeys

removeConnectorConnectionPoolConfig

void removeConnectorConnectionPoolConfig(String name)

Removes a connector connection pool.

Parameters:

name - pool name.

getAdminObjectResourceConfigMap

Map<String,AdminObjectResourceConfig> getAdminObjectResourceConfigMap()

Calls Container.getContaineeMap( XTypes.ADMIN_OBJECT_RESOURCE_CONFIG ).

Returns:

Map of items, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createAdminObjectResourceConfig

AdminObjectResourceConfig createAdminObjectResourceConfig(String jndiName,
                                                          String resType,
                                                          String resAdapter,
                                                          Map<String,String> optional)

Creates a new <admin-object-resource>.

• ResourceConfigKeys.ENABLED_KEY

Parameters:

jndiName - JNDI name of the resource.

resType -

resAdapter - Name of the inbound resource adapter.

optional - optional Attributes (may be null )

Returns:

A proxy to the AdminObjectResourceConfig MBean.

removeAdminObjectResourceConfig

void removeAdminObjectResourceConfig(String jndiName)

Removes an admin object resource.

Parameters:

jndiName - JNDI name of the resource.

getResourceAdapterConfigMap

Map<String,ResourceAdapterConfig> getResourceAdapterConfigMap()

Calls Container.getContaineeMap( XTypes.RESOURCE_ADAPTER_CONFIG ).

Returns:

Map of AMXs, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createResourceAdapterConfig

ResourceAdapterConfig createResourceAdapterConfig(String resourceAdapterName,
                                                  Map<String,String> optional)

Legal options include:

• ResourceAdapterConfigKeys.THREAD_POOL_IDS_KEY

removeResourceAdapterConfig

void removeResourceAdapterConfig(String resourceAdapterName)

getMailResourceConfigMap

Map<String,MailResourceConfig> getMailResourceConfigMap()

Calls Container.getContaineeMap( XTypes.MAIL_RESOURCE_CONFIG ).

Returns:

Map of s, keyed by name.

See Also:

Container.getContaineeMap(java.lang.String)

createMailResourceConfig

MailResourceConfig createMailResourceConfig(String jndiName,
                                            String host,
                                            String user,
                                            String from,
                                            Map<String,String> optional)

Create a new <mail-resource>. Optional keys are:

• MailResourceConfigKeys.STORE_PROTOCOL_KEY
• MailResourceConfigKeys.STORE_PROTOCOL_CLASS_KEY
• MailResourceConfigKeys.TRANSPORT_PROTOCOL_KEY
• MailResourceConfigKeys.TRANSPORT_PROTOCOL_CLASS_KEY
• MailResourceConfigKeys.DEBUG_KEY

Parameters:

jndiName -

host -

user -

from -

optional -

Returns:

A MailResourceConfig.

See Also:

MailResourceConfigKeys

removeMailResourceConfig

void removeMailResourceConfig(String jndiName)

Removes a mail resource.

Parameters:

jndiName -

getJ2EEApplicationConfigMap

Map<String,J2EEApplicationConfig> getJ2EEApplicationConfigMap()

Returns:

Map, keyed by name of J2EEApplicationConfig

See Also:

getEJBModuleConfigMap(), getWebModuleConfigMap(), getAppClientModuleConfigMap(), getRARModuleConfigMap(), getLifecycleModuleConfigMap()

getEJBModuleConfigMap

Map<String,EJBModuleConfig> getEJBModuleConfigMap()

Returns:

Map, keyed by name of EJBModuleConfig.

See Also:

getJ2EEApplicationConfigMap(), getWebModuleConfigMap(), getAppClientModuleConfigMap(), getRARModuleConfigMap(), getLifecycleModuleConfigMap()

getWebModuleConfigMap

Map<String,WebModuleConfig> getWebModuleConfigMap()

Returns:

Map, keyed by name of WebModuleConfig.

See Also:

getJ2EEApplicationConfigMap(), getEJBModuleConfigMap(), getAppClientModuleConfigMap(), getRARModuleConfigMap(), getLifecycleModuleConfigMap()

getRARModuleConfigMap

Map<String,RARModuleConfig> getRARModuleConfigMap()

Returns:

Map, keyed by name of RARModuleConfig.

See Also:

getJ2EEApplicationConfigMap(), getWebModuleConfigMap(), getEJBModuleConfigMap(), getAppClientModuleConfigMap(), getLifecycleModuleConfigMap()

getAppClientModuleConfigMap

Map<String,AppClientModuleConfig> getAppClientModuleConfigMap()

Returns:

Map, keyed by name of AppClientModuleConfig.

See Also:

getJ2EEApplicationConfigMap(), getWebModuleConfigMap(), getEJBModuleConfigMap(), getRARModuleConfigMap(), getLifecycleModuleConfigMap()

getLifecycleModuleConfigMap

Map<String,LifecycleModuleConfig> getLifecycleModuleConfigMap()

Returns:

Map, keyed by name of LifecycleModuleConfig.

createLifecycleModuleConfig

LifecycleModuleConfig createLifecycleModuleConfig(String name,
                                                  String description,
                                                  String classname,
                                                  String classpath,
                                                  String loadOrder,
                                                  boolean isFailureFatal,
                                                  boolean enabled,
                                                  Map<String,String> reserved)

Create a new lifecycle module. A Lifecycle Module must implement the interface com.sun.appserv.server.LifecycleListener, which is outside the scope of AMX, see the product documentation.

The 'loadOrder' parameter must be a positive integer value (eg >= 1) can be used to force the order in which deployed lifecycle modules are loaded at server start up. Smaller numbered modules get loaded sooner. Order is unspecified if two or more lifecycle modules have the same load-order value.

If 'isFailureFatal' is true,server startup will fail when this module does not load properly.

Parameters:

name - the name for the new lifecycle module

description - optional description

classname - the classname associated with this lifecycle module

classpath - optional additioinal classpath

loadOrder - integer value to force loading order of LifecycleModules

isFailureFatal - if true, server startup will fail when this module does not load properly.

enabled - whether to load the module at startup

Returns:

a LifecycleModuleConfig

removeLifecycleModuleConfig

void removeLifecycleModuleConfig(String name)

Removes an existing lifecycle module.

Parameters:

name - the name of the lifecycle module to be removed.

getResourceConfig

ResourceConfig getResourceConfig(String name)

Get a ResourceConfig of any kind.

Parameters:

name -

createCustomMBeanConfig

CustomMBeanConfig createCustomMBeanConfig(String name,
                                          String implClassname,
                                          String objectName,
                                          boolean enabled,
                                          Map<String,String> reserved)

Create a new CustomMBeanConfig. The 'implClassname' must specify a valid classname. If invalid, the CustomMBeanConfig will still be created, but of course the MBean will not be loaded.

Any number of properties may be included by adding them to the Map 'optional'. See PropertiesAccess for details.

See CustomMBeanConfig for details on valid values for the 'objectNameProperties' parameter, and for details on the ObjectName with which the MBean will be registered.

Questions

• Where do you put the jar file for the mbean so that it can be loaded?
• What is the behavior if the user creates a CustomMBeanConfig specifying 'objectName' with the following:
  "", "user:", "name=foo", "amx:name=foo", "name=foo,type=bar",":".

  What are the resulting ObjectNames produced by the above, and how are they obtained?

Parameters:

name - the display name, will be the name used in the ObjectName 'name' property

implClassname - the implementing class

objectName - the partial ObjectName used when registering the MBean new module

enabled - whether the MBean should load

reserved - reserved

removeCustomMBeanConfig

void removeCustomMBeanConfig(String name)

Remove a CustomMBeanConfig. All references to it are also removed.

Questions

• Are running MBeans first stopped?

Parameters:

name - name as returned by AMX.getName()

getCustomMBeanConfigMap

Map<String,CustomMBeanConfig> getCustomMBeanConfigMap()

Returns:

Map, keyed by name of CustomMBeanConfig.