Creating a z/OS Connect service provider

z/OS® Connect provides the com.ibm.wsspi.zos.connect.Service SPI that supports the creation of service providers that you can use to process requests arriving in to the z/OS Connect servlet.

About this task

z/OS Connect service providers can be written and delivered by any component to plug into the framework. A WOLA service provider is included with z/OS Connect.

A service provider that is implemented for z/OS Connect is an OSGi service that connects and interacts with z/OS Connect through the OSGi framework.

Procedure

Create an OSGi service that implements the z/OS Connect com.ibm.wsspi.zos.connect.Service SPI.
To integrate the new z/OS Connect Service SPI implementation with z/OS Connect, add ibm:objectClass="com.ibm.ws.zos.connect.serviceType" to the service's configuration element definition in the associated metatype.
```
<OCD id="custom.banking.service" ibm:alias="bankingService" name="bankingService" description="Banking Service" ibm:objectClass="com.ibm.ws.zos.connect.serviceType">
  ...
</OCD>
```
If the z/OS Connect Service implementation is being developed to run on WebSphere Application Server version 8.5.5.9 or earlier, add the following attribute definition instead: <AD id="com.ibm.ws.zos.connect.serviceType" required="false" type="String"ibm:final="true"name="internal"description="internal use only"/> The attribute definition goes under the new data transformer's configuration element in the associated metatype.
```
<OCD id="custom.banking.service" ibm:alias="bankingService"
    name="bankingService" description="Banking Service">   <AD
    id="com.ibm.ws.zos.connect.serviceType" required="false"
    type="String"ibm:final="true"name="internal"description="internal use  only"/> 
    ...</OCD>
```
The ibm:final attribute indicates that the value cannot be specified in the configuration, and the name="internal" attribute indicates that tools do not display this property.

The Java™ API documentation for each Liberty SPI is available in a separate .zip file in one of the Javadoc subdirectories of the ${wlp.install.dir}/dev directory.

For more information, see the documentation on extending Liberty.
Note: The Java API documentation for each Liberty SPI is detailed in the Programming interfaces (Javadoc) section of the documentation, and is also available as a separate .zip file in one of the Javadoc subdirectories of the ${wlp.install.dir}/dev directory.