Appendix
Appendix 1—OSC Property File Values
The following table is a complete list of all the valid property keys for the osc.properties file. Full descriptions of these properties and their meanings can be found elsewhere in this document. In most cases, default values should not need to be changed unless they are required.
Property Name | Value Type | Required | Default | Notes |
---|---|---|---|---|
cache.distributed.type | Class implementing Cache | No | com.oi.osc.cache.CoherenceCache | |
cache.local.type | Class implementing Cache | No | com.oi.osc.cache.LRUCache | |
cache.lru.<cache_name>.initSize | Integer | No | 100 | For a given LRU sub-cache, specify the initial size |
cache.lru.<cache_name>.maxSize | Integer | No | 1000 | For a given LRU sub-cache, specify the maximum size. |
factory.constructor | Class implementing IConstructor | No | com.oi.osc.constructor.FreeMarkerConstructor | |
factory.security | Class implementing ISecurityProvider | No | com.oi.osc.security.WalletSecurityProvider | |
freemarker.templateDir | String | Maybe | n/a | Required if loading templates from filesystem. Must specify full path to template directory. |
services.file | String | Yes | n/a | Must specify full path to service registry |
template.minReadInterval | Integer | No | 60000 | Value in milliseconds |
template.source | { file, db } | Yes | n/a | User must specify how templates will be loaded |
wallet.path | String | Maybe | n/a | If using the WalletSecurityProvider, this must specify a path to the Oracle Wallet file |
wallet.key | String | Maybe | n/a | If using the WalletSecurityProvider, this must specify the wallet password |
Appendix 2—Service Registry Tags
The following table is a complete list of all the possible service registry tags. Full descriptions of these tags and their meaning can be found elsewhere in this document.
All Node listings are relative to <Services>/<Service>.
The "Relevance" column" indicates when the tag is relevant to a service definition. The "Required" column then indicates when whether the tag is required in that particular case.
Node | Value Type | Relevance | Required | Notes |
---|---|---|---|---|
@id | String | All | Yes | Must be unique to the service registry |
@type | { soap, file, jms } | All | Yes | |
TemplateName | String | All | Yes | Must match a valid template file name or database key |
WSDLLocation | URL | SOAP | Yes | URL of the SOAP service's WSDL |
ServiceName | QName | SOAP | Yes | QName of the service to invoke |
ServicePort | QName | SOAP | Yes | QName of the service port to invoke |
ServiceLocation | URL | SOAP | No | Overrides value in WSDL |
SOAPAction | String | SOAP | No | Do not include this tag unless specifically required |
IgnoreResponse | Boolean | SOAP | No | |
Username | String | SOAP | No | |
PasswordKey | String | SOAP | No | |
SecurityType | { HTTP, XWSS } | SOAP | No | |
XWSSConfig | String | SOAP: XWSS | Yes | Path to XWSS policy file to apply to service |
Directory | String | File | Yes | Absolute path to directory for files |
FileNameType | { Random, Reference, Simple } | File | No | Defaults to Random |
FileName | String | File: reference, simple | No | Specifies a reference to a variable with the file name, or a reference to the file name itself, depending on FileNameType. |
ReplaceExisting | Boolean | File: reference, simple | No | Specifies whether to overwrite an existing file. Default is false. |
ConnectionFactory | String | JMS | Yes | JNDI name of JMS Connection Factory |
Destination | String | JMS | Yes | JNDI name of JMS Destination |
TimeToLive | Integer | JMS | No | Time to live, in seconds. 0 = unlimited. Default is 0. |
Priority | Integer [0-9] | JMS | No | Message priority, low to high. Default is 4. |
Appendix 3—OSC Extension Call Process