File	Doc	Category	Size	Date	Package
DomainConfig.java	API Doc	Glassfish v2 API	32400	Fri May 25 13:25:12 BST 2007	com.sun.appserv.management.config

DomainConfig

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 AdminObjectResourceConfig	createAdminObjectResourceConfig(java.lang.String jndiName, java.lang.String resType, java.lang.String resAdapter, java.util.Map optional) Creates a new <admin-object-resource>. {@link ResourceConfigKeys#ENABLED_KEY} param jndiName JNDI name of the resource. param resType param resAdapter Name of the inbound resource adapter. param optional optional Attributes (may be null ) return A proxy to the AdminObjectResourceConfig MBean.
public ClusterConfig	createClusterConfig(java.lang.String name, java.lang.String referencedConfigName, java.util.Map 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. param name the name of the cluster to create. param referencedConfigName the non-null name of the config to reference. param optional optional values, properties only return a ClusterConfig
public ClusterConfig	createClusterConfig(java.lang.String name, java.util.Map optional) Create a new ClusterConfig which refers to a copy of the default-config. param name the name of the cluster to create. param optional optional values, properties only return a ClusterConfig
public ClusteredServerConfig	createClusteredServerConfig(java.lang.String name, java.lang.String clusterName, java.lang.String nodeAgentName, java.util.Map optional) Creates a new <server> that belongs to a cluster. param name Name of the server. param nodeAgentName Name of the node agent that should manage this instance param 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. param 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 {@link ServerConfigKeys}. return A proxy to the ClusteredServerConfig MBean.
public ConfigConfig	createConfigConfig(java.lang.String name, java.util.Map optional) Create a new <config> element. Legal keys in the optional Map include: {@link ConfigConfigKeys#DYNAMIC_RECONFIGURATION_ENABLED_KEY} {@link ConfigConfigKeys#SRC_CONFIG_NAME_KEY} A new config is created by copying an existing one. Unless a specific config is specified via {@link ConfigConfigKeys#SRC_CONFIG_NAME_KEY}, the default config as given by {@link 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. param name name of the <config> param optional optional attributes for config creation return Returns a proxy to the ConfigConfig MBean. see ConfigConfigKeys
public ConnectorConnectionPoolConfig	createConnectorConnectionPoolConfig(java.lang.String name, java.lang.String resourceAdapterName, java.lang.String connectionDefinitionName, java.util.Map optional) Creates a new <connector-connection-pool> Valid keys in optional map include: {@link ConnectorConnectionPoolConfigKeys#STEADY_POOL_SIZE_KEY} {@link ConnectorConnectionPoolConfigKeys#MAX_POOL_SIZE_KEY} {@link ConnectorConnectionPoolConfigKeys#MAX_WAIT_TIME_IN_MILLIS_KEY} {@link ConnectorConnectionPoolConfigKeys#POOL_RESIZE_QUANTITY_KEY} {@link ConnectorConnectionPoolConfigKeys#IDLE_TIMEOUT_IN_SECONDS_KEY} {@link ConnectorConnectionPoolConfigKeys#FAIL_ALL_CONNECTIONS_KEY} {@link ConnectorConnectionPoolConfigKeys#TRANSACTION_SUPPORT_KEY} {@link ConnectorConnectionPoolConfigKeys #TRANSACTION_SUPPORT_KEY} param name pool name. param resourceAdapterName param connectionDefinitionName unique name, identifying one connection-definition in a Resource Adapter. param optional return A proxy to the ConnectorConnectionPoolConfig MBean that manages the newly created connector-connection-pool element. see ConnectorConnectionPoolConfigKeys
public ConnectorResourceConfig	createConnectorResourceConfig(java.lang.String jndiName, java.lang.String poolName, java.util.Map optional) Creates a new <connector-resource> Legal optional keys include: ResourceConfigKeys#ENABLED_KEY param jndiName param poolName param optional optional parameters (may be null).
public CustomMBeanConfig	createCustomMBeanConfig(java.lang.String name, java.lang.String implClassname, java.lang.String objectName, boolean enabled, java.util.Map reserved) Create a new {@link 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 {@link PropertiesAccess} for details. See {@link 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? param name the display name, will be the name used in the ObjectName 'name' property param implClassname the implementing class param objectName the partial ObjectName used when registering the MBean new module param enabled whether the MBean should load param reserved reserved
public CustomResourceConfig	createCustomResourceConfig(java.lang.String jndiName, java.lang.String resType, java.lang.String factoryClass, java.util.Map optional) Creates a new custom resource. {@link ResourceConfigKeys#ENABLED_KEY} param jndiName param resType param factoryClass param optional optional Attributes (may be null ) return A proxy to the CustomResourceConfig MBean.
public JDBCConnectionPoolConfig	createJDBCConnectionPoolConfig(java.lang.String name, java.lang.String connectionValidationMethod, java.lang.String datasourceClassname, boolean failAllConnections, int idleTimeoutSeconds, boolean connectionValidationRequired, boolean isolationLevelGuaranteed, java.lang.String transactionIsolationLevel, int maxPoolSize, int maxWaitTimeMillis, int poolResizeQuantity, java.lang.String resType, int steadyPoolSize, java.lang.String databaseName, java.lang.String databaseUserName, java.lang.String databasePassword, java.util.Map reservedForFutureUse) Create a new <jdbc-connection-pool>. param name name of the <jdbc-connection-pool> param connectionValidationMethod param datasourceClassname param failAllConnections param idleTimeoutSeconds param connectionValidationRequired param isolationLevelGuaranteed param transactionIsolationLevel param maxPoolSize param maxWaitTimeMillis param poolResizeQuantity param resType param steadyPoolSize param databaseName param databaseUserName param databasePassword param reservedForFutureUse reserved for future use return a JDBCConnectionPoolConfig
public JDBCConnectionPoolConfig	createJDBCConnectionPoolConfig(java.lang.String name, java.lang.String datasourceClassname, java.util.Map optional) Create a new <jdbc-connection-pool>. Legal optional attributes include: {@link JDBCConnectionPoolConfigKeys#CONNECTION_VALIDATION_METHOD_KEY} {@link JDBCConnectionPoolConfigKeys#VALIDATION_TABLE_NAME_KEY} {@link JDBCConnectionPoolConfigKeys#FAIL_ALL_CONNECTIONS_KEY} {@link JDBCConnectionPoolConfigKeys#IDLE_TIMEOUT_IN_SECONDS_KEY} {@link JDBCConnectionPoolConfigKeys#IS_CONNECTION_VALIDATION_REQUIRED_KEY} {@link JDBCConnectionPoolConfigKeys#IS_ISOLATION_LEVEL_GUARANTEED_KEY} {@link JDBCConnectionPoolConfigKeys#TRANSACTION_ISOLATION_LEVEL_KEY} {@link JDBCConnectionPoolConfigKeys#MAX_POOL_SIZE_KEY} {@link JDBCConnectionPoolConfigKeys#MAX_WAIT_TIME_MILLIS_KEY} {@link JDBCConnectionPoolConfigKeys#POOL_RESIZE_QUANTITY_KEY} {@link JDBCConnectionPoolConfigKeys#RES_TYPE_KEY} {@link JDBCConnectionPoolConfigKeys#STEADY_POOL_SIZE_KEY} {@link JDBCConnectionPoolConfigKeys#DATABASE_NAME_KEY} {@link JDBCConnectionPoolConfigKeys#DATABASE_USER_KEY} {@link JDBCConnectionPoolConfigKeys#DATABASE_PASSWORD_KEY} param name name of the <jdbc-connection-pool> param datasourceClassname param optional optional parameters return a JDBCConnectionPoolConfig
public JDBCResourceConfig	createJDBCResourceConfig(java.lang.String jndiName, java.lang.String poolName, java.util.Map optional) Create a new <jdbc-resource> Optional parameters include: {@link ResourceConfigKeys#ENABLED_KEY} param jndiName param poolName param optional optional Attributes (may be null ) return A proxy to the JDBCResourceConfig MBean that manages the newly created jdbc-resource.
public JNDIResourceConfig	createJNDIResourceConfig(java.lang.String jndiName, java.lang.String jndiLookupName, java.lang.String resType, java.lang.String factoryClass, java.util.Map optional) Creates a new <external-jndi-resource>. Optional values include: {@link ResourceConfigKeys#ENABLED_KEY} param jndiName param jndiLookupName param resType param factoryClass param optional optional Attributes (may be null ) return a JNDIResourceConfig
public LBConfig	createLBConfig(java.lang.String name, java.util.Map params) Creates a new lb-config. Legal options include: {@link LBConfigKeys#RESPONSE_TIMEOUT_IN_SECONDS_KEY} {@link LBConfigKeys#HTTPS_ROUTING_KEY} {@link LBConfigKeys#RELOAD_POLL_INTERVAL_IN_SECONDS_KEY} {@link LBConfigKeys#MONITORING_ENABLED_KEY} {@link LBConfigKeys#ROUTE_COOKIE_ENABLED_KEY} param name The name of the load balancer configuration. param params Remaining attributes for creation of a new lb-config. return A proxy to the LBConfig MBean that manages the newly created lb-config. see LBConfigKeys
public LifecycleModuleConfig	createLifecycleModuleConfig(java.lang.String name, java.lang.String description, java.lang.String classname, java.lang.String classpath, java.lang.String loadOrder, boolean isFailureFatal, boolean enabled, java.util.Map 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. param name the name for the new lifecycle module param description optional description param classname the classname associated with this lifecycle module param classpath optional additioinal classpath param loadOrder integer value to force loading order of LifecycleModules param isFailureFatal if true, server startup will fail when this module does not load properly. param enabled whether to load the module at startup return a LifecycleModuleConfig
public LoadBalancerConfig	createLoadBalancerConfig(java.lang.String name, java.lang.String lbConfigName, boolean autoApplyEnabled, java.util.Map optional) Create a new LoadBalancer. The 'lbConfigName' and 'name' must be non-null. param name the name of the load balancer to create param lbConfigName the non-null name of the lb config to reference. param autoApplyEnabled flag to indicate if the LB changes are pushed immediately to the physical load balancer. Defaults to false param optional optional values, properties only The known properties are property.device-host - Host name or IP address for the device property.device-admin-port - Device administration port number property.ssl-proxy-host - proxy host used for outbound HTTP property.ssl-proxy-port - proxy port used for outbound HTTP return a LoadBalancer see LoadBalancerConfig
public MailResourceConfig	createMailResourceConfig(java.lang.String jndiName, java.lang.String host, java.lang.String user, java.lang.String from, java.util.Map optional) Create a new <mail-resource>. Optional keys are: {@link MailResourceConfigKeys#STORE_PROTOCOL_KEY} {@link MailResourceConfigKeys#STORE_PROTOCOL_CLASS_KEY} {@link MailResourceConfigKeys#TRANSPORT_PROTOCOL_KEY} {@link MailResourceConfigKeys#TRANSPORT_PROTOCOL_CLASS_KEY} {@link MailResourceConfigKeys#DEBUG_KEY} param jndiName param host param user param from param optional return A MailResourceConfig. see MailResourceConfigKeys
public PersistenceManagerFactoryResourceConfig	createPersistenceManagerFactoryResourceConfig(java.lang.String jndiName, java.util.Map optional) Create a new persistence manager factory resource. Optional values include: {@link PersistenceManagerFactoryResourceConfigKeys#FACTORY_CLASS_KEY} {@link PersistenceManagerFactoryResourceConfigKeys#JDBC_RESOURCE_JNDI_NAME_KEY} {@link ResourceConfigKeys#ENABLED_KEY} param jndiName param optional optional Attributes (may be null ) return A proxy to the PersistenceManagerFactoryResourceConfig MBean that manages the newly created resource. see PersistenceManagerFactoryResourceConfigKeys
public ResourceAdapterConfig	createResourceAdapterConfig(java.lang.String resourceAdapterName, java.util.Map optional) Legal options include: {@link ResourceAdapterConfigKeys#THREAD_POOL_IDS_KEY}
public StandaloneServerConfig	createStandaloneServerConfig(java.lang.String name, java.lang.String nodeAgentName, java.lang.String configName, java.util.Map optional) Create a new <server> given an existing config and node-agent. These are required parameters for the server instance to be created. param name the name of the server to create param nodeAgentName the node agent that the server will reference param configName the config that the server will reference param 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 {@link ServerConfigKeys}. return A proxy to the StandaloneServerConfig MBean that manages the newly created server
public java.util.Map	getAdminObjectResourceConfigMap() Calls Container.getContaineeMap( XTypes.ADMIN_OBJECT_RESOURCE_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getAppClientModuleConfigMap() return Map, keyed by name of {@link AppClientModuleConfig}. see #getJ2EEApplicationConfigMap see #getWebModuleConfigMap see #getEJBModuleConfigMap see #getRARModuleConfigMap see #getLifecycleModuleConfigMap see #getConnectorModuleConfigMap
public java.lang.String	getApplicationRoot()
public java.util.Map	getClusterConfigMap() Calls Container.getContaineeMap( XTypes.CLUSTER_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getClusteredServerConfigMap() Calls Container.getContaineeMap( XTypes.CLUSTERED_SERVER_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getConfigConfigMap() Calls Container.getContaineeMap( XTypes.CONFIG_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getConnectorConnectionPoolConfigMap() Calls Container.getContaineeMap( XTypes.CONNECTOR_CONNECTION_POOL_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getConnectorModuleConfigMap() return Map, keyed by name of {@link J2EEApplicationConfig} see #getJ2EEApplicationConfigMap see #getWebModuleConfigMap see #getEJBModuleConfigMap see #getRARModuleConfigMap see #getAppClientModuleConfigMap see #getLifecycleModuleConfigMap
public java.util.Map	getConnectorResourceConfigMap() Calls Container.getContaineeMap( XTypes.CONNECTOR_RESOURCE_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getCustomMBeanConfigMap() return Map, keyed by name of {@link CustomMBeanConfig}.
public java.util.Map	getCustomResourceConfigMap() Calls Container.getContaineeMap( XTypes.CUSTOM_RESOURCE_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getDefaultAttributeValues(java.lang.String j2eeType) param j2eeType the j2eeType of any {@link AMXConfig} (all items having a group of {@link AMX#GROUP_CONFIG}. See {@link XTypes}. return a Map whose keys are the domain.xml names, and whose values are the default value for that attribute. Not all Attributes have default values available.
public java.util.Map	getEJBModuleConfigMap() return Map, keyed by name of {@link EJBModuleConfig}. see #getJ2EEApplicationConfigMap see #getWebModuleConfigMap see #getAppClientModuleConfigMap see #getRARModuleConfigMap see #getLifecycleModuleConfigMap see #getConnectorModuleConfigMap
public java.util.Map	getJ2EEApplicationConfigMap() return Map, keyed by name of {@link J2EEApplicationConfig} see #getEJBModuleConfigMap see #getWebModuleConfigMap see #getAppClientModuleConfigMap see #getRARModuleConfigMap see #getLifecycleModuleConfigMap see #getConnectorModuleConfigMap
public java.util.Map	getJDBCConnectionPoolConfigMap() Calls Container.getContaineeMap( XTypes.JDBC_CONNECTION_POOL_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getJDBCResourceConfigMap() Calls Container.getContaineeMap( XTypes.JDBC_RESOURCE_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getJNDIResourceConfigMap() Calls Container.getContaineeMap( XTypes.JNDI_RESOURCE_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getLBConfigMap() Calls Container.getContaineeMap( XTypes.LB_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getLifecycleModuleConfigMap() return Map, keyed by name of {@link LifecycleModuleConfig}. see #getJ2EEApplicationConfigMap see #getWebModuleConfigMap see #getEJBModuleConfigMap see #getRARModuleConfigMap see #getAppClientModuleConfigMap see #getConnectorModuleConfigMap
public java.util.Map	getLoadBalancerConfigMap() Calls Container.getContaineeMap( XTypes.LOAD_BALANCER_CONFIG). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.lang.String	getLocale()
public java.lang.String	getLogRoot()
public java.util.Map	getMailResourceConfigMap() Calls Container.getContaineeMap( XTypes.MAIL_RESOURCE_CONFIG ). return Map of s, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getNodeAgentConfigMap() Calls Container.getContaineeMap( XTypes.NODE_AGENT_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getPersistenceManagerFactoryResourceConfigMap() Calls Container.getContaineeMap( XTypes.PERSISTENCE_MANAGER_FACTORY_RESOURCE_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getRARModuleConfigMap() return Map, keyed by name of {@link RARModuleConfig}. see #getJ2EEApplicationConfigMap see #getWebModuleConfigMap see #getEJBModuleConfigMap see #getAppClientModuleConfigMap see #getLifecycleModuleConfigMap see #getConnectorModuleConfigMap
public java.util.Map	getResourceAdapterConfigMap() Calls Container.getContaineeMap( XTypes.RESOURCE_ADAPTER_CONFIG ). return Map of AMXs, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public ResourceConfig	getResourceConfig(java.lang.String name) Get a ResourceConfig of any kind. param name
public java.util.Map	getServerConfigMap() Combines the results of getStandaloneServerConfigMap() and getClusteredServerConfigMap(). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getStandaloneServerConfigMap() Calls Container.getContaineeMap( XTypes.STANDALONE_SERVER_CONFIG ). return Map of items, keyed by name. see com.sun.appserv.management.base.Container#getContaineeMap
public java.util.Map	getWebModuleConfigMap() return Map, keyed by name of {@link WebModuleConfig}. see #getJ2EEApplicationConfigMap see #getEJBModuleConfigMap see #getAppClientModuleConfigMap see #getRARModuleConfigMap see #getLifecycleModuleConfigMap see #getConnectorModuleConfigMap
public void	removeAdminObjectResourceConfig(java.lang.String jndiName) Removes an admin object resource. param jndiName JNDI name of the resource.
public void	removeClusterConfig(java.lang.String name) Remove an existing <cluster>. param name the name of the cluster to remove.
public void	removeClusteredServerConfig(java.lang.String name)
public void	removeConfigConfig(java.lang.String name) Remove a config. This will fail if any or refers to it. param name The config name.
public void	removeConnectorConnectionPoolConfig(java.lang.String name) Removes a connector connection pool. param name pool name.
public void	removeConnectorResourceConfig(java.lang.String jndiName) Removes a connector resource. param jndiName
public void	removeCustomMBeanConfig(java.lang.String name) Remove a CustomMBeanConfig. All references to it are also removed. Questions Are running MBeans first stopped? param name name as returned by {@link CustomMBeanConfig#getName}
public void	removeCustomResourceConfig(java.lang.String name) Removes a custom resource. param name The name of the custom resource.
public void	removeJDBCConnectionPoolConfig(java.lang.String jdbcConnectionPoolName) Remove the <jdbc-connection-pool>. param jdbcConnectionPoolName
public void	removeJDBCResourceConfig(java.lang.String jndiName) Removes a jdbc resource. param jndiName
public void	removeJNDIResourceConfig(java.lang.String jndiName) Remove the <external-jndi-resource>. param jndiName The jndi name of the external jndi resource to be removed.
public void	removeLBConfig(java.lang.String name) Removes a lb-config. param name The name of the load balancer configuration.
public void	removeLifecycleModuleConfig(java.lang.String name) Removes an existing lifecycle module. param name the name of the lifecycle module to be removed.
public void	removeLoadBalancerConfig(java.lang.String name) Remove an existing <LoadBalancerConfig>. param name the name of the load-balancer to remove.
public void	removeMailResourceConfig(java.lang.String jndiName) Removes a mail resource. param jndiName
public void	removePersistenceManagerFactoryResourceConfig(java.lang.String jndiName) Removes a persistence manager factory resource. param jndiName
public void	removeResourceAdapterConfig(java.lang.String resourceAdapterName)
public void	removeStandaloneServerConfig(java.lang.String name)
public void	setApplicationRoot(java.lang.String value)
public void	setLocale(java.lang.String value)
public void	setLogRoot(java.lang.String value)