Management API Reference for admin-objects

Children (1)

• config-properties

Attributes (4)

• class-name - Specifies the fully qualified class name of an administration object.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the fully qualified class name of an administration object.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• enabled - Specifies if the administration object should be enabled.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the administration object should be enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• jndi-name - Specifies the JNDI name for the administration object.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the JNDI name for the administration object.", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• use-java-context - Setting this to false will bind the object into global JNDI.

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Setting this to false will bind the object into global JNDI.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - Add an administration object.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  class-name	STRING	true	true		Specifies the fully qualified class name of an administration object.
  enabled	BOOLEAN	false	true	true	Specifies if the administration object should be enabled.
  jndi-name	STRING	true	true		Specifies the JNDI name for the administration object.
  use-java-context	BOOLEAN	false	true	true	Setting this to false will bind the object into global JNDI.

  Raw DMR model

  { "operation-name" : "add", "description" : "Add an administration object.", "request-properties" : { "class-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the fully qualified class name of an administration object.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Specifies if the administration object should be enabled.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "jndi-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specifies the JNDI name for the administration object.", "expressions-allowed" : true, "required" : true, "nillable" : false, "stability" : "default" }, "use-java-context" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Setting this to false will bind the object into global JNDI.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Remove the administration object.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove the administration object.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.resource-adapters.resource-adapter.admin-objects

          
  <feature spec="subsystem.resource-adapters.resource-adapter.admin-objects">
    <param name="admin-objects" value="{resource name}"/>
    <param name="resource-adapter" value="{resource name}"/>
    <param name="class-name" value="{value}"/>
    <param name="enabled" value="{value}"/>
    <param name="jndi-name" value="{value}"/>
    <param name="use-java-context" value="{value}"/>
  <feature/>
          
        

  📋