Package com.ibm.zosconnect.spi
-
Interface Summary Interface Description Data Defines the request specific API provider data available to interceptors and service providers.DataRequester Defines the request specific API requester data available to interceptors.DataXform Defines an OSGI service provider that has the ability to transform data from/to different object types.DataXformExt EarlyFailureInterceptor Defines an extension of theInterceptor
interface, and provides the ability for an interceptor to to be invoked for requests that fail before the invocation ofInterceptor.preInvoke(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.HttpZosConnectRequest, com.ibm.zosconnect.spi.Data)
.EarlyFailureInterceptorRequester Defines an extension of theInterceptorRequester
interface, and provides the ability for an interceptor to to be invoked for requests that fail before the invocation ofInterceptorRequester.preInvokeRequester(java.util.Map<java.lang.Object, java.lang.Object>, com.ibm.zosconnect.spi.DataRequester)
.EndpointInterceptor Defines an extension of theInterceptorRequester
interface, and provides the ability to be invoked before and after the call to an API endpoint by an API requester call.HttpZosConnectRequest Provides access to information associated to a specific HTTP request.Interceptor Defines an OSGI service that is invoked before and after the z/OS Connect EE processing of an HTTP request.InterceptorRequester Defines an OSGI service that is invoked before and after the z/OS Connect processing of an API requester request.RequestData Defines an object that holds data associated to a specific request.ResponseData Defines an Object that holds response data associated to a specific request.SarFile Representation of a SAR file that can be used by aServiceFactory
to create, update or delete a Service.Service Defines an OSGI service that provides a link between z/OS assets and clients trying to access those z/OS assets.ServiceController Defines a z/OS ConnectService
that can be registered with the OSGI framework and consequently z/OS Connect from another OSGI service without the need for configuration file updates.ServiceFactory Defines an OSGi service that receives information about SAR file changes and uses it to manage the Services defined in those SAR files.ServiceProviderInterceptor Defines an extension of theInterceptor
interface, and provides the ability to be invoked before and after the call to a system of record via a Service Provider.TrackingInterceptor Defines an extension of theInterceptor
interface, and provides the ability to register a stakeholder tracking identifier to enable an interceptor to support selective tracking. -
Class Summary Class Description SarDataXform ServiceArchiveData Abstract class to represent data to store in the service archive, useServiceArchiveProperty
orServiceArchiveObject
for concrete implementations.ServiceArchiveObject Class to represent a serialized object to store in the service archive.ServiceArchiveProperty Class to represent a property to store in the service archive.ServiceControllerConstants Defines the set of property keys to be used when registering aServiceController
with the OSGI framework.ServiceStatus Represents a service endpoint's status. -
Enum Summary Enum Description Data.RequestType Enumeration for the type of the REST request.DataRequester.RequestApplicationType Enumeration for the application type of the originating request.Service.CallerType Enumeration for how the service provider is being invoked, either from a Service or an API.ServiceArchiveProperty.DataType -
Exception Summary Exception Description DataXformException A DataXformException is thrown to indicate that the OSGI service implementing theDataXform
SPI encountered an error.InterceptorException A InterceptorException is thrown to indicate that the OSGI service implementing theInterceptor
SPI encountered an error.ServiceException A ServiceException is thrown to indicate that the OSGI service implementing theService
SPI encountered an error.ServiceFactoryException A ServiceFactoryException can be thrown by aServiceFactory
to indicate there was a problem processing a SAR file.TrackingCapacityException A TrackingCapacityException is thrown to indicate that the OSGI service implementing theTrackingInterceptor
SPI encountered a capacity error when adding tracking information to a request.