awe Services Schema
Generated from services.xsd. It includes general.xsd.
This Schema defines the way an awe Services file must be structured
6 elements, 26 declared attributes (2 documented).
Elements​
Elements: services, service, java, microservice, rest, service-parameter
services​
Type: servicesType
Contains: service (0..n)
Contained by: none (document root)
Attributes: none
service​
Type: serviceType
Contains: java (0..1), microservice (0..1), rest (0..1)
Contained by: services
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | yes | Not documented yet | |
launch-phase | APPLICATION_START, APPLICATION_END, CLIENT_START, CLIENT_END | no | Not documented yet | |
permission | string | no | Permissions of the catalog (Permissions.xml) required to launch the service from a client action, separated by spaces: all of them are required. An unknown permission, or a permission on a service authorized by its target, is a load error. Server-side calls, the services of queries and maintains of type service and the services of a launch phase are never checked. | |
authorization | target | no | How a launch of the service from a client action is authorized. target: the service launches the query or the maintain target the client asks for, and that target is checked instead of the service. |
java​
Type: javaType
Contains: service-parameter (0..n)
Contained by: service
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
classname | string | yes | Not documented yet | |
method | string | yes | Not documented yet | |
qualifier | string | no | Not documented yet |
microservice​
Type: microserviceType
Contains: service-parameter (0..n)
Contained by: service
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | yes | Not documented yet | |
endpoint | string | yes | Not documented yet | |
method | GET, POST, PUT, DELETE | yes | Not documented yet | |
wrapper | string | no | Not documented yet | |
content-type | JSON, URLENCODED | no | Not documented yet |
rest​
Type: restType
Contains: service-parameter (0..n)
Contained by: service
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
server | string | no | Not documented yet | |
endpoint | string | yes | Not documented yet | |
method | GET, POST, PUT, DELETE | yes | Not documented yet | |
wrapper | string | no | Not documented yet | |
content-type | JSON, URLENCODED | no | Not documented yet |
service-parameter​
Type: serviceParameterType
Contains: no child elements
Contained by: java, microservice, rest
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | no | Not documented yet | |
type | serviceVariableRestriction (12 values) | yes | Not documented yet | |
value | string | no | Not documented yet | |
list | true, false | no | Not documented yet | |
bean-class | string | no | Not documented yet |
Simple types​
serviceAuthorizationEnum​
Base type: string
Allowed values: target
launchPhaseEnum​
Base type: string
Allowed values: APPLICATION_START, APPLICATION_END, CLIENT_START, CLIENT_END
methodEnum​
Base type: string
Allowed values: GET, POST, PUT, DELETE
contentTypeEnum​
Base type: string
Allowed values: JSON, URLENCODED