Management API Reference for subsystem=batch-jberet

Children (4)

• in-memory-job-repository
• jdbc-job-repository
• thread-factory
• thread-pool

Provided Capabilities (1)

Attributes (4)

• default-job-repository - The name of the default job repository.

  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" : "The name of the default job repository.", "attribute-group" : "environment", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.batch.job.repository", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• default-thread-pool - The name of the default thread-pool.

  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" : "The name of the default thread-pool.", "attribute-group" : "environment", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.batch.thread.pool", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• restart-jobs-on-resume - If set to true when a resume operation has been invoked after a suspend operation any jobs stopped during the suspend will be restarted. A value of false will leave the jobs in a stopped state.

  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?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If set to true when a resume operation has been invoked after a suspend operation any jobs stopped during the suspend will be restarted. A value of false will leave the jobs in a stopped state.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• security-domain - References the security domain for batch jobs. This can only be defined if the Elytron subsystem is available.

  Type	STRING
  Is the attribute nillable?	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" : "References the security domain for batch jobs. This can only be defined if the Elytron subsystem is available.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"elytron-security-domain-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

Operations (2)

• add - Adds the batch subsystem.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  restart-jobs-on-resume	BOOLEAN	false	true	true	If set to true when a resume operation has been invoked after a suspend operation any jobs stopped during the suspend will be restarted. A value of false will leave the jobs in a stopped state.
  security-domain	STRING	false	false		References the security domain for batch jobs. This can only be defined if the Elytron subsystem is available.
  default-job-repository	STRING	true	false		The name of the default job repository.
  default-thread-pool	STRING	true	false		The name of the default thread-pool.

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds the batch subsystem.", "request-properties" : { "restart-jobs-on-resume" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If set to true when a resume operation has been invoked after a suspend operation any jobs stopped during the suspend will be restarted. A value of false will leave the jobs in a stopped state.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" }, "security-domain" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "References the security domain for batch jobs. This can only be defined if the Elytron subsystem is available.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "default-job-repository" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the default job repository.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.batch.job.repository", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "default-thread-pool" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the default thread-pool.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.batch.thread.pool", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes the batch subsystem.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Removes the batch subsystem.", "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.batch-jberet

          
  <feature spec="subsystem.batch-jberet">
    <param name="default-job-repository" value="{value}"/>
    <param name="default-thread-pool" value="{value}"/>
    <param name="restart-jobs-on-resume" value="{value}"/>
    <param name="security-domain" value="{value}"/>
  <feature/>
          
        

  📋