Management API Reference for message-driven-bean

Message driven bean component included in the deployment.

Children (1)

service
- timer-service

Attributes (23)

activation-config - The expected configuration properties of the message-driven bean in its operational environment.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The expected configuration properties of the message-driven bean in its operational environment.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

component-class-name - The component's class name.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The component's class name.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

declared-roles - The roles declared (via @DeclareRoles) on this Jakarta Enterprise Beans component.

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The roles declared (via @DeclareRoles) on this Jakarta Enterprise Beans component.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

delivery-active - Indicates whether messages are delivered to this message-driven bean.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether messages are delivered to this message-driven bean.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

execution-time - Time spend within a bean method.

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Time spend within a bean method.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

invocations - Number of invocations processed.

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Number of invocations processed.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

message-destination-link - Used to link the message-driven bean to a message destination.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Used to link the message-driven bean to a message destination.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

message-destination-type - The type of the message destination.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of the message destination.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

messaging-type - The message listener interface of the message-driven bean.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The message listener interface of the message-driven bean.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

methods - Invocation metrics per method.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Invocation metrics per method.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "execution-time" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Time spend within this bean method.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "invocations" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Number of invocations processed.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "wait-time" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Time spend waiting to obtain an instance.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" } }, "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

peak-concurrent-invocations - Peak concurrent invocations.

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Peak concurrent invocations.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

pool-available-count - The number of available (i.e. not in use) instances in the pool.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of available (i.e. not in use) instances in the pool.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

pool-create-count - The number of bean instances that have been created.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of bean instances that have been created.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

pool-current-size - The current size of the pool.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The current size of the pool.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

pool-max-size - The maximum size of the pool.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum size of the pool.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-write", "storage" : "runtime", "restart-required" : "no-services", "capability-reference" : null }`

pool-name - The name of the pool.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the pool.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

pool-remove-count - The number of bean instances that have been removed.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of bean instances that have been removed.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

run-as-role - The run-as role (if any) for this Jakarta Enterprise Beans component.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The run-as role (if any) for this Jakarta Enterprise Beans component.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

security-domain - The security domain for this Jakarta Enterprise Beans component.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The security domain for this Jakarta Enterprise Beans component.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

timeout-method - The timeout method for handling programmatically created timers.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The timeout method for handling programmatically created timers.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

timers - Jakarta Enterprise Beans timers associated with the component.

Type	LIST
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Jakarta Enterprise Beans timers associated with the component.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "time-remaining" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The number of milliseconds that will elapse before the next scheduled timer expiration, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "next-timeout" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The point in time (in ms since the epoch) at which the next timer expiration is scheduled to occur, or \"undefined\" if the timer has no future timeouts, is expired, or has been cancelled.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "calendar-timer" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether this timer is a calendar-based timer, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "persistent" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether this timer has persistent semantics, or \"undefined\" if the timer has expired or been cancelled.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "info" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Serializable information associated with timer.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "schedule" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The schedule expression corresponding to this timer, or \"undefined\" if the timer was not created using a schedule expression, is expired, or has been cancelled.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "year" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A particular calendar year.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "month" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "One or more months within a year.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "day-of-month" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "One or more days within a month.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "day-of-week" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "One or more days within a week.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "hour" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "One or more hours within a day.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "minute" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "One or more minutes within an hour.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "second" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "One or more seconds within a minute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "timezone" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A non-default time zone in whose context the schedule specification is to be evaluated.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "start" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The start date for the timer, in ms since the epoch.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "end" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The end date for the timer, in ms since the epoch.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" } } } }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

transaction-type - The transaction management type of the Jakarta Enterprise Beans component (Container or Bean).

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The transaction management type of the Jakarta Enterprise Beans component (Container or Bean).", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

wait-time - Time spend waiting to obtain an instance.

Type	LONG
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Time spend waiting to obtain an instance.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (2)

start-delivery - Start delivering messages to this message-driven bean.

Raw DMR model


{
    "operation-name" : "start-delivery",
    "description" : "Start delivering messages to this message-driven bean.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

stop-delivery - Stop delivering messages to this message-driven bean.

Raw DMR model


{
    "operation-name" : "stop-delivery",
    "description" : "Stop delivering messages to this message-driven bean.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}