zosConnectService - z/OS Connect Endpoint (zosConnectService)

Defines the configuration settings for a service endpoint.

NameTypeDefaultDescription
idstringA unique configuration ID.
serviceNamestringName that is associated with a service endpoint. This name identifies a service endpoint to a client.
serviceRefA reference to top level localAdaptersConnectService element (string).Reference name that identifies the service endpoint that is registered with z/OS Connect.
serviceDescriptionstringDescription that is associated with a service endpoint.
serviceGroupingNamestringName that can be used to group or associate a set of service endpoints together.
runGlobalInterceptorsbooleantrueIndicates whether global interceptors should run for requests associated with a service endpoint. By default z/OS Connect processes all global and service endpoint specific interceptors .
invokeURIstringURI or list of comma-separated URIs to associate with a service endpoint. InvokeURIs can end with a wildcard character in the form /a/b/* or x/y* to generically match a service endpoint invocation. Specifying multiple wildcard characters (i.e. /a/b/**) or wildcard characters in the middle of the requestURI (i.e. /a/*/c) is not supported. If service endpoints with configured invokeURIs using the wildcard character are associated with overlapping invokeURIs, the service endpoint associated with the most specific invokeURI is matched. For instance, if a service endpoint request is issued with the following: https://host:port/a/b/c going to a server with the following configuration: service1 -> invokeURI="/a/b/c/*" and service2 -> invokeURI="/a/b/*", z/OS Connect will match the request to service1. Configured invokeURI entries must start with the / character. The use of an invokeURI is equivalent to a service request where the action=invoke query parameter is specified.
adminGroupstringAdministrative group name that is associated with a service endpoint. It is the name of the security group that the user needs to be in before administrative functions are permitted. If it is configured along with its global counterpart globalAdminGroup that is defined under element zosConnectManager, the value defined under adminGroup is used.
operationsGroupstringOperations group name that is associated with a service endpoint. It is the name of the security group that the user needs to be in before operations such as start, stop, or status is permitted. If it is configured along with its global counterpart, globalOperationsGroupdefined under element zosConnectManager, the value defined under operationsGroup is used.
invokeGroupstringInvoke group name that is associated with a service endpoint. It contains the name of the security group that the user needs to be in before invoke calls are permitted. If it is configured along with its global counterpart globalInvokeGroup that is defined under element zosConnectManager, the value defined under invokeGroup is used.
dataXformRefA reference to top level zosConnectDataXform element (string).Reference name that identifies the data transformation handler that is associated with a service endpoint. If configured along with its global data transformation handler counterpart globalDataXformRef that is defined under element zosConnectManager, the data transformer defined for the service endpoint is used.
serviceAsyncRequestTimeoutA period of time with millisecond precisionTimeout value that is associated with a service endpoint when processing asynchronous work. It specifies the time in milliseconds in which requests have to complete. This timeout value overrides the web container's asyncTimeoutDefault attribute value. If neither asyncRequestTimeout nor asyncTimeoutDefault are configured, the timeout used is the asyncTimeoutDefault attribute default value (i.e. 30 seconds). If asyncRequestTimeout is not configured, but the asyncTimeoutDefault attribute is, the asyncTimeoutDefault's configured value is used. If configured along with its global counterpart: asyncRequestTimeout defined under element zosConnectManager, the value defined under serviceAsyncRequestTimeout is used. A timeout may occur at any time during z/OS Connect's processing of the request. The request may still be active after the timeout is detected and a response is sent to the client. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
requireSecurebooleanIndicates if requests associated with a service endpoint must be made by using the secure HTTPS channel. If it is configured along with its global counterpart requireSecure that is defined under the zosConnectManager element, the value defined for the service endpoint is used.
requireAuthbooleanIndicates if users must provide security credentials in order for z/OS Connect to process requests associated with a service endpoint. If it is configured along with its global counterpart requireAuth that is defined under the zosConnectManager element, the value defined for the service enpoint is used.

interceptorsRef

Reference name that identifies the set of configured interceptors that is associated with a service endpoint. If it is configured along with its global interceptors counterpart globalInterceptorsRef that is defined under the zosConnectManager element, z/OS Connect processes both sets of interceptors. If the runGlobalInterceptors attribute for the service endpoint is set to false, z/OS connect will only process the set of interceptors configured for the service endpoint.