org.glassfish.admin.amx.config

Interface AMXConfigProxy

All Superinterfaces:

AMX_SPI, AMXProxy, AttributeResolver

Deprecated.

Extending this proxy interface implies that the class is part of the MBean API for configuration, that the interface is a dynamic proxy to a config MBean.

Note that considerable metadata is available for config MBeans, via MBeanInfo.getDescriptor().

@Taxonomy(stability=UNCOMMITTED)
 @Deprecated
public interface AMXConfigProxy
extends AMXProxy, AttributeResolver

See Also:

AMXProxy, AMXConfigConstants

Method Summary

Modifier and Type	Method and Description
AMXConfigProxy	createChild(String childType, Map<String,Object> params) Deprecated. Generic creation of an AMXConfigProxy based on the desired XML element type, which must be legitimate for the containing element.
AMXConfigProxy[]	createChildren(Map<String,Map<String,Object>[]> childrenMaps, Map<String,Object> attrs) Deprecated. Create one or more children of any type(s).
Map<String,String>	getDefaultValues(boolean useAMXAttributeName) Deprecated. Return a Map of default values for this MBean.
Map<String,String>	getDefaultValues(String type, boolean useAMXAttributeName) Deprecated. Return a Map of default values for the specified child type.
ObjectName	removeChild(String childType) Deprecated. Generically remove a config by type (child must be a singleton)
ObjectName	removeChild(String childType, String name) Deprecated. Remove a config by type and name.
AttributeList	setAttributesTransactionally(AttributeList attrs) Deprecated. Direct access to the MBeanServer, calls conn.setAttributes(objectName, attrs).

Methods inherited from interface org.glassfish.admin.amx.core.AMXProxy

as, attributeNames, attributesMap, attributesMap, child, child, childrenMap, childrenMap, childrenMaps, childrenSet, extra, invokeOp, invokeOp, java, nameProp, objectName, parent, parentPath, path, type, valid

Methods inherited from interface org.glassfish.admin.amx.core.AMX_SPI

getChildren, getName, getParent

Methods inherited from interface org.glassfish.admin.amx.config.AttributeResolver

resolveAttribute, resolveAttributes, resolveAttributeValue, resolveBoolean, resolveLong

Method Detail

getDefaultValues

@ManagedOperation(impact=0)
 @Description(value="Get the default values for child type")
Map<String,String> getDefaultValues(@Param(name="type")
                                                                                                                             String type,
                                                                                                                             @Param(name="useAMXAttributeName") @Description(value="true to use Attribute names, false to use XML names")
                                                                                                                             boolean useAMXAttributeName)

Deprecated.

Return a Map of default values for the specified child type. The resulting Map is keyed by the attribute name, either the AMX attribute name or the xml attribute name.

Parameters:

type - the J2EEType of the child

useAMXAttributeName - whether to key the values by the the AMX Attribute name or XML attribute name

Since:

Glassfish V3.

getDefaultValues

@ManagedOperation(impact=0)
 @Description(value="Get the available default values")
Map<String,String> getDefaultValues(@Param(name="useAMXAttributeName") @Description(value="true to use Attribute names, false to use XML names")
                                                                                                                        boolean useAMXAttributeName)

Deprecated.

Return a Map of default values for this MBean.

Parameters:

useAMXAttributeName - whether to key the values by the XML attribute name vs the AMX Attribute name

createChild

@ManagedOperation
 @Description(value="Create a child of the specified type")
AMXConfigProxy createChild(@Param(name="childType")
                                                                                                         String childType,
                                                                                                         @Param(name="params") @Description(value="name/value pairs for attributes")
                                                                                                         Map<String,Object> params)

Deprecated.

Generic creation of an AMXConfigProxy based on the desired XML element type, which must be legitimate for the containing element.

Required attributes must be specified, and should all be 'String' (The Map value is declared with a type of of 'Object' anticipating future extensions). Use the ATTR_NAME key for the name.

Parameters:

childType - the XML element type

params - Map containing attributes which are required by the @Configured and any optional attributes (as desired).

Returns:

proxy interface to the newly-created AMXConfigProxy

createChildren

@ManagedOperation
AMXConfigProxy[] createChildren(@Param(name="childrenMaps") @Description(value="Keyed by type, then one Map per child of that type, with each map containing name/value pairs for attributes")
                                                  Map<String,Map<String,Object>[]> childrenMaps,
                                                  @Param(name="attrs") @Description(value="Attributes to be set on the parent element")
                                                  Map<String,Object> attrs)

Deprecated.

Create one or more children of any type(s). Outer map is keyed by type. Inner maps are the attributes of each child. At the same time, attributes can be set on the parent element via 'attrs'. The entire operation is transactional (all or none).

removeChild

@ManagedOperation
ObjectName removeChild(@Param(name="childType")
                                         String childType,
                                         @Param(name="name")
                                         String name)

Deprecated.

Remove a config by type and name.

Parameters:

childType - the AMX j2eeType as defined

name - the name of the child

Returns:

the ObjectName of the removed child, or null if not found

removeChild

@ManagedOperation
ObjectName removeChild(@Param(name="childType")
                                         String childType)

Deprecated.

Generically remove a config by type (child must be a singleton)

Parameters:

childType - the AMX j2eeType as defined

Returns:

the ObjectName of the removed child, or null if not found

setAttributesTransactionally

@ManagedOperation
AttributeList setAttributesTransactionally(@Param(name="attrs")
                                                             AttributeList attrs)
                                                      throws Exception

Deprecated.

Direct access to the MBeanServer, calls conn.setAttributes(objectName, attrs). Unlike StdAttributesAccess.setAttributes(javax.management.AttributeList), this method throws a generic Exception if there is a transaction failure.

Throws:

Exception