public final class ServiceControllerConstants
extends java.lang.Object
Defines the set of property keys to be used when registering a ServiceController
with
the OSGI framework.
Properties provide z/OS Connect the information needed for managing the service being registered.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADMIN_GROUP
The name of the security group that the user needs to be in before administrative functions for the service are permitted.
|
static java.lang.String |
ASYNC_REQ_TIMEOUT
Specifies the time in milliseconds in which requests for the service have to complete.
|
static java.lang.String |
INVOKE_GROUP
The name of the security group that the user needs to be in before invoke (call) functions are to be permitted.
|
static java.lang.String |
INVOKE_URI
Specifies a request URI string to use for matching a service invocation.
|
static java.lang.String |
OPS_GROUP
The name of the security group that the user needs to be in before operations, such as start, stop, or status for the service are permitted.
|
static java.lang.String |
REQUIRE_AUTH
Specifies whether calls to this service require the user to authenticate before
the call is processed.
|
static java.lang.String |
REQUIRE_SECURE
Specifies whether calls to this service require need to come in over HTTPS.
|
static java.lang.String |
RUN_GLOBALINTERCEPTORS
Directs z/OS Connect to process the global interceptors if they are configured to run globally through in the
server's configuration file.
|
static java.lang.String |
SERVICE_DESCRIPTION
The service description.
|
static java.lang.String |
SERVICE_GROUPING_NAME
The name of the group to associate with this service.
|
static java.lang.String |
SERVICE_NAME
The name to be associated with the service.
|
Constructor and Description |
---|
ServiceControllerConstants() |
public static final java.lang.String SERVICE_NAME
The name to be associated with the service. This name is what identifies a service registered with z/OS Connect to a client performing a HTTP request.
A property defining a service name is required.
public static final java.lang.String SERVICE_DESCRIPTION
The service description.
A property defining a service description is optional.
public static final java.lang.String SERVICE_GROUPING_NAME
The name of the group to associate with this service.
A property defining a service grouping name is optional.
public static final java.lang.String RUN_GLOBALINTERCEPTORS
Directs z/OS Connect to process the global interceptors if they are configured to run globally through in the server's configuration file. By default z/OS Connect processes all globally and service defined interceptors.
A property defining a run global interceptors indicator is optional.
public static final java.lang.String INVOKE_URI
Specifies a request URI string to use for matching a service invocation. InvokeURIs can end with a wildcard character in the form /a/b/* or x/y* to generically match a service 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 services with configured invokeURIs using the wildcard character are associated to
overlapping invokeURIs, the service associated to the most specific invokeURI is
matched. For instance, if a service 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/*"
service2 -> invokeURI="/a/b/*"
z/OS Connect will match the request to service1.
Multiple URIs can be specified as an array of values. For example:
Dictionary
serviceProps.put(ServiceControllerConstants.INVOKE_URI, new String[] { "/a/b/c", "/c/d", "/x/y/z*" });
serviceProps.put(ServiceControllerConstants.SERVICE_NAME, "bankingService");
ServiceRegistration serviceReg = bundleContext.registerService(com.ibm.wsspi.zos.connect.ServiceController.class, new BankingServiceControllerImpl(),
serviceProps);
A property defining an invoke URI string is optional.
public static final java.lang.String ADMIN_GROUP
The name of the security group that the user needs to be in before administrative functions for the service are permitted.
A property defining an admin group name is optional.
public static final java.lang.String OPS_GROUP
The name of the security group that the user needs to be in before operations, such as start, stop, or status for the service are permitted.
A property defining an operations group name is optional.
public static final java.lang.String INVOKE_GROUP
The name of the security group that the user needs to be in before invoke (call) functions are to be permitted.
A property defining an invoke group name is optional.
public static final java.lang.String ASYNC_REQ_TIMEOUT
Specifies the time in milliseconds in which requests for the service have to complete. This timeout value overrides the web container's asyncTimeoutDefault timeout. If neither this property nor asyncTimeoutDefault are configured, the timeout used is asyncTimeoutDefault's default timeout (i.e. 30 seconds).
If the asyncRequestTimeout (global setting specified under the zosConnectManager element in the server's configuration file) is not configured, but the asyncTimeoutDefault attribute is, the asyncTimeoutDefault's configured value is used.
If configured along with its global counterpart asyncRequestTimeout, the value defined under this property is used.
A timeout may occur at anytime 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.
A property defining an asynchronous request timeout value is optional.
public static final java.lang.String REQUIRE_SECURE
Specifies whether calls to this service require need to come in over HTTPS.
If this is set to false then requests can be sent in over HTTP.
If no value is assigned, the value used for the service is the one assigned to the requireSecure attribute definition configured globally for all services under the zosConnectManager element. If no value is assigned and the requireSecure attribute is not configured globally, the value of true is used by default.
public static final java.lang.String REQUIRE_AUTH
Specifies whether calls to this service require the user to authenticate before the call is processed.
If this is set to false then authentication is not required.
If no value is assigned, the value used for the service is the one assigned to the requireAuth attribute definition configured globally for all services under the zosConnectManager element. If no value is assigned and the requireAuth attribute is not configured globally, the value of true is used by default.