Management API Reference for binding

JNDI bindings for primitive types

Stability Level: default

Attributes (8)

binding-type - The type of binding to create, may be simple, lookup, external-context or object-factory

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	lookup object-factory simple external-context
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of binding to create, may be simple, lookup, external-context or object-factory", "expressions-allowed" : false, "required" : true, "nillable" : false, "allowed" : [ "simple", "object-factory", "lookup", "external-context" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

cache - If the external context should be cached

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If the external context should be cached", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

class - The object factory class name for object factory bindings

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The object factory class name for object factory bindings", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

environment - The environment to use on object factory instance retrieval

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The environment to use on object factory instance retrieval", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

lookup - The entry to lookup in JNDI for lookup bindings

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The entry to lookup in JNDI for lookup bindings", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

module - The module to load the object factory from for object factory bindings

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The module to load the object factory from for object factory bindings", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

type - The type of the value to bind for simple bindings, this must be a primitive type

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	java.lang.Float java.lang.Double double byte java.net.URL float java.lang.Integer int long boolean java.lang.Character java.lang.Long java.lang.Short char short java.lang.Boolean java.lang.String java.lang.Byte
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the value to bind for simple bindings, this must be a primitive type", "expressions-allowed" : true, "required" : false, "nillable" : true, "allowed" : [ "int", "short", "java.lang.Long", "double", "java.lang.Integer", "char", "java.lang.Float", "java.lang.Boolean", "byte", "java.lang.Short", "java.lang.Character", "java.lang.String", "java.lang.Byte", "long", "float", "java.net.URL", "boolean", "java.lang.Double" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

value - The value to bind for simple bindings

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The value to bind for simple bindings", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (3)

add - Adds a JNDI binding

Request Parameter	Type	Required	Expressions Allowed	Description
binding-type	STRING	true	false	The type of binding to create, may be simple, lookup, external-context or object-factory
cache	BOOLEAN	false	true	If the external context should be cached
class	STRING	false	true	The object factory class name for object factory bindings
environment	OBJECT	false	true	The environment to use on object factory instance retrieval
lookup	STRING	false	true	The entry to lookup in JNDI for lookup bindings
module	STRING	false	true	The module to load the object factory from for object factory bindings
type	STRING	false	true	The type of the value to bind for simple bindings, this must be a primitive type
value	STRING	false	true	The value to bind for simple bindings

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a JNDI binding",
    "request-properties" : {
        "binding-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of binding to create, may be simple, lookup, external-context or object-factory",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "allowed" : [
                "simple",
                "object-factory",
                "lookup",
                "external-context"
            ],
            "stability" : "default"
        },
        "cache" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If the external context should be cached",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The object factory class name for object factory bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "environment" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The environment to use on object factory instance retrieval",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "lookup" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The entry to lookup in JNDI for lookup bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module to load the object factory from for object factory bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of the value to bind for simple bindings, this must be a primitive type",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "int",
                "short",
                "java.lang.Long",
                "double",
                "java.lang.Integer",
                "char",
                "java.lang.Float",
                "java.lang.Boolean",
                "byte",
                "java.lang.Short",
                "java.lang.Character",
                "java.lang.String",
                "java.lang.Byte",
                "long",
                "float",
                "java.net.URL",
                "boolean",
                "java.lang.Double"
            ],
            "stability" : "default"
        },
        "value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The value to bind for simple bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

rebind - Modifies the resource binding at runtime, this works with most binding types except for external-context

Request Parameter	Type	Required	Expressions Allowed	Description
binding-type	STRING	true	false	The type of binding to create, may be simple, lookup or object-factory
type	STRING	false	true	The type of the value to bind for simple bindings, this must be a primitive type
value	STRING	false	true	The value to bind for simple bindings
class	STRING	false	true	The object factory class name for object factory bindings
module	STRING	false	true	The module to load the object factory from for object factory bindings
lookup	STRING	false	true	The entry to lookup in JNDI for lookup bindings
environment	OBJECT	false	true	The environment to use on object factory instance retrieval

Raw DMR model


{
    "operation-name" : "rebind",
    "description" : "Modifies the resource binding at runtime, this works with most binding types except for external-context",
    "request-properties" : {
        "binding-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of binding to create, may be simple, lookup or object-factory",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "allowed" : [
                "simple",
                "object-factory",
                "lookup"
            ],
            "stability" : "default"
        },
        "type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of the value to bind for simple bindings, this must be a primitive type",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "int",
                "short",
                "java.lang.Long",
                "double",
                "java.lang.Integer",
                "char",
                "java.lang.Float",
                "java.lang.Boolean",
                "byte",
                "java.lang.Short",
                "java.lang.Character",
                "java.lang.String",
                "java.lang.Byte",
                "long",
                "float",
                "java.net.URL",
                "boolean",
                "java.lang.Double"
            ],
            "stability" : "default"
        },
        "value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The value to bind for simple bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The object factory class name for object factory bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module to load the object factory from for object factory bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "lookup" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The entry to lookup in JNDI for lookup bindings",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "environment" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The environment to use on object factory instance retrieval",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a JNDI binding

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a JNDI binding",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

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

subsystem.naming.binding

        
<feature spec="subsystem.naming.binding">
  <param name="binding" value="{resource name}"/>
  <param name="binding-type" value="{value}"/>
  <param name="cache" value="{value}"/>
  <param name="class" value="{value}"/>
  <param name="environment" value="{value}"/>
  <param name="lookup" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="type" value="{value}"/>
  <param name="value" value="{value}"/>
<feature/>