com.ibm.zosconnect.spi

Interface SarFile


  • public interface SarFile
    Representation of a SAR file that can be used by a ServiceFactory to create, update or delete a Service.

    • Method Detail

      • getDescription

        java.lang.String getDescription()
        Returns:
        The description of the Service

      • getName

        java.lang.String getName()
        Returns:
        The name of the service. This needs to be unique in the z/OS Connect EE runtime

      • getManifest

        com.ibm.zosconnect.sar.ZosConnectServiceArchiveManifest getManifest()
        Returns:
        The SAR manifest.

      • getVersion

        java.lang.String getVersion()
        Returns:
        The version of the Service

      • getProperties

        java.util.Map<java.lang.String,java.lang.Object> getProperties()
        Returns:
        The properties stored in the SAR file.

      • getProperty

        java.lang.Object getProperty(java.lang.String name)
        Parameters:
        name - The name of the property
        Returns:
        The value stored in the SAR file for the property name, or null if the property doesn't exist

      • getResponseSchema

        com.ibm.json.java.JSONObject getResponseSchema()
        Returns:
        The JSON response schema describing response objects from the Service

      • getRequestSchema

        com.ibm.json.java.JSONObject getRequestSchema()
        Returns:
        The JSON request schema describing request objects to the Service

      • getObject

        ServiceArchiveObject getObject(java.lang.String name)
        Parameters:
        name - The name of the object
        Returns:
        The object stored in the SAR file for the object name, or null if the object doesn't exist

      • getFileName

        java.lang.String getFileName()
        Returns:
        The name of the file on the disk
Skip navigation links