Package com.onenetwork.platform.integ.msg

Class OutboundProcessingContext

java.lang.Object
com.onenetwork.platform.integ.msg.OutboundProcessingContext
Direct Known Subclasses:
ModelOutboundProcessingContext, NetChangeOutboundProcessingContext, SysIdOutboundProcessingContext
public abstract class OutboundProcessingContext
extends java.lang.Object
Base class for the context provided to outbound processors.

  • Constructor Details

    • OutboundProcessingContext

      public OutboundProcessingContext​(java.lang.String outboundInterfaceName, java.lang.String OutboundInterfaceVersion, java.io.OutputStream outputStream, PlatformUserContext platformUserContext)
      Parameters:
      outboundInterfaceName - outbound interface name
      outboundInterfaceVersion - outbound interface version (can use null to indicate most recent version)
      outputStream - OutputStream into which the outbound message should be written
      platformUserContext - - VC level user or an user under a VC

  • Method Details

    • getOutboundInterfaceName

      public java.lang.String getOutboundInterfaceName()
      Returns:
      name of the interface being invoked

    • getOutboundInterfaceVersion

      public java.lang.String getOutboundInterfaceVersion()
      Returns:
      version of the interface being invoked

    • getOutputStream

      public java.io.OutputStream getOutputStream()
      Returns:
      the outputStream to which the outbound file should be written by the generator

    • getPlatformUserContext

      public PlatformUserContext getPlatformUserContext()
      Returns:
      context of the user invoking the outbound integration

    • getRequest

      public OutboundInterfaceWriteRequest getRequest()
      Sets the outboundInterfaceWriteRequest which initiated outbound generation.

    • setRequest

      public void setRequest​(OutboundInterfaceWriteRequest request)

    • addMessageDetail

      public void addMessageDetail​(java.lang.String strRecordIdentifier, java.lang.String strPrimaryRefTransNumber, java.lang.String strModelType, java.lang.String strRawData)
      Convenience method to generate MessageDetail for a record. Custom outbound generator should use this method instead of using MessageDetailService since it requires Message object for creating MessageDetail.

      Parameters:
      strRecordIdentifier - record identifier, for example row number
      strPrimaryRefTransNumber - reference number for the business transaction this message detail affected
      strModelType - model type of the business transaction this message detail affected
      strRawData - raw data of the message detail (for example CSV row content)

    • getMessageDetails

      public java.util.List<MessageDetail> getMessageDetails()
      Returns:
      List of MessageDetail which are added by Custom outbound generator