Management API Reference for timer

Attributes (8)

• active - Indicates whether this timer is active or suspended.

  Type	BOOLEAN
  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 this timer is active or suspended.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• calendar-timer - Whether this timer is a calendar-based timer, or "undefined" if the timer has expired or been cancelled.

  Type	BOOLEAN
  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" : "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", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• info - Serializable information associated with timer.

  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" : "Serializable information associated with timer.", "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 }

• next-timeout - 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.

  Type	LONG
  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" : "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", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• persistent - Whether this timer has persistent semantics or "undefined" if the timer has expired or been cancelled.

  Type	BOOLEAN
  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" : "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", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• primary-key - Primary key of Jakarta Enterprise Beans instance which started the timer.
  Deprecated Since 9.0.0

  Deprecated since entity beans are no longer supported.

  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" : "Primary key of Jakarta Enterprise Beans instance which started the timer.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "9.0.0", "reason" : "Deprecated since entity beans are no longer supported." }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• schedule - 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.

  Type	OBJECT
  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" : "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" : "configuration", "restart-required" : null, "capability-reference" : null }

• time-remaining - 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.

  Type	LONG
  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" : "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", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (4)

• activate - Activates timer after it has been suspended.

  Raw DMR model

  { "operation-name" : "activate", "description" : "Activates timer after it has been suspended.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• cancel - Cancels timer and removes it from container.

  Raw DMR model

  { "operation-name" : "cancel", "description" : "Cancels timer and removes it from container.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• suspend - Suspends timer. No timeout will occur after this operation has been invoked. To reanimate timer, 'activate' operation is present.

  Raw DMR model

  { "operation-name" : "suspend", "description" : "Suspends timer. No timeout will occur after this operation has been invoked. To reanimate timer, 'activate' operation is present.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• trigger - Triggers timer timeout method prematurely.

  Raw DMR model

  { "operation-name" : "trigger", "description" : "Triggers timer timeout method prematurely.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }