Management API Reference for core-service=module-loading

Attributes (1)

• module-roots - A list of filesystem locations under which the module loading system looks for modules, arranged in order of precedence.
  Deprecated Since 1.4.0

  Experimental and unsupported.

  Type	LIST
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of filesystem locations under which the module loading system looks for modules, arranged in order of precedence.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "1.4.0", "reason" : "Experimental and unsupported." }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (2)

• list-resource-loader-paths - Provides a list of filesystem paths of the module, if there are any and the module loader exposes them.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  module	STRING	true	false		The identifier of the module, in [:] format. If the slot is not provided, a value of "main" is assumed.

  Reply properties

  A list, each of whose elements is a filesystem location from which the module can load resources.

  Type

  LIST

  Value Type

  
  STRING

  Raw DMR model

  { "operation-name" : "list-resource-loader-paths", "description" : "Provides a list of filesystem paths of the module, if there are any and the module loader exposes them.", "request-properties" : {"module" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The identifier of the module, in [:] format. If the slot is not provided, a value of \"main\" is assumed.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }}, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A list, each of whose elements is a filesystem location from which the module can load resources." }, "stability" : "default", "read-only" : true, "runtime-only" : true }

• module-info - Displays information about modules in running system

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  name	STRING	true	false		Module name
  slot	STRING	false	false	main	Module slot

  Reply properties

  A module information with its dependencies

  Type

  OBJECT

  Value Type

  
  {
      "name" => {
          "type" => STRING,
          "description" => "Module name",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "min-length" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      },
      "main-class" => {
          "type" => STRING,
          "description" => "Main class of the module",
          "expressions-allowed" => false,
          "required" => false,
          "nillable" => true,
          "min-length" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      },
      "fallback-loader" => {
          "type" => STRING,
          "description" => "Main class of the module",
          "expressions-allowed" => false,
          "required" => false,
          "nillable" => true,
          "min-length" => 1,
          "max-length" => 2147483647,
          "stability" => "default"
      },
      "dependencies" => {
          "type" => LIST,
          "description" => "List of module dependencies",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "min-length" => 0,
          "max-length" => 2147483647,
          "stability" => "default",
          "value-type" => {
              "dependency-name" => {
                  "type" => STRING,
                  "description" => "Name of the dependency",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "min-length" => 1,
                  "max-length" => 2147483647,
                  "stability" => "default"
              },
              "module-name" => {
                  "type" => STRING,
                  "description" => "Module name of dependency",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "min-length" => 1,
                  "max-length" => 2147483647,
                  "stability" => "default"
              },
              "export-filter" => {
                  "type" => STRING,
                  "description" => "Export filter",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "min-length" => 1,
                  "max-length" => 2147483647,
                  "stability" => "default"
              },
              "import-filter" => {
                  "type" => STRING,
                  "description" => "Import filter",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "min-length" => 1,
                  "max-length" => 2147483647,
                  "stability" => "default"
              },
              "optional" => {
                  "type" => BOOLEAN,
                  "description" => "Is dependency optional",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "stability" => "default"
              },
              "local-loader-class" => {
                  "type" => STRING,
                  "description" => "Class name of local loader",
                  "expressions-allowed" => false,
                  "required" => false,
                  "nillable" => true,
                  "min-length" => 1,
                  "max-length" => 2147483647,
                  "stability" => "default"
              },
              "local-loader-paths" => {
                  "type" => LIST,
                  "description" => "List of local loader paths",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "min-length" => 0,
                  "max-length" => 2147483647,
                  "stability" => "default",
                  "value-type" => STRING
              }
          }
      },
      "resource-loaders" => {
          "type" => LIST,
          "description" => "Resource loaders",
          "expressions-allowed" => false,
          "required" => true,
          "nillable" => false,
          "min-length" => 0,
          "max-length" => 2147483647,
          "stability" => "default",
          "value-type" => {
              "type" => {
                  "type" => STRING,
                  "description" => "Type of resource loader",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "min-length" => 1,
                  "max-length" => 2147483647,
                  "stability" => "default"
              },
              "paths" => {
                  "type" => LIST,
                  "description" => "Resource loader paths",
                  "expressions-allowed" => false,
                  "required" => true,
                  "nillable" => false,
                  "min-length" => 0,
                  "max-length" => 2147483647,
                  "stability" => "default",
                  "value-type" => STRING
              }
          }
      }
  }

  Raw DMR model

  { "operation-name" : "module-info", "description" : "Displays information about modules in running system", "request-properties" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Module name", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "slot" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Module slot", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "main", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Module name", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "main-class" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Main class of the module", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "fallback-loader" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Main class of the module", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "dependencies" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of module dependencies", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "dependency-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the dependency", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "module-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Module name of dependency", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "export-filter" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Export filter", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "import-filter" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Import filter", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "optional" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Is dependency optional", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default" }, "local-loader-class" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of local loader", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "local-loader-paths" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of local loader paths", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } } }, "resource-loaders" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Resource loaders", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Type of resource loader", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "paths" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Resource loader paths", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } } } }, "description" : "A module information with its dependencies" }, "stability" : "default", "read-only" : true, "runtime-only" : true }