Interface OAGISService
- All Superinterfaces:
Service
public interface OAGISService extends Service
OAGISService is used when processing OAGIS messages.
It covers activities such as:
- Creating an OAGIS from File
- Getting InboundMapper for OAGIS
- Getting OutboundMapper for OAGIS
-
Method Summary
Modifier and Type Method Description EdiMessageQueue
buildEdiMessageQueueForOutbound(java.lang.Object oagis, EDIMessagingContext ediMessagingContext)
Creates the EDIMessageQueue object and populates with the default values from the EDIMessagingContextvoid
createOAGISXML(java.lang.Object oagis, java.lang.String oagisVersion, java.io.Writer writer, EDIMessagingContext ediMessagingContext, ModelOutboundProcessingContext processingContext, boolean isSkipValidation)
This method is used to write an OAGIS object in "XML" file format to a writer.Message
createOutboundMessage(ModelOutboundProcessingContext processingContext)
Create outbound message from the OB processing contextvoid
enqueueInNewTransaction(Message outboundMessage, PlatformUserContext platformUserContext)
Create outbound message from the OB processing contextOAGISMapper
getInboundMapper(EDIMessagingContext ediMsgContext)
This method uses the EDIInboundRoute data to determine the Inbound Interface and hence the inbound mapper class name for the particular OAGIS message.javax.xml.bind.JAXBElement<?>
getOAGISObject(java.lang.String payload)
OAGISMapper
getOutboundMapper(java.lang.Long senderOrgId, java.lang.Long receiverOrgId, EDIMessagingContext ediMessagingContext, QueueRef queueRef)
This method uses the EDIOutboundRoute data to determine the Outbound Interface and hence the outbound mapper class name for the particular OAGIS message.java.util.List<java.lang.Long>
getSysIdsForOutboundGeneration(NetChangeOutboundProcessingContext processingContext, BaseOAGISOutboundGenerator baseOAGISOutboundGenerator)
Gets a list of SysIds for the models for which outbound OAGIS has to be generatedvoid
updateEdiMessageQueues(java.util.List<EdiMessageQueue> ediMsgQueuesToUpdate, EDIMessagingContext ediMessagingContext)
Updates EDIMessageQueues
-
Method Details
-
createOAGISXML
void createOAGISXML(java.lang.Object oagis, java.lang.String oagisVersion, java.io.Writer writer, EDIMessagingContext ediMessagingContext, ModelOutboundProcessingContext processingContext, boolean isSkipValidation) throws java.lang.ExceptionThis method is used to write an OAGIS object in "XML" file format to a writer.- Throws:
java.lang.Exception
-
getOutboundMapper
OAGISMapper getOutboundMapper(java.lang.Long senderOrgId, java.lang.Long receiverOrgId, EDIMessagingContext ediMessagingContext, QueueRef queueRef)This method uses the EDIOutboundRoute data to determine the Outbound Interface and hence the outbound mapper class name for the particular OAGIS message.- Parameters:
senderOrgId
- sender of the OAGISreceiverOrgId
- receiver of the OAGISediMsgContext
- messaging contextqueueRef
- queue into which the message will be placed- Returns:
- implementation of OAGISMapper class to process the OAGIS File.
-
buildEdiMessageQueueForOutbound
EdiMessageQueue buildEdiMessageQueueForOutbound(java.lang.Object oagis, EDIMessagingContext ediMessagingContext) throws java.lang.ExceptionCreates the EDIMessageQueue object and populates with the default values from the EDIMessagingContext- Parameters:
ediMsgContext
-- Returns:
- EdiMessageQueue
- Throws:
java.lang.Exception
-
createOutboundMessage
Create outbound message from the OB processing context- Parameters:
outboundProcessingContext
-- Returns:
- outbound message created
-
enqueueInNewTransaction
Create outbound message from the OB processing context- Parameters:
outboundProcessingContext
-
-
updateEdiMessageQueues
void updateEdiMessageQueues(java.util.List<EdiMessageQueue> ediMsgQueuesToUpdate, EDIMessagingContext ediMessagingContext)Updates EDIMessageQueues- Parameters:
ediMessageQueues
-ediMsgContext
-
-
getSysIdsForOutboundGeneration
java.util.List<java.lang.Long> getSysIdsForOutboundGeneration(NetChangeOutboundProcessingContext processingContext, BaseOAGISOutboundGenerator baseOAGISOutboundGenerator)Gets a list of SysIds for the models for which outbound OAGIS has to be generated- Parameters:
processingContext
- -NetChangeOutboundProcessingContext
objectbaseOAGISOutboundGenerator
- - Subclass of BaseNetChangeEDIOutboundGenerator used for outbound OAGIS generation- Returns:
- list of sysIds of the models between start and end time specified by NetChangeEDIOutboundGenerator
-
getInboundMapper
This method uses the EDIInboundRoute data to determine the Inbound Interface and hence the inbound mapper class name for the particular OAGIS message.- Parameters:
ediMsgContext
- messaging context- Returns:
- implementation of OAGISMapper class to process the OAGIS File.
-
getOAGISObject
javax.xml.bind.JAXBElement<?> getOAGISObject(java.lang.String payload) throws javax.xml.bind.JAXBException, javax.xml.stream.XMLStreamException, java.lang.ClassNotFoundException- Throws:
javax.xml.bind.JAXBException
javax.xml.stream.XMLStreamException
java.lang.ClassNotFoundException
-