Service

Identifier:

com.sodius.mdw.server.service

Description:

Enables to contribute services. A service is the declaration of an MDWorkbench ruleset that is executed on server side.

Configuration Markup:

<!ELEMENT extension (service*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT service ((rule | operation) , property* , launcherPage?)>

<!ATTLIST service

id CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #IMPLIED>

A service is the declaration of an MDWorkbench ruleset that is executed on server side.

id - a unique identifier for the service
name - a translatable name that will be used in the end-user display of this service.
description - a description to document the purpose of the service and to provide some hints to the user, if any.

<!ELEMENT rule (parameter*)>

<!ATTLIST rule

ruleSet CDATA #REQUIRED

rule CDATA #REQUIRED>

The main rule to launch

ruleSet - the qualified name of the ruleset (e.g. "foo.bar.MyRuleSet")
rule - the simple name of the rule (e.g. "main")

<!ELEMENT operation (parameter*)>

<!ATTLIST operation

class CDATA #REQUIRED>

The main operation to execute

class - the qualified name of the OperationFactory class that is in charge to instantiate the Operation to execute for this service

<!ELEMENT parameter (property*)>

<!ATTLIST parameter

name CDATA #REQUIRED

type CDATA #REQUIRED>

A parameter expected by the ruleset or the rule.

name - the name of the parameter.
type - the type of the parameter, which must match a Java class name.

<!ELEMENT property EMPTY>

<!ATTLIST property

name CDATA #REQUIRED

value CDATA #REQUIRED>

Defines a property to provide additional hint to the service or to a parameter. A property "password" with a value "true" shall be a set on a parameter to indicate the parameter is a password and its value should not be exposed in web pages nor in HTTP responses.

name - name of the property
value - value of the property

<!ELEMENT launcherPage EMPTY>

<!ATTLIST launcherPage

url CDATA #REQUIRED>

A custom web page to launch the service. If not set, the default service launch web page is used.

url - the relative URL (e.g. "/myExtension/myService") of a custom web page to launch the service.