com.ibm.zosconnect.spi

Class SarDataXform

  • java.lang.Object
    • com.ibm.zosconnect.internal.xform.DataXformImpl
      • com.ibm.zosconnect.spi.SarDataXform
  • All Implemented Interfaces:
    com.ibm.zosconnect.monitoring.artifacts.RefreshableArtifacts, DataXform, DataXformExt, com.ibm.zosconnect.spi.internal.ext.StructuredDataXform

    public class SarDataXform
extends com.ibm.zosconnect.internal.xform.DataXformImpl

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.ibm.zosconnect.internal.xform.DataXformImpl

        com.ibm.zosconnect.internal.xform.DataXformImpl.BindFileMonitorImpl, com.ibm.zosconnect.internal.xform.DataXformImpl.RequestSchemaFileMonitorImpl, com.ibm.zosconnect.internal.xform.DataXformImpl.ResponseSchemaFileMonitorImpl, com.ibm.zosconnect.internal.xform.DataXformImpl.SchemaOutputTypes, com.ibm.zosconnect.internal.xform.DataXformImpl.SchemaType

    • Field Summary

      • Fields inherited from class com.ibm.zosconnect.internal.xform.DataXformImpl

        bindFileLoc, bindFileSuffix, CFG_AD_BIND_FILE_LOC, CFG_AD_BIND_FILE_SUFFIX, CFG_AD_POLLING_REATE, CFG_AD_REQUEST_SCHEMA_LOC, CFG_AD_REQUEST_SCHEMA_SUFFIX, CFG_AD_RESPONSE_SCHEMA_LOC, CFG_AD_RESPONSE_SCHEMA_SUFFIX, CFG_AD_UPDATE_TRIGGER, CFG_AD_UPDATE_TRIGGER_DISABLED, CFG_AD_UPDATE_TRIGGER_MBEAN, CFG_AD_UPDATE_TRIGGER_POLLED, preserveInvokeJsonPayloadCharFormat, PROVIDER_NAME

    • Constructor Summary

      Constructors 
      Constructor and Description
      SarDataXform(byte[] bindFile, com.ibm.json.java.JSONObject requestSchema, com.ibm.json.java.JSONObject responseSchema, java.lang.String sarFileName) 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      protected java.io.InputStream getBindFileStream(java.lang.String serviceName) 
      com.ibm.json.java.JSONObject getRequestSchema(java.lang.String serviceName)
      Returns the request schema.
      java.lang.String getRequestSchemaString(java.lang.String serviceName)
      Returns the request schema in string form.
      com.ibm.json.java.JSONObject getResponseSchema(java.lang.String serviceName)
      Returns the response schema.
      java.lang.String getResponseSchemaString(java.lang.String serviceName)
      Returns the response schema in string form.

      • Methods inherited from class com.ibm.zosconnect.internal.xform.DataXformImpl

        activate, deactivate, getApplicationDataBlock, getApplicationDataBlock, getApplicationDataBlock, getApplicationDataBlock, getApplicationDataMap, getApplicationDataMap, getApplicationDataMap, getApplicationDataMap, getApplicationDataStructureType, getBytes, getBytes, getChanges, getEncoding, getJSON, getJSON, getJSON, getJSON, getJSON, getJSONString, getJSONString, getJSONString, getJSONString, getJSONString, getProviderName, getRequestPayloadDataSize, getResponsePayloadDataSize, isValidLocationString, modified, registerMonitor, setPreserveJSONObjectPayloadOrder, setPreserveJsonPayloadCharFormat, unregisterMonitors

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SarDataXform

        public SarDataXform(byte[] bindFile,
                    com.ibm.json.java.JSONObject requestSchema,
                    com.ibm.json.java.JSONObject responseSchema,
                    java.lang.String sarFileName)

    • Method Detail

      • getBindFileStream

        protected java.io.InputStream getBindFileStream(java.lang.String serviceName)
                                         throws java.io.FileNotFoundException
        Overrides:
        getBindFileStream in class com.ibm.zosconnect.internal.xform.DataXformImpl
        Parameters:
        serviceName - The service name used to construct the file name (serviceName with the bind file suffix)
        Returns:
        An InputStream backed by the bind file
        Throws:
        java.io.FileNotFoundException - if the bind file for the service does not exist

      • getRequestSchema

        public com.ibm.json.java.JSONObject getRequestSchema(java.lang.String serviceName)
        Description copied from class: com.ibm.zosconnect.internal.xform.DataXformImpl
        Returns the request schema.
        Specified by:
        getRequestSchema in interface DataXform
        Specified by:
        getRequestSchema in interface com.ibm.zosconnect.spi.internal.ext.StructuredDataXform
        Overrides:
        getRequestSchema in class com.ibm.zosconnect.internal.xform.DataXformImpl
        Parameters:
        serviceName - The name of the service
        Returns:
        The schema as a JSON object.

      • getResponseSchema

        public com.ibm.json.java.JSONObject getResponseSchema(java.lang.String serviceName)
        Description copied from class: com.ibm.zosconnect.internal.xform.DataXformImpl
        Returns the response schema.
        Specified by:
        getResponseSchema in interface DataXform
        Specified by:
        getResponseSchema in interface com.ibm.zosconnect.spi.internal.ext.StructuredDataXform
        Overrides:
        getResponseSchema in class com.ibm.zosconnect.internal.xform.DataXformImpl
        Parameters:
        serviceName - The name of the service
        Returns:
        The schema as a JSON object.

      • getRequestSchemaString

        public java.lang.String getRequestSchemaString(java.lang.String serviceName)
        Description copied from class: com.ibm.zosconnect.internal.xform.DataXformImpl
        Returns the request schema in string form.
        Specified by:
        getRequestSchemaString in interface DataXformExt
        Overrides:
        getRequestSchemaString in class com.ibm.zosconnect.internal.xform.DataXformImpl
        Parameters:
        serviceName - The name of the service.
        Returns:
        The JSON schema as a string.

      • getResponseSchemaString

        public java.lang.String getResponseSchemaString(java.lang.String serviceName)
        Description copied from class: com.ibm.zosconnect.internal.xform.DataXformImpl
        Returns the response schema in string form.
        Specified by:
        getResponseSchemaString in interface DataXformExt
        Overrides:
        getResponseSchemaString in class com.ibm.zosconnect.internal.xform.DataXformImpl
        Parameters:
        serviceName - The name of the service.
        Returns:
        The JSON schema as a string.
Skip navigation links