com.ibm.wsspi.zos.connect

Interface Data

  • All Known Subinterfaces:
    RequestData, ResponseData


    public interface Data
    Defines the set of common request specific data to be shared among different z/OS Connect artifacts.

    This interface is implemented by z/OS Connect.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getAuthorizationAdminGroupName()
      Returns the configured administrator group name to be used for authorization validation.
      java.lang.String getAuthorizationInvokeGroupName()
      Returns the configured invoke group name to be used for authorization validation.
      java.lang.String getAuthorizationOperationsGroupName()
      Returns the configured operations group name to be used for authorization validation.
      java.lang.String getInputPayload()
      Returns a String representation of a input payload.
      boolean getInterceptorPreInvokeFailed()
      Returns a boolean value indicating that an exception was thrown by an interceptor.
      java.lang.String getOutputPayload()
      Returns a String representation of a output payload.
      byte[] getRequestID()
      Returns a 23 byte request ID.
      java.lang.String getServiceDescription()
      Returns the configured description of the service associated with the request.
      java.lang.String getServiceGroupingName()
      Returns the configured grouping name that can be used to associate a set of services together.
      java.lang.String getServiceName()
      Returns the service name associated to the request.
      boolean isDataTranformationAvailable()
      Returns a boolean value indicating that a data transformation service is available for the request.
    • Method Detail

      • getInputPayload

        java.lang.String getInputPayload()
        Returns a String representation of a input payload.
        Returns:
        The String representation of a payload. Null if there is no payload or if an java.io.IOException took place while processing the payload.
      • getOutputPayload

        java.lang.String getOutputPayload()
        Returns a String representation of a output payload.
        Returns:
        The String representation of a response payload. Null if there is no payload or if an IOException was thrown while processing the payload.
      • getServiceName

        java.lang.String getServiceName()
        Returns the service name associated to the request.
        Returns:
        The service name associated to the request.
      • getServiceDescription

        java.lang.String getServiceDescription()
        Returns the configured description of the service associated with the request.
        Returns:
        The description of the service associated with the request. Null, if not configured.
      • getServiceGroupingName

        java.lang.String getServiceGroupingName()
        Returns the configured grouping name that can be used to associate a set of services together.
        Returns:
        The grouping name that can be used to associate a set of services together. Null, if not configured.
      • getAuthorizationAdminGroupName

        java.lang.String getAuthorizationAdminGroupName()
        Returns the configured administrator group name to be used for authorization validation.
        Returns:
        The administrator group name. Null if not configured.
      • getAuthorizationOperationsGroupName

        java.lang.String getAuthorizationOperationsGroupName()
        Returns the configured operations group name to be used for authorization validation.
        Returns:
        The operations group name. Null if not configured.
      • getAuthorizationInvokeGroupName

        java.lang.String getAuthorizationInvokeGroupName()
        Returns the configured invoke group name to be used for authorization validation.
        Returns:
        The invoke group name. Null if not configured.
      • getInterceptorPreInvokeFailed

        boolean getInterceptorPreInvokeFailed()
        Returns a boolean value indicating that an exception was thrown by an interceptor. The request has failed and will immediately exit after postInvoke is driven on the interceptor that reported the error and those interceptors that successfully completed processing preInvoke.
        Returns:
        True if an exception was thrown by an interceptor during preInvoke.
      • isDataTranformationAvailable

        boolean isDataTranformationAvailable()
        Returns a boolean value indicating that a data transformation service is available for the request.
        Returns:
        True if a data transformation service is available. False, otherwise.
      • getRequestID

        byte[] getRequestID()
        Returns a 23 byte request ID.
        Returns:
        A 23 byte request ID.