Management API Reference for process-state-listener

Provided Capabilities (1)

Attributes (4)

• class - Class name of the listener.

  Type	STRING
  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" : "Class name of the listener.", "expressions-allowed" : false, "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 }

• module - Module Identifier of the listener.

  Type	STRING
  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" : "Module Identifier of the listener.", "expressions-allowed" : false, "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 }

• properties - Properties to initiate the process state listener.

  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?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to initiate the process state listener.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• timeout - Duration value before cancelling the execution of a listener.

  Type	INT
  Default Value	30
  Unit	SECONDS
  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" : "INT" }, "description" : "Duration value before cancelling the execution of a listener.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 30, "unit" : "SECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - Add the process-state-listener service.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  add-index	INT	false	false		Add the process-state-listener serviceat the specified index.
  class	STRING	true	false		Class name of the listener.
  module	STRING	true	false		Module Identifier of the listener.
  properties	OBJECT	false	true		Properties to initiate the process state listener.
  timeout	INT	false	true	30	Duration value before cancelling the execution of a listener.

  Raw DMR model

  { "operation-name" : "add", "description" : "Add the process-state-listener service.", "request-properties" : { "add-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Add the process-state-listener serviceat the specified index.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default" }, "class" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of the listener.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "module" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Module Identifier of the listener.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Properties to initiate the process state listener.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "timeout" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Duration value before cancelling the execution of a listener.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 30, "unit" : "SECONDS", "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Remove the process-state-listener service.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove the process-state-listener service.", "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.core-management.process-state-listener

          
  <feature spec="subsystem.core-management.process-state-listener">
    <param name="process-state-listener" value="{resource name}"/>
    <param name="add-index" value="{value}"/>
    <param name="class" value="{value}"/>
    <param name="module" value="{value}"/>
    <param name="properties" value="{value}"/>
    <param name="timeout" value="{value}"/>
  <feature/>
          
        

  📋