A B C D E G H I M O P R S T U V Z 

A

addOtelContext(Object, Object) - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Adds OTEL headers ("traceparent", "tracestate", and "baggage") to an HTTP request sent to an endpoint using the Liberty JAX-RS classes.
addStakeholderToken(char) - Method in interface com.ibm.zosconnect.spi.Data
This method is applicable only when implementing the TrackingInterceptor interface.
ADMIN_GROUP - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
The name of the security group that the user needs to be in before administrative functions for the service are permitted.
API_DESCRIPTION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the description of the API associated with this request.
API_NAME - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the name of the API associated with this request.
API_OPERATION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the operation in the API associated with this request.
API_REQUESTER_DESCRIPTION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the description of any API requester associated with this zosConnect-2.0 server administration request.
API_REQUESTER_DESCRIPTION - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the description of the API requester associated with this request.
API_REQUESTER_NAME - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the name of any API requester associated with this zosConnect-2.0 server administration request.
API_REQUESTER_NAME - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the name of the API requester associated with this request.
API_REQUESTER_VERSION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the version of any API requester associated with this zosConnect-2.0 server administration request.
API_REQUESTER_VERSION - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the version of the API requester associated with this request.
API_VERSION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the version of the API associated with this request.
ASYNC_REQ_TIMEOUT - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
Specifies the time in milliseconds in which requests for the service have to complete.
AUTHORIZATION_ADMIN_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the configured administrator groups names to be used for authorization validation in zosConnect-2.0 servers.
AUTHORIZATION_ADMIN_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the configured administrator groups names to be used for authorization validation.
AUTHORIZATION_INVOKE_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the configured invoke group names to be used for authorization validation in zosConnect-2.0 servers.
AUTHORIZATION_INVOKE_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the configured invoke group names to be used for authorization validation.
AUTHORIZATION_OPERATIONS_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the configured operations group names to be used for authorization validation in zosConnect-2.0 servers.
AUTHORIZATION_OPERATIONS_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the configured operations group names to be used for authorization validation.
AUTHORIZATION_READER_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the configured reader group names to be used for authorization validation in zosConnect-2.0 servers.
AUTHORIZATION_READER_GROUP_NAMES - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the configured reader group names to be used for authorization validation.

B

BUILD_JWT - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 

C

CFG_AD_SEQUENCE_ALIAS - Static variable in interface com.ibm.zosconnect.spi.Interceptor
Sequence attribute definition name.
CICS_APPLID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the CICS APPLID of the region invoking this request.
CICS_NETUOWID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the CICS network unit of work (UOW) ID of the task invoking this request.
CICS_TASK_NUMBER - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the CICS task number invoking this request.
CICS_TRANSID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the CICS transid invoking this request.
CICS_UOWID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the CICS unit of work (UOW) ID of the task invoking this request.
CLIENT_SPAN_KIND - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
com.ibm.zosconnect.spi - package com.ibm.zosconnect.spi
IBM z/OS Connect SPI for extending z/OS Connect Servers.
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.Data
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.DataRequester
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.DataXform
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.DataXformExt
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.EarlyFailureInterceptor
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.EarlyFailureInterceptorRequester
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.EndpointInterceptor
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.Interceptor
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.InterceptorRequester
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.RequestData
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.ResponseData
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.SarFile
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.Service
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.ServiceController
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.ServiceFactory
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.ServiceProviderInterceptor
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.TrackingInterceptor
 
copyright_notice - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
CORRELATOR - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for a byte array containing a system wide unique correlator.
createZosConnectSpan(String, String) - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Create, start, and make current a new z/OS Connect span.

D

Data - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
Data.RequestType - Enum in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
DataRequester - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
DataRequester.RequestApplicationType - Enum in com.ibm.zosconnect.spi
Enumeration for the application type of the originating request.
DataXform - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
DataXformException - Exception in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
DataXformException() - Constructor for exception com.ibm.zosconnect.spi.DataXformException
Constructs a new instance with null as its detail message and cause.
DataXformException(String) - Constructor for exception com.ibm.zosconnect.spi.DataXformException
Constructs a new instance with the specified detail message.
DataXformException(String, int) - Constructor for exception com.ibm.zosconnect.spi.DataXformException
Constructs a new instance with the specified detail message and desired HTTP status code.
DataXformException(Throwable) - Constructor for exception com.ibm.zosconnect.spi.DataXformException
Constructs a new instance with the specified cause.
DataXformException(String, Throwable) - Constructor for exception com.ibm.zosconnect.spi.DataXformException
Constructs a new instance with the specified detail message and cause.
DataXformExt - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
DEFAULT_SEQUENCE_NUMBER - Static variable in interface com.ibm.zosconnect.spi.Interceptor
The default sequence number.
deregisterService(SarFile) - Method in interface com.ibm.zosconnect.spi.ServiceFactory
Removes a service due to a Service Archive being removed.

E

earlyFailure(HttpZosConnectRequest, Data) - Method in interface com.ibm.zosconnect.spi.EarlyFailureInterceptor
Runs implementor specific logic when the processing of a request fails in initial z/OS Connect processing.
EarlyFailureInterceptor - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
EarlyFailureInterceptorRequester - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
earlyFailureRequester(DataRequester) - Method in interface com.ibm.zosconnect.spi.EarlyFailureInterceptorRequester
Runs implementor specific logic when the processing of a request fails in initial z/OS Connect processing.
ENDPOINT_FULL_PATH - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for a string containing the full path of the resource invoked at the endpoint.
ENDPOINT_HOST - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for a string containing the host value of the API endpoint.
ENDPOINT_METHOD - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the endpoint request method.
ENDPOINT_PORT - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for a string containing the port value of the API endpoint.
ENDPOINT_QUERY_STRING - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for a string containing information identifying the endpoint request query string.
ENDPOINT_REFERENCE - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the configured connection reference that identifies the connection to the API endpoint.
EndpointInterceptor - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
endZosConnectSpan(Object) - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Ends the given span.

G

getAttribute(String) - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
getAttributeNames() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns an Enumeration containing the names of the attributes available to this request.
getAuthorizationAdminGroupName() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "AuthorizationAdminGroupNames".
getAuthorizationAdminGroupNames() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "AuthorizationAdminGroupNames".
getAuthorizationInvokeGroupName() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "AuthorizationInvokeGroupNames".
getAuthorizationOperationsGroupName() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "AuthorizationOperationsGroupNames".
getAuthorizationReaderGroupName() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "AuthorizationReaderGroupNames".
getBindFileStream(String) - Method in class com.ibm.zosconnect.spi.SarDataXform
 
getBytes(String, JSONObject) - Method in interface com.ibm.zosconnect.spi.DataXform
Transforms a JSON object to byte array.
getBytes(String, String) - Method in interface com.ibm.zosconnect.spi.DataXformExt
Transforms the input JSON string to byte array.
getBytes() - Method in interface com.ibm.zosconnect.spi.RequestData
Dynamically converts an available JSON payload to a byte array.
getCharacterEncoding() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the name of the character encoding used in the body of this request.
getContents() - Method in class com.ibm.zosconnect.spi.ServiceArchiveObject
 
getContents() - Method in class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
getData(String) - Method in interface com.ibm.zosconnect.spi.Data
Returns the specified data.
getData(String) - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns the specified data.
getData() - Method in interface com.ibm.zosconnect.spi.Service
Returns a map of JSON object compatible key value pairs representing information about the service.
getDataXform() - Method in interface com.ibm.zosconnect.spi.ServiceController
Returns the DataXform object to be used for this service.
getDescription() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getDescription() - Method in class com.ibm.zosconnect.spi.ServiceStatus
Retrieves the service status description.
getEncoding(String) - Method in interface com.ibm.zosconnect.spi.DataXformExt
Gets the Encoding Information of the given service name.
getFileName() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getHeader(String) - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the value of the specified request header as a String.
getHeaderNames() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns an Enumeration of the names of all the headers for this request.
getHeaders(String) - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns an Enumeration of all the values for the specified request header.
getHttpServletResponseCode() - Method in exception com.ibm.zosconnect.spi.DataXformException
Returns the HTTP servlet response code of this Throwable.
getHttpServletResponseCode() - Method in exception com.ibm.zosconnect.spi.InterceptorException
Returns the HTTP servlet response code of this Throwable.
getHttpServletResponseCode() - Method in exception com.ibm.zosconnect.spi.ServiceException
Returns the HTTP servlet response code of this Throwable.
getInputPayload() - Method in interface com.ibm.zosconnect.spi.Data
Returns a String representation of the input payload.
getInputPayload() - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns a String representation of the input payload sent to the endpoint.
getInterceptorPreInvokeFailed() - Method in interface com.ibm.zosconnect.spi.Data
Returns a boolean value indicating that an exception was thrown by an interceptor.
getInterceptorPreInvokeFailed() - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns a boolean value indicating that an exception was thrown by an interceptor.
getInterceptors() - Method in interface com.ibm.zosconnect.spi.ServiceController
Returns an array of Interceptor objects to be associated to the service implementing this interface when the service is registered with z/OS Connect.
getJSON(String, byte[]) - Method in interface com.ibm.zosconnect.spi.DataXform
Transforms a byte array to a JSON object.
getJSON() - Method in interface com.ibm.zosconnect.spi.RequestData
Retrieves the JSONObject associated with the inbound HTTP request.
getJSONString(String, byte[]) - Method in interface com.ibm.zosconnect.spi.DataXformExt
Transforms a byte array to a JSON string.
getLocalAddr() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the Internet Protocol (IP) address of the interface on which the request was received.
getManifest() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getMappedResponseHeader(String) - Method in interface com.ibm.zosconnect.spi.Data
Returns the value of the specified mapped response header as a String.
getMappedResponseHeaderNames() - Method in interface com.ibm.zosconnect.spi.Data
Returns an Enumeration of the names of all the response headers for this request that resulted from the API mapping.
getMethod() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
getName() - Method in interface com.ibm.zosconnect.spi.Interceptor
Returns the name that identifies the interceptor.
getName() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getName() - Method in class com.ibm.zosconnect.spi.ServiceArchiveData
 
getObject(String) - Method in interface com.ibm.zosconnect.spi.SarFile
 
getOtelContextData() - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Returns the OTEL trace headers which contain the trace data to be sent to an endpoint over any protocol.
getOutputPayload() - Method in interface com.ibm.zosconnect.spi.Data
Returns a String representation of the output payload.
getOutputPayload() - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns a String representation of the output payload returned by the endpoint.
getParameter(String) - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the value of a request parameter as a String, or null if the parameter does not exist.
getParameterMap() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns a java.util.Map of the parameters of this request.
getPathInfo() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns any extra path information associated with the URL the client sent when it made this request.
getPayloadDataSize() - Method in interface com.ibm.zosconnect.spi.RequestData
Returns the size of the data in the request payload.
getPayloadDataSize() - Method in interface com.ibm.zosconnect.spi.ResponseData
Returns the size of the data in the response payload.
getProperties() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getProperty(String) - Method in interface com.ibm.zosconnect.spi.SarFile
 
getProvider() - Method in interface com.ibm.zosconnect.spi.ServiceFactory
Defines the provider name that this ServiceFactory will process Service Archive files for.
getProviderName() - Method in interface com.ibm.zosconnect.spi.DataXform
Retrieves the data transformation's provider name.
getProviderName() - Method in interface com.ibm.zosconnect.spi.Service
Returns the service provider's name.
getQueryString() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the query string that is contained in the request URL after the path.
getRemoteAddr() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
getRequestHeader(String) - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns the value of the specified request header as a String.
getRequestHeaderNames() - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns an Enumeration of the names of all the request headers for this request.
getRequestID() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "RequestId".
getRequestPayloadDataSize(String) - Method in interface com.ibm.zosconnect.spi.DataXform
Returns the size of the data in the request payload.
getRequestSchema(String) - Method in interface com.ibm.zosconnect.spi.DataXform
Returns the request schema.
getRequestSchema(String) - Method in class com.ibm.zosconnect.spi.SarDataXform
 
getRequestSchema() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getRequestSchema() - Method in interface com.ibm.zosconnect.spi.Service
Queries the service for the data transformation request schema used.
getRequestSchemaString(String) - Method in interface com.ibm.zosconnect.spi.DataXformExt
Returns the request schema in string form.
getRequestSchemaString(String) - Method in class com.ibm.zosconnect.spi.SarDataXform
 
getRequestType() - Method in interface com.ibm.zosconnect.spi.Data
Returns the request type.
getRequestURI() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
getRequestURL() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Reconstructs the URL the client used to make the request.
getResponseHeader(String) - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns the value of the specified response header as a String.
getResponseHeaderNames() - Method in interface com.ibm.zosconnect.spi.DataRequester
Returns an Enumeration of the names of all the response headers for this request.
getResponsePayloadDataSize(String) - Method in interface com.ibm.zosconnect.spi.DataXform
Returns the size of the data in the response payload.
getResponseSchema(String) - Method in interface com.ibm.zosconnect.spi.DataXform
Returns the response schema.
getResponseSchema(String) - Method in class com.ibm.zosconnect.spi.SarDataXform
 
getResponseSchema() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getResponseSchema() - Method in interface com.ibm.zosconnect.spi.Service
Queries the service for the data transformation response schema used.
getResponseSchemaString(String) - Method in interface com.ibm.zosconnect.spi.DataXformExt
Returns the response schema in string form.
getResponseSchemaString(String) - Method in class com.ibm.zosconnect.spi.SarDataXform
 
getSequence() - Method in interface com.ibm.zosconnect.spi.Interceptor
Retrieves the number to be used to establish the sequence in which the interceptor is to be processed with respect to other configured interceptors.
getServiceArchiveData() - Method in interface com.ibm.zosconnect.spi.Service
Deprecated.
The z/OS Connect Enterprise Edition build toolkit should be used to generate service archives.
getServiceDescription() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "ServiceDescription".
getServiceGroupingName() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
This has been deprecated as APIs are now used to logically group services and this function is not available for services defined by a service archive file.
getServiceName() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
Replaced by Data.getData(String) with key value "ServiceName" for service requests or with key value "ApiName" for API requests.
getServiceStatus() - Method in exception com.ibm.zosconnect.spi.ServiceException
Retrieves the ServiceStatus instance.
getServletPath() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns the part of this request's URL that calls the servlet.
getStakeholderIdentifier() - Method in interface com.ibm.zosconnect.spi.TrackingInterceptor
Returns the unique identifier of the stakeholder to be used in selective tracking of requests.
getStatistics() - Method in interface com.ibm.zosconnect.spi.Service
Queries the service for statistic data.
getStatus() - Method in class com.ibm.zosconnect.spi.ServiceStatus
Retrieves the service status.
getType() - Method in class com.ibm.zosconnect.spi.ServiceArchiveObject
 
getType() - Method in class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
getUserPrincipal() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns a java.security.Principal object containing the name of the current authenticated user.
getValue() - Method in class com.ibm.zosconnect.spi.ServiceArchiveData
 
getVersion() - Method in interface com.ibm.zosconnect.spi.SarFile
 
getVersion() - Method in class com.ibm.zosconnect.spi.ServiceArchiveObject
 

H

HTTP_RESPONSE_CODE - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the HTTP status code for the response.
HTTP_RESPONSE_CODE - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the HTTP status code for the response from the API endpoint.
HttpZosConnectRequest - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.

I

IBM_ZOS_CONNECT_CALLER - Static variable in interface com.ibm.zosconnect.spi.Service
Deprecated.
Replaced by Data.getRequestType().
IBM_ZOS_CONNECT_ENCODING - Static variable in interface com.ibm.zosconnect.spi.Service
Constant for the key in the requestStateMap for encoding information.
IBM_ZOS_CONNECT_TIMEOUT - Static variable in interface com.ibm.zosconnect.spi.Service
Constant for the key in the requestStateMap for the time remaining when a timeout has been specified on an asynchronous request.
IMS_APPNAME - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the name of the IMS application program invoking this request.
IMS_EXIT_DATA - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) when the IMS INQY exit of the program invoking this request has populated the Exit Data with character data.
IMS_EXIT_DATA_BYTES - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) when the IMS INQY exit of the program invoking this request has populated the Exit Data with binary data.
IMS_IDENTIFIER - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the IMS identifier invoking this request.
IMS_PSBNAME - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the name of the IMS PSB currently allocated to the program invoking this request.
IMS_RECOVERY_TOKEN - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Deprecated.
IMS_RECOVERY_TOKEN_BYTES - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the IMS recovery token of the program invoking this request.
IMS_REGION_ID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the IMS region identifier invoking this request.
IMS_TRANSNAME - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the name of the IMS transaction invoking this request.
Interceptor - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
InterceptorException - Exception in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
InterceptorException(String) - Constructor for exception com.ibm.zosconnect.spi.InterceptorException
Constructs a new instance with the specified detail message.
InterceptorException(String, int) - Constructor for exception com.ibm.zosconnect.spi.InterceptorException
Constructs a new instance with the specified detail message and HTTP servlet response code.
InterceptorException(String, Throwable) - Constructor for exception com.ibm.zosconnect.spi.InterceptorException
Constructs a new instance with the specified detail message and cause.
InterceptorException(String, Throwable, int) - Constructor for exception com.ibm.zosconnect.spi.InterceptorException
Constructs a new instance with the specified detailed message, cause, and HTTP servlet response code.
InterceptorRequester - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
INTERNAL_SPAN_KIND - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
invoke(Map<Object, Object>, HttpZosConnectRequest, RequestData, ResponseData) - Method in interface com.ibm.zosconnect.spi.Service
Processes a service invocation action.
INVOKE - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
INVOKE_CICS - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
INVOKE_GROUP - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
The name of the security group that the user needs to be in before invoke (call) functions are to be permitted.
INVOKE_IMS - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
INVOKE_URI - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
Specifies a request URI string to use for matching a service invocation.
isDataTranformationAvailable() - Method in interface com.ibm.zosconnect.spi.Data
Deprecated.
This data is not relevant for implementations of Interceptor.
isSecure() - Method in interface com.ibm.zosconnect.spi.HttpZosConnectRequest
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

M

MVS_ASID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the address space identifier (ASID) of the MVS system invoking this request.
MVS_JOBID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the ID of the MVS job invoking this request, taken from the IAZJSAB JOBID parameter.
MVS_JOBNAME - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the name of the MVS job invoking this request, taken from the IAZJSAB JOBNAME parameter.
MVS_SID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the system identifier (SID) that is used in all SMF records of the MVS system invoking this request.
MVS_SYSNAME - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the name of the MVS system invoking this request, taken from the CVT CVTSNAME field.

O

OPS_GROUP - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
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.
OTEL_ATTRIBUTE_HOST - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_METHOD - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_PEER_ADDRESS - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_PEER_PORT - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_PORT - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_PROGRAM - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_SCHEME - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_SMF_CORRELATOR - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_TRANSID - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
OTEL_ATTRIBUTE_URL_FULL - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 

P

postEndpointInvoke(Map<Object, Object>, DataRequester) - Method in interface com.ibm.zosconnect.spi.EndpointInterceptor
Runs implementor specific logic.
postInvoke(Map<Object, Object>, HttpZosConnectRequest, Data) - Method in interface com.ibm.zosconnect.spi.Interceptor
Runs implementor specific logic after z/OS Connect processing of an API, service or an administration request.
postInvokeRequester(Map<Object, Object>, DataRequester) - Method in interface com.ibm.zosconnect.spi.InterceptorRequester
Runs implementor specific logic after z/OS Connect processing of an API requester request is complete.
postSorInvoke(Map<Object, Object>, HttpZosConnectRequest, Data) - Method in interface com.ibm.zosconnect.spi.ServiceProviderInterceptor
Runs implementor specific logic.
preEndpointInvoke(Map<Object, Object>, DataRequester) - Method in interface com.ibm.zosconnect.spi.EndpointInterceptor
Runs implementor specific logic.
preInvoke(Map<Object, Object>, HttpZosConnectRequest, Data) - Method in interface com.ibm.zosconnect.spi.Interceptor
Runs implementor specific logic before z/OS Connect processing of an API, service or an administration request.
preInvokeRequester(Map<Object, Object>, DataRequester) - Method in interface com.ibm.zosconnect.spi.InterceptorRequester
Runs implementor specific logic before z/OS Connect processing of an API requester request.
preSorInvoke(Map<Object, Object>, HttpZosConnectRequest, Data) - Method in interface com.ibm.zosconnect.spi.ServiceProviderInterceptor
Runs implementor specific logic.

R

READER_GROUP - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
The name of the security group that the user needs to be in before read functions, such as list services, list APIs, read Swagger document, request JSON schema, are permitted.
registerService(SarFile, Properties) - Method in interface com.ibm.zosconnect.spi.ServiceFactory
Register a new service described by a new Service Archive file.
REQUEST_APPLICATION_TYPE - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the request application type.
REQUEST_ID - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the unique identifier associated with this request.
REQUEST_ID - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the unique identifier associated with this request.
REQUEST_RETRY - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for an indicator that this request is the retry of a request that used one or more cached access tokens, following a 401 authentication failure response from the API endpoint.
REQUEST_STATUS_CODE - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the status code returned to the client application in the BAQ-STATUS-CODE field of the BAQ-RESPONSE-INFO structure for COBOL programs or the BAQ_STATUS_CODE field of the BAQ_RESPONSE_INFO for PL/I programs.
REQUEST_TIMED_OUT - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for a flag indicating whether this request has been timed out.
RequestData - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
REQUIRE_AUTH - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
Specifies whether calls to this service require the user to authenticate before the call is processed.
REQUIRE_SECURE - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
Specifies whether calls to this service require need to come in over HTTPS.
ResponseData - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
RUN_GLOBALINTERCEPTORS - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
Directs z/OS Connect to process the global interceptors if they are configured to run globally through in the server's configuration file.

S

SarDataXform - Class in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
SarDataXform(byte[], JSONObject, JSONObject, String) - Constructor for class com.ibm.zosconnect.spi.SarDataXform
 
SarFile - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
Service - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
Service.CallerType - Enum in com.ibm.zosconnect.spi
Enumeration for how the service provider is being invoked, either from a Service or an API.
SERVICE_DESCRIPTION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the description of the zosConnect-2.0 service, or zosConnect-3.0 z/OS Asset, associated with this request.
SERVICE_DESCRIPTION - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
The service description.
SERVICE_GROUPING_NAME - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
The name of the group to associate with this service.
SERVICE_NAME - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the name of the zosConnect-2.0 service, or zosConnect-3.0 z/OS asset, associated with this request.
SERVICE_NAME - Static variable in class com.ibm.zosconnect.spi.ServiceControllerConstants
The name to be associated with the service.
SERVICE_PROVIDER_NAME - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the name of the zosConnect-2.0 service provider, or zosConnect-3.0 type of z/OS Asset, which is processing this request.
SERVICE_VERSION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the version of the zosConnect-2.0 service, or zosConnect-3.0 z/OS Asset, associated with this request.
ServiceArchiveData - Class in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceArchiveData(String, String) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveData
 
ServiceArchiveObject - Class in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceArchiveObject(String, String, String, String, byte[]) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveObject
 
ServiceArchiveProperty - Class in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceArchiveProperty(String, Boolean) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, Byte) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, Character) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, Double) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, String, byte[]) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, Float) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, Integer) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, Long) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, Short) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, String) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty(String, String, boolean) - Constructor for class com.ibm.zosconnect.spi.ServiceArchiveProperty
 
ServiceArchiveProperty.DataType - Enum in com.ibm.zosconnect.spi
 
ServiceController - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceControllerConstants - Class in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceControllerConstants() - Constructor for class com.ibm.zosconnect.spi.ServiceControllerConstants
 
ServiceException - Exception in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceException() - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with null as its detail message and cause.
ServiceException(int) - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with a HTTP response code and a null detail message and cause.
ServiceException(String) - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with the specified detail message.
ServiceException(String, int) - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with the specified detail message and HTTP servlet response code.
ServiceException(Throwable) - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with the specified cause.
ServiceException(Throwable, int) - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with the specified cause and HTTP servlet response code.
ServiceException(String, Throwable) - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with the specified detail message and cause.
ServiceException(String, Throwable, int) - Constructor for exception com.ibm.zosconnect.spi.ServiceException
Constructs a new instance with the specified detailed message, cause, and HTTP servlet response code.
ServiceFactory - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceFactoryException - Exception in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceFactoryException() - Constructor for exception com.ibm.zosconnect.spi.ServiceFactoryException
Constructs a new instance with null as its detail message and cause.
ServiceFactoryException(String) - Constructor for exception com.ibm.zosconnect.spi.ServiceFactoryException
Constructs a new instance with the specified detail message.
ServiceFactoryException(String, Throwable) - Constructor for exception com.ibm.zosconnect.spi.ServiceFactoryException
Constructs a new instance with the specified detail message and cause.
ServiceFactoryException(Throwable) - Constructor for exception com.ibm.zosconnect.spi.ServiceFactoryException
Constructs a new instance with the specified cause.
ServiceProviderInterceptor - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
ServiceStatus - Class in com.ibm.zosconnect.spi
Applies to zosConnect-2.0.
ServiceStatus() - Constructor for class com.ibm.zosconnect.spi.ServiceStatus
 
setAttribute(String, String) - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Sets an Open Telemetry attribute on the current span.
setAttribute(String, int) - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Sets an Open Telemetry attribute on the current span.
setAttribute(String, boolean) - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Sets an Open Telemetry attribute on the current span.
setBytes(byte[]) - Method in interface com.ibm.zosconnect.spi.ResponseData
Sets a byte array output to be converted to a JSONObject.
setCurrentSpanError(String) - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
Record that an error has occurred in the current span.
setDescription(String) - Method in class com.ibm.zosconnect.spi.ServiceStatus
Sets the service status description.
setHeader(String, String) - Method in interface com.ibm.zosconnect.spi.ResponseData
Add header to http response.
setHttpResponseCode(int) - Method in interface com.ibm.zosconnect.spi.ResponseData
Sets the HTTP servlet response code to be set in the response back to the caller.
setJSON(JSONObject) - Method in interface com.ibm.zosconnect.spi.ResponseData
Sets the JSONObject to be set in the response.
setPreserveJSONObjectPayloadOrder(boolean) - Method in interface com.ibm.zosconnect.spi.DataXformExt
Sets the indicator that tells the data transformer if the order of entries in JSON object payloads should be preserved.
setPreserveJsonPayloadCharFormat(boolean) - Method in interface com.ibm.zosconnect.spi.DataXformExt
Sets the indicator that tells the data transformer if the JSON payload's characters should flow unchanged through z/OS Connect during a service invocation and schema retrievals.
setServiceStatus(ServiceStatus) - Method in exception com.ibm.zosconnect.spi.ServiceException
Sets a serviceStatus object containing service status information.
setStatus(String) - Method in class com.ibm.zosconnect.spi.ServiceStatus
Sets the service's current status.
SOR_IDENTIFIER - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for a string identifying the system of record.
SOR_REFERENCE - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the configured connection reference that identifies the connection to the system of record.The value returned by Data.getData(String) is a String, null when the request type is Data.RequestType.ADMIN, or if the request fails before the service provider or z/OS Asset determines the reference, or if the service provider does not support setting this value.
SOR_RESOURCE - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for a string containing information identifying the resource invoked on the system of record.
start() - Method in interface com.ibm.zosconnect.spi.Service
Notifies the service that the server should be started.
STARTED - Static variable in class com.ibm.zosconnect.spi.ServiceStatus
Indicates that the service endpoint is started and ready to process work requests.
status() - Method in interface com.ibm.zosconnect.spi.Service
Queries the service for its status.
stop() - Method in interface com.ibm.zosconnect.spi.Service
Notifies the service that a service should be stopped.
STOPPED - Static variable in class com.ibm.zosconnect.spi.ServiceStatus
Indicates that the service endpoint is stopped and cannot process work requests

T

TIME_ENDPOINT_RECEIVED - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the timestamp of when this response was received from the API endpoint by the z/OS Connect server.
TIME_ENDPOINT_SENT - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the timestamp of when this request was sent to the API endpoint by the z/OS Connect server.
TIME_SOR_RECEIVED - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the timestamp of when this response was received from the system of record by the z/OS Connect Server.
TIME_SOR_SENT - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the timestamp of when this request was sent to the system of record by the z/OS Connect Server.
TIME_STUB_SENT - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the timestamp of when the communications stub sent this request.
TIME_TOKEN_GET_FINISH - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the timestamp for when the z/OS Connect server has completed acquiring the access token(s) for this request.
TIME_TOKEN_GET_START - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the timestamp for when the z/OS Connect server starts to acquire the access token(s) for this request.
TIME_ZOS_CONNECT_ENTRY - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the timestamp of when this request was received by the z/OS Connect Server from the HTTP client.
TIME_ZOS_CONNECT_ENTRY - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the timestamp of when this request was received by the z/OS Connect server from the API requester communications stub.
TIME_ZOS_CONNECT_EXIT - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the timestamp of when this response was sent to the HTTP client by the z/OS Connect Server.
TIME_ZOS_CONNECT_EXIT - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the timestamp of when this response was sent to the API requester communications stub by the z/OS Connect server.
toString() - Method in class com.ibm.zosconnect.spi.ServiceStatus
Returns a short description of the service status.
traceOtelData() - Method in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
TRACKING_TOKEN - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for a byte array containing the tracking token that is passed to the system of record by some service providers and can be used to track this request, @see Tracking requests for information on the format of the tracking token.
TRACKING_TOKEN - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for a byte array containing a tracking token.
TrackingCapacityException - Exception in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.
TrackingCapacityException() - Constructor for exception com.ibm.zosconnect.spi.TrackingCapacityException
 
TrackingCapacityException(String) - Constructor for exception com.ibm.zosconnect.spi.TrackingCapacityException
 
TrackingCapacityException(Throwable) - Constructor for exception com.ibm.zosconnect.spi.TrackingCapacityException
 
TrackingCapacityException(String, Throwable) - Constructor for exception com.ibm.zosconnect.spi.TrackingCapacityException
 
TrackingInterceptor - Interface in com.ibm.zosconnect.spi
Applies to zosConnect-2.0 and zosConnect-3.0.

U

UNKNOWN - Static variable in class com.ibm.zosconnect.spi.ServiceStatus
Indicates that the service endpoint's status is unknown.
updateService(SarFile, Properties) - Method in interface com.ibm.zosconnect.spi.ServiceFactory
Updates a service described by an updated Service Archive file.
USER_NAME - Static variable in interface com.ibm.zosconnect.spi.Data
For zosConnect-2.0, available from 3.0.58.0 and for zosConnect-3.0 available from 3.0.74.0.
USER_NAME - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the user identity associated with this request.
USER_NAME_ASSERTED - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the SAF asserted user ID associated with this request, if there is one.
USER_NAME_MAPPED - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) for the SAF mapped user ID associated with this request, if there is one.
USER_NAME_MAPPED - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) for the SAF mapped user ID associated with this request, if there is one.

V

valueOf(String) - Static method in enum com.ibm.zosconnect.spi.Data.RequestType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.zosconnect.spi.DataRequester.RequestApplicationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.zosconnect.spi.Service.CallerType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.zosconnect.spi.ServiceArchiveProperty.DataType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ibm.zosconnect.spi.Data.RequestType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.zosconnect.spi.DataRequester.RequestApplicationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.zosconnect.spi.Service.CallerType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.zosconnect.spi.ServiceArchiveProperty.DataType
Returns an array containing the constants of this enum type, in the order they are declared.

Z

ZOS_CONNECT_FEATURE_VERSION - Static variable in interface com.ibm.zosconnect.spi.Data
Constant for the key used in Data.getData(String) indicating the z/OS Connect feature version this server is running.
ZOS_CONNECT_FEATURE_VERSION - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant for the key used in DataRequester.getData(String) indicating the z/OS Connect feature version this server is running.
ZOS_CONNECT_FEATURE_VERSION_2_0 - Static variable in interface com.ibm.zosconnect.spi.Data
Constant String value 2.0 indicating z/OS Connect feature zosConnect-2.0 is in use.
ZOS_CONNECT_FEATURE_VERSION_2_0 - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant String value 2.0 indicating z/OS Connect feature zosConnect-2.0 is in use.
ZOS_CONNECT_FEATURE_VERSION_3_0 - Static variable in interface com.ibm.zosconnect.spi.Data
Constant String value 3.0 indicating z/OS Connect feature zosConnect-3.0 is in use.
ZOS_CONNECT_FEATURE_VERSION_3_0 - Static variable in interface com.ibm.zosconnect.spi.DataRequester
Constant String value 3.0 indicating z/OS Connect feature zosConnect-3.0 is in use.
ZOSCONNECT_PROCESSING - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
ZOSCONNECT_REQUEST_MAPPING - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
ZOSCONNECT_RESPONSE_MAPPING - Static variable in interface com.ibm.zosconnect.spi.ZosConnectOtel
 
ZosConnectOtel - Interface in com.ibm.zosconnect.spi
Interface for Open Telemetry actions to avoid dependencies on OTel classes in OAS2 code.
A B C D E G H I M O P R S T U V Z 
Skip navigation links
  • Prev
  • Next