Base class of Service Definitions.
A service definition represents configuration that is shared across all Service instances.
Deprecated:
This class is only used with the deprecated ServiceRegistry. Use the LocalServiceRegistry instead, which allows configuration on the Service directly.
Warning
API Version:
No longer available as of version 19.10.
Note
FTPServiceDefinition, HTTPFormServiceDefinition, HTTPServiceDefinition, SOAPServiceDefinition
| Property | Description |
|---|---|
configuration: ServiceConfig (read-only) | Returns the Service Configuration stored in the database. |
| mock: Boolean | Returns the status of whether mock mode is enabled for all instances of this definition. |
serviceName: String (read-only) | Returns the name of this service. |
| throwOnError: Boolean | Returns the status of whether the shared throwOnError flag is set. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| configure(Object) | Register a callback to handle custom portions of the service. |
| getConfiguration() | Returns the Service Configuration stored in the database. |
| getServiceName() | Returns the name of this service. |
| isMock() | Returns the status of whether mock mode is enabled for all instances of this definition. |
| isThrowOnError() | Returns the status of whether the shared throwOnError flag is set. |
| setMock() | Sets the mock mode for all Service instances that use this definition. |
| setThrowOnError() | Sets the throwOnError flag to true for all Service instances that use this definition. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns the Service Configuration stored in the database.
Returns the status of whether mock mode is enabled for all instances of this definition.
(read-only)Returns the name of this service.
Returns the status of whether the shared throwOnError flag is set.
Register a callback to handle custom portions of the service.
This callback may declare multiple methods:
1{
2 initServiceClient: function() {
3 // Create and return the internal service client object.
4 // This is usually optional, except in the case of SOAP services.
5 },
6
7 // svc is the call-specific Service instance. For example, it may be an HTTPService or FTPService.
8 // params are the arguments passed to the call method (if any).
9 createRequest: function(svc:Service, params) {
10 // Perform any required call-time configuration.
11 // Optionally return a Service-specific object
12 },
13
14 // svc is the call-specific Service instance.
15 // arg is the output of createRequest.
16 execute: function(svc:Service, arg:Object) {
17 // Execute the service call and return a result
18 // This method is not used by default for HTTP-related services unless executeOverride is set.
19 },
20
21 // Use the execute function if it is present. This is only required to use the functionality with HTTP services.
22 executeOverride: true,
23
24 // svc is the call-specific Service instance.
25 // response is the output of execute.
26 parseResponse: function(svc:Service, response: Object) {
27 // Process the response object as needed.
28 // The return value of this method will be the return value of the outer call method.
29 },
30
31 // svc is the call-specific Service instance.
32 // arg is the output of createRequest.
33 mockCall: function(svc:Service, arg:Object) {
34 // This method takes the place of the 'execute' phase when mocking is enabled.
35 // Note initServiceClient, createRequest, and parseResponse still invoked.
36 },
37
38 // svc is the call-specific Service instance.
39 // params are the arguments passed to the call method (if any).
40 mockFull: function(svc:Service, params) {
41 // This method takes the place of the entire service call when mocking is enabled.
42 // No other callbacks are invoked. The output of this method becomes the output of call.
43 }
44
45}Parameters:
Returns:
Returns the Service Configuration stored in the database.
Returns:
Returns the name of this service.
Returns:
Returns the status of whether mock mode is enabled for all instances of this definition.
Returns:
Returns the status of whether the shared throwOnError flag is set.
Returns:
Sets the mock mode for all Service instances that use this definition.
Returns:
Sets the throwOnError flag to true for all Service instances that use this definition.
Returns:
j