use of com.helger.phase4.servlet.IAS4MessageState in project phase4 by phax.
the class AS4RequestHandler method _invokeSPIsForIncoming.
/**
* Invoke custom SPI message processors
*
* @param aHttpHeaders
* The received HTTP headers. Never <code>null</code>.
* @param aEbmsUserMessage
* Current user message. Either this OR signal message must be
* non-<code>null</code>.
* @param aEbmsSignalMessage
* The signal message to use. Either this OR user message must be
* non-<code>null</code>.
* @param aPayloadNode
* Optional SOAP body payload (only if direct SOAP msg, not for MIME).
* May be <code>null</code>.
* @param aDecryptedAttachments
* Original attachments from source message. May be <code>null</code>.
* @param aPMode
* PMode to be used - may be <code>null</code> for Receipt messages.
* @param aState
* The current state. Never <code>null</<code></code>.
* @param aErrorMessagesTarget
* The list of error messages to be filled if something goes wrong.
* Never <code>null</code>.
* @param aResponseAttachmentsTarget
* The list of attachments to be added to the response. Never
* <code>null</code>.
* @param aSPIResult
* The result object to be filled. May not be <code>null</code>.
*/
private void _invokeSPIsForIncoming(@Nonnull final HttpHeaderMap aHttpHeaders, @Nullable final Ebms3UserMessage aEbmsUserMessage, @Nullable final Ebms3SignalMessage aEbmsSignalMessage, @Nullable final Node aPayloadNode, @Nullable final ICommonsList<WSS4JAttachment> aDecryptedAttachments, @Nullable final IPMode aPMode, @Nonnull final IAS4MessageState aState, @Nonnull final ICommonsList<Ebms3Error> aErrorMessagesTarget, @Nonnull final ICommonsList<WSS4JAttachment> aResponseAttachmentsTarget, @Nonnull final SPIInvocationResult aSPIResult) {
ValueEnforcer.isTrue(aEbmsUserMessage != null || aEbmsSignalMessage != null, "User OR Signal Message must be present");
ValueEnforcer.isFalse(aEbmsUserMessage != null && aEbmsSignalMessage != null, "Only one of User OR Signal Message may be present");
final boolean bIsUserMessage = aEbmsUserMessage != null;
final String sMessageID = bIsUserMessage ? aEbmsUserMessage.getMessageInfo().getMessageId() : aEbmsSignalMessage.getMessageInfo().getMessageId();
// Get all processors
final ICommonsList<IAS4ServletMessageProcessorSPI> aAllProcessors = m_aProcessorSupplier.get();
if (LOGGER.isDebugEnabled())
LOGGER.debug("Trying to invoke the following " + aAllProcessors.size() + " SPIs on message ID '" + sMessageID + "': " + aAllProcessors);
if (aAllProcessors.isEmpty())
LOGGER.error("No IAS4ServletMessageProcessorSPI is available to process an incoming message");
// Invoke ALL non-null SPIs
for (final IAS4ServletMessageProcessorSPI aProcessor : aAllProcessors) if (aProcessor != null)
try {
if (LOGGER.isDebugEnabled())
LOGGER.debug("Invoking AS4 message processor " + aProcessor + " for incoming message");
// Main processing
final AS4MessageProcessorResult aResult;
final ICommonsList<Ebms3Error> aProcessingErrorMessages = new CommonsArrayList<>();
if (bIsUserMessage) {
aResult = aProcessor.processAS4UserMessage(m_aMessageMetadata, aHttpHeaders, aEbmsUserMessage, aPMode, aPayloadNode, aDecryptedAttachments, aState, aProcessingErrorMessages);
} else {
aResult = aProcessor.processAS4SignalMessage(m_aMessageMetadata, aHttpHeaders, aEbmsSignalMessage, aPMode, aState, aProcessingErrorMessages);
}
// Result returned?
if (aResult == null)
throw new IllegalStateException("No result object present from AS4 message processor " + aProcessor + " - this is a programming error");
if (aProcessingErrorMessages.isNotEmpty() || aResult.isFailure()) {
if (aProcessingErrorMessages.isNotEmpty()) {
if (LOGGER.isDebugEnabled())
LOGGER.debug("AS4 message processor " + aProcessor + " had processing errors - breaking. Details: " + aProcessingErrorMessages);
if (aResult.isSuccess())
LOGGER.warn("Processing errors are present but success was returned by a previous AS4 message processor " + aProcessor + " - considering the whole processing to be failed instead");
aErrorMessagesTarget.addAll(aProcessingErrorMessages);
}
if (aResult.isFailure() && aResult.hasErrorMessage()) {
aErrorMessagesTarget.add(EEbmsError.EBMS_OTHER.getAsEbms3Error(m_aLocale, sMessageID, "Invoked AS4 message processor SPI " + aProcessor + " on '" + sMessageID + "' returned a failure: " + aResult.getErrorMessage()));
}
// Stop processing
return;
}
// SPI invocation returned success and no errors
{
final String sAsyncResultURL = aResult.getAsyncResponseURL();
if (StringHelper.hasText(sAsyncResultURL)) {
// URL present
if (aSPIResult.hasAsyncResponseURL()) {
// A second processor returned a response URL - not allowed
final String sErrorMsg = "Invoked AS4 message processor SPI " + aProcessor + " on '" + sMessageID + "' failed: the previous processor already returned an async response URL; it is not possible to handle two URLs. Please check your SPI implementations.";
LOGGER.error(sErrorMsg);
aErrorMessagesTarget.add(EEbmsError.EBMS_VALUE_INCONSISTENT.getAsEbms3Error(m_aLocale, sMessageID, sErrorMsg));
// Stop processing
return;
}
aSPIResult.setAsyncResponseURL(sAsyncResultURL);
LOGGER.info("Using asynchronous response URL '" + sAsyncResultURL + "' for message ID '" + sMessageID + "'");
}
}
if (bIsUserMessage) {
// User message specific processing result handling
// empty
} else {
// Signal message specific processing result handling
assert aResult instanceof AS4SignalMessageProcessorResult;
if (aEbmsSignalMessage.getReceipt() == null) {
final Ebms3UserMessage aPullReturnUserMsg = ((AS4SignalMessageProcessorResult) aResult).getPullReturnUserMessage();
if (aSPIResult.hasPullReturnUserMsg()) {
// to the pullrequest initiator
if (aPullReturnUserMsg != null) {
final String sErrorMsg = "Invoked AS4 message processor SPI " + aProcessor + " on '" + sMessageID + "' failed: the previous processor already returned a usermessage; it is not possible to return two usermessage. Please check your SPI implementations.";
LOGGER.warn(sErrorMsg);
aErrorMessagesTarget.add(EEbmsError.EBMS_VALUE_INCONSISTENT.getAsEbms3Error(m_aLocale, sMessageID, sErrorMsg));
// Stop processing
return;
}
} else {
// Initial return user msg
if (aPullReturnUserMsg == null) {
// No message contained in the MPC
final String sErrorMsg = "Invoked AS4 message processor SPI " + aProcessor + " on '" + sMessageID + "' returned a failure: no UserMessage contained in the MPC";
LOGGER.warn(sErrorMsg);
aErrorMessagesTarget.add(EEbmsError.EBMS_EMPTY_MESSAGE_PARTITION_CHANNEL.getAsEbms3Error(m_aLocale, sMessageID, sErrorMsg));
// Stop processing
return;
}
// We have something :)
aSPIResult.setPullReturnUserMsg(aPullReturnUserMsg);
}
} else {
if (LOGGER.isDebugEnabled())
LOGGER.debug("The AS4 EbmsSignalMessage already has a Receipt");
}
}
// Add response attachments, payloads
aResult.addAllAttachmentsTo(aResponseAttachmentsTarget);
if (LOGGER.isDebugEnabled())
LOGGER.debug("Successfully invoked AS4 message processor " + aProcessor);
} catch (final AS4DecompressException ex) {
LOGGER.error("Failed to decompress AS4 payload", ex);
// Hack for invalid GZip content from WSS4JAttachment.getSourceStream
aErrorMessagesTarget.add(EEbmsError.EBMS_DECOMPRESSION_FAILURE.getAsEbms3Error(m_aLocale, sMessageID));
return;
} catch (final RuntimeException ex) {
// Re-throw
throw ex;
} catch (final Exception ex) {
throw new IllegalStateException("Error processing incoming AS4 message with processor " + aProcessor, ex);
}
// Remember success
aSPIResult.setSuccess(true);
}
use of com.helger.phase4.servlet.IAS4MessageState in project phase4 by phax.
the class AS4RequestHandler method _handleSoapMessage.
@Nullable
private IAS4ResponseFactory _handleSoapMessage(@Nonnull final HttpHeaderMap aHttpHeaders, @Nonnull final Document aSoapDocument, @Nonnull final ESoapVersion eSoapVersion, @Nonnull final ICommonsList<WSS4JAttachment> aIncomingAttachments, @Nonnull final ICommonsList<Ebms3Error> aErrorMessagesTarget) throws WSSecurityException, MessagingException, Phase4Exception {
final SOAPHeaderElementProcessorRegistry aRegistry = SOAPHeaderElementProcessorRegistry.createDefault(m_aPModeResolver, m_aCryptoFactory, (IPMode) null);
final IAS4MessageState aState = AS4IncomingHandler.processEbmsMessage(m_aResHelper, m_aLocale, aRegistry, aHttpHeaders, aSoapDocument, eSoapVersion, aIncomingAttachments, m_aIncomingProfileSelector, aErrorMessagesTarget);
final IPMode aPMode = aState.getPMode();
final PModeLeg aEffectiveLeg = aState.getEffectivePModeLeg();
final String sMessageID = aState.getMessageID();
final ICommonsList<WSS4JAttachment> aDecryptedAttachments = aState.hasDecryptedAttachments() ? aState.getDecryptedAttachments() : aState.getOriginalAttachments();
final Node aPayloadNode = aState.getSoapBodyPayloadNode();
final Ebms3UserMessage aEbmsUserMessage = aState.getEbmsUserMessage();
final Ebms3SignalMessage aEbmsSignalMessage = aState.getEbmsSignalMessage();
if (aState.isSoapHeaderElementProcessingSuccessful()) {
final String sProfileID = aState.getProfileID();
if (LOGGER.isDebugEnabled())
LOGGER.debug("No checking for duplicate message with message ID '" + sMessageID + "' and profile ID '" + sProfileID + "'");
final boolean bIsDuplicate = MetaAS4Manager.getIncomingDuplicateMgr().registerAndCheck(sMessageID, sProfileID, aPMode == null ? null : aPMode.getID()).isBreak();
if (bIsDuplicate) {
LOGGER.error("Not invoking SPIs, because message with Message ID '" + sMessageID + "' was already handled!");
aErrorMessagesTarget.add(EEbmsError.EBMS_OTHER.getAsEbms3Error(m_aLocale, sMessageID, "Another message with the same Message ID '" + sMessageID + "' was already received!"));
} else {
if (LOGGER.isDebugEnabled())
LOGGER.debug("Message is not a duplicate");
}
}
final SPIInvocationResult aSPIResult = new SPIInvocationResult();
// Storing for two-way response messages
final ICommonsList<WSS4JAttachment> aResponseAttachments = new CommonsArrayList<>();
// Invoke SPIs if
// * No errors so far (sign, encrypt, ...)
// * Valid PMode
// * Exactly one UserMessage or SignalMessage
// * No ping/test message
// * No Duplicate message ID
final boolean bCanInvokeSPIs = aErrorMessagesTarget.isEmpty() && !aState.isPingMessage();
if (bCanInvokeSPIs) {
// PMode may be null for receipts
if (aPMode == null || aPMode.getMEPBinding().isSynchronous() || aPMode.getMEPBinding().isAsynchronousInitiator() || aState.getEffectivePModeLegNumber() != 1) {
// Call synchronous
// Might add to aErrorMessages
// Might add to aResponseAttachments
// Might add to m_aPullReturnUserMsg
_invokeSPIsForIncoming(aHttpHeaders, aEbmsUserMessage, aEbmsSignalMessage, aPayloadNode, aDecryptedAttachments, aPMode, aState, aErrorMessagesTarget, aResponseAttachments, aSPIResult);
if (aSPIResult.isFailure())
LOGGER.warn("Error invoking synchronous SPIs");
else if (LOGGER.isDebugEnabled())
LOGGER.debug("Successfully invoked synchronous SPIs");
if (m_aSoapProcessingFinalizedCB != null)
m_aSoapProcessingFinalizedCB.onProcessingFinalized(true);
} else {
// Call asynchronous
// Only leg1 can be async!
final IThrowingRunnable<Exception> r = () -> {
// Start async
final ICommonsList<Ebms3Error> aLocalErrorMessages = new CommonsArrayList<>();
final ICommonsList<WSS4JAttachment> aLocalResponseAttachments = new CommonsArrayList<>();
final SPIInvocationResult aAsyncSPIResult = new SPIInvocationResult();
_invokeSPIsForIncoming(aHttpHeaders, aEbmsUserMessage, aEbmsSignalMessage, aPayloadNode, aDecryptedAttachments, aPMode, aState, aLocalErrorMessages, aLocalResponseAttachments, aAsyncSPIResult);
final IAS4ResponseFactory aAsyncResponseFactory;
final String sResponseMessageID;
if (aAsyncSPIResult.isSuccess()) {
// SPI processing succeeded
assert aLocalErrorMessages.isEmpty();
// The response user message has no explicit payload. All data of
// the response user message is in the local attachments
sResponseMessageID = MessageHelperMethods.createRandomMessageID();
final AS4UserMessage aResponseUserMsg = _createReversedUserMessage(eSoapVersion, sResponseMessageID, aEbmsUserMessage, aLocalResponseAttachments);
// Send UserMessage
final AS4SigningParams aSigningParams = new AS4SigningParams().setFromPMode(aEffectiveLeg.getSecurity());
// Use the original receiver ID as the alias into the keystore for
// encrypting the response message
final String sEncryptionAlias = aEbmsUserMessage.getPartyInfo().getTo().getPartyIdAtIndex(0).getValue();
final AS4CryptParams aCryptParams = new AS4CryptParams().setFromPMode(aEffectiveLeg.getSecurity()).setAlias(sEncryptionAlias);
aAsyncResponseFactory = _createResponseUserMessage(aState, aEffectiveLeg.getProtocol().getSoapVersion(), aResponseUserMsg, aResponseAttachments, aSigningParams, aCryptParams);
} else {
// SPI processing failed
// Send ErrorMessage Undefined - see
// https://github.com/phax/phase4/issues/4
final AS4ErrorMessage aResponseErrorMsg = AS4ErrorMessage.create(eSoapVersion, aState.getMessageID(), aLocalErrorMessages);
sResponseMessageID = aResponseErrorMsg.getEbms3SignalMessage().getMessageInfo().getMessageId();
// Pass error messages to the outside
if (m_aErrorConsumer != null && aLocalErrorMessages.isNotEmpty())
m_aErrorConsumer.onAS4ErrorMessage(aState, aLocalErrorMessages, aResponseErrorMsg);
aAsyncResponseFactory = new AS4ResponseFactoryXML(m_aMessageMetadata, aState, sResponseMessageID, aResponseErrorMsg.getAsSoapDocument(), eSoapVersion.getMimeType());
}
// where to send it back (must be determined by SPI!)
final String sAsyncResponseURL = aAsyncSPIResult.getAsyncResponseURL();
if (StringHelper.hasNoText(sAsyncResponseURL))
throw new IllegalStateException("No asynchronous response URL present - please check your SPI implementation");
if (LOGGER.isDebugEnabled())
LOGGER.debug("Responding asynchronous to: " + sAsyncResponseURL);
// Ensure HttpEntity is repeatable
HttpEntity aHttpEntity = aAsyncResponseFactory.getHttpEntityForSending(eSoapVersion.getMimeType());
aHttpEntity = m_aResHelper.createRepeatableHttpEntity(aHttpEntity);
// Use the prebuilt entity for dumping
_invokeSPIsForResponse(aState, aAsyncResponseFactory, aHttpEntity, eSoapVersion.getMimeType(), sResponseMessageID);
// invoke client with new document
final BasicHttpPoster aSender = new BasicHttpPoster();
final Document aAsyncResponse;
if (true) {
final HttpHeaderMap aResponseHttpHeaders = null;
// TODO make async send parameters customizable
final HttpRetrySettings aRetrySettings = new HttpRetrySettings();
aAsyncResponse = aSender.sendGenericMessageWithRetries(sAsyncResponseURL, aResponseHttpHeaders, aHttpEntity, sMessageID, aRetrySettings, new ResponseHandlerXml(), m_aOutgoingDumper, m_aRetryCallback);
} else {
aAsyncResponse = aSender.sendGenericMessage(sAsyncResponseURL, null, aHttpEntity, new ResponseHandlerXml());
}
AS4HttpDebug.debug(() -> "SEND-RESPONSE [async sent] received: " + XMLWriter.getNodeAsString(aAsyncResponse, AS4HttpDebug.getDebugXMLWriterSettings()));
};
final CompletableFuture<Void> aFuture = PhotonWorkerPool.getInstance().runThrowing(CAS4.LIB_NAME + " async processing", r);
if (m_aSoapProcessingFinalizedCB != null) {
// Give the outside world the possibility to get notified when the
// processing is done
aFuture.thenRun(() -> m_aSoapProcessingFinalizedCB.onProcessingFinalized(false));
}
}
}
// Try building error message
final String sResponseMessageID;
final IAS4ResponseFactory ret;
if (!aState.isSoapHeaderElementProcessingSuccessful() || aState.getEbmsError() == null) {
// Not an incoming Ebms Error Message
if (aErrorMessagesTarget.isNotEmpty()) {
if (LOGGER.isDebugEnabled())
LOGGER.debug("Creating AS4 error message with these " + aErrorMessagesTarget.size() + " errors: " + aErrorMessagesTarget.getAllMapped(Ebms3Error::getDescriptionValue));
final AS4ErrorMessage aResponseErrorMsg = AS4ErrorMessage.create(eSoapVersion, aState.getMessageID(), aErrorMessagesTarget);
// Call optional consumer
if (m_aErrorConsumer != null)
m_aErrorConsumer.onAS4ErrorMessage(aState, aErrorMessagesTarget, aResponseErrorMsg);
// When aLeg == null, the response is true
if (_isSendErrorAsResponse(aEffectiveLeg)) {
sResponseMessageID = aResponseErrorMsg.getEbms3SignalMessage().getMessageInfo().getMessageId();
ret = new AS4ResponseFactoryXML(m_aMessageMetadata, aState, sResponseMessageID, aResponseErrorMsg.getAsSoapDocument(), eSoapVersion.getMimeType());
} else {
LOGGER.warn("Not sending back the error, because sending error response is prohibited in PMode");
sResponseMessageID = null;
ret = null;
}
} else {
// Do not respond to receipt (except with error message - see above)
if (aEbmsSignalMessage == null || aEbmsSignalMessage.getReceipt() == null) {
// So now the incoming message is a user message or a pull request
if (aPMode.getMEP().isOneWay() || aPMode.getMEPBinding().isAsynchronous()) {
// the pull phase
if (aPMode.getMEPBinding().equals(EMEPBinding.PULL) || (aPMode.getMEPBinding().equals(EMEPBinding.PULL_PUSH) && aSPIResult.hasPullReturnUserMsg()) || (aPMode.getMEPBinding().equals(EMEPBinding.PUSH_PULL) && aSPIResult.hasPullReturnUserMsg())) {
// TODO would be nice to have attachments here I guess
final AS4UserMessage aResponseUserMsg = new AS4UserMessage(eSoapVersion, aSPIResult.getPullReturnUserMsg());
sResponseMessageID = aResponseUserMsg.getEbms3UserMessage().getMessageInfo().getMessageId();
ret = new AS4ResponseFactoryXML(m_aMessageMetadata, aState, sResponseMessageID, aResponseUserMsg.getAsSoapDocument(), eSoapVersion.getMimeType());
} else if (aEbmsUserMessage != null) {
// We received an incoming user message and no errors occurred
final boolean bSendReceiptAsResponse = _isSendReceiptAsResponse(aEffectiveLeg);
if (bSendReceiptAsResponse) {
sResponseMessageID = MessageHelperMethods.createRandomMessageID();
ret = _createResponseReceiptMessage(aState, aSoapDocument, eSoapVersion, sResponseMessageID, aEffectiveLeg, aEbmsUserMessage, aResponseAttachments);
} else {
// TODO what shall we send back here?
LOGGER.info("Not sending back the Receipt response, because sending Receipt response is prohibited in PMode");
sResponseMessageID = null;
ret = null;
}
} else {
sResponseMessageID = null;
ret = null;
}
} else {
// synchronous TWO - WAY (= "SYNC")
final PModeLeg aLeg2 = aPMode.getLeg2();
if (aLeg2 == null)
throw new Phase4Exception("PMode has no leg2!");
if (MEPHelper.isValidResponseTypeLeg2(aPMode.getMEP(), aPMode.getMEPBinding(), EAS4MessageType.USER_MESSAGE)) {
sResponseMessageID = MessageHelperMethods.createRandomMessageID();
final AS4UserMessage aResponseUserMsg = _createReversedUserMessage(eSoapVersion, sResponseMessageID, aEbmsUserMessage, aResponseAttachments);
final AS4SigningParams aSigningParams = new AS4SigningParams().setFromPMode(aLeg2.getSecurity());
final String sEncryptionAlias = aEbmsUserMessage.getPartyInfo().getTo().getPartyIdAtIndex(0).getValue();
final AS4CryptParams aCryptParams = new AS4CryptParams().setFromPMode(aLeg2.getSecurity()).setAlias(sEncryptionAlias);
ret = _createResponseUserMessage(aState, aLeg2.getProtocol().getSoapVersion(), aResponseUserMsg, aResponseAttachments, aSigningParams, aCryptParams);
} else {
sResponseMessageID = null;
ret = null;
}
}
} else {
sResponseMessageID = null;
ret = null;
}
}
} else {
sResponseMessageID = null;
ret = null;
}
// Create the HttpEntity on demand
_invokeSPIsForResponse(aState, ret, null, eSoapVersion.getMimeType(), sResponseMessageID);
return ret;
}
use of com.helger.phase4.servlet.IAS4MessageState in project phase4 by phax.
the class AS4IncomingHandler method _parseMessage.
@Nullable
private static IAS4MessageState _parseMessage(@Nonnull final IAS4CryptoFactory aCryptoFactory, @Nonnull final IPModeResolver aPModeResolver, @Nonnull final IAS4IncomingAttachmentFactory aIAF, @Nonnull final IAS4IncomingProfileSelector aAS4ProfileSelector, @Nonnull @WillNotClose final AS4ResourceHelper aResHelper, @Nullable final IPMode aSendingPMode, @Nonnull final Locale aLocale, @Nonnull final IAS4IncomingMessageMetadata aMessageMetadata, @Nonnull final HttpResponse aHttpResponse, @Nonnull final byte[] aResponsePayload, @Nullable final IAS4IncomingDumper aIncomingDumper) throws Phase4Exception {
// This wrapper will take the result
final Wrapper<IAS4MessageState> aRetWrapper = new Wrapper<>();
// Handler for the parsed message
final IAS4ParsedMessageCallback aCallback = (aHttpHeaders, aSoapDocument, eSoapVersion, aIncomingAttachments) -> {
final ICommonsList<Ebms3Error> aErrorMessages = new CommonsArrayList<>();
// Use the sending PMode as fallback, because from the incoming
// receipt/error it is impossible to detect a PMode
final SOAPHeaderElementProcessorRegistry aRegistry = SOAPHeaderElementProcessorRegistry.createDefault(aPModeResolver, aCryptoFactory, aSendingPMode);
// Parse AS4, verify signature etc
final IAS4MessageState aState = processEbmsMessage(aResHelper, aLocale, aRegistry, aHttpHeaders, aSoapDocument, eSoapVersion, aIncomingAttachments, aAS4ProfileSelector, aErrorMessages);
if (aState.isSoapHeaderElementProcessingSuccessful()) {
// Remember the parsed signal message
aRetWrapper.set(aState);
} else {
throw new Phase4Exception("Error processing AS4 message", aState.getSoapWSS4JException());
}
};
// Create header map from response headers
final HttpHeaderMap aHttpHeaders = new HttpHeaderMap();
for (final Header aHeader : aHttpResponse.getAllHeaders()) aHttpHeaders.addHeader(aHeader.getName(), aHeader.getValue());
try (final NonBlockingByteArrayInputStream aPayloadIS = new NonBlockingByteArrayInputStream(aResponsePayload)) {
// Parse incoming message
parseAS4Message(aIAF, aResHelper, aMessageMetadata, aPayloadIS, aHttpHeaders, aCallback, aIncomingDumper);
} catch (final Phase4Exception ex) {
throw ex;
} catch (final Exception ex) {
throw new Phase4Exception("Error parsing AS4 message", ex);
}
// This one contains the result
return aRetWrapper.get();
}
use of com.helger.phase4.servlet.IAS4MessageState in project phase4 by phax.
the class AS4IncomingHandler method parseUserMessage.
@Nullable
public static Ebms3UserMessage parseUserMessage(@Nonnull final IAS4CryptoFactory aCryptoFactory, @Nonnull final IPModeResolver aPModeResolver, @Nonnull final IAS4IncomingAttachmentFactory aIAF, @Nonnull final IAS4IncomingProfileSelector aAS4ProfileSelector, @Nonnull @WillNotClose final AS4ResourceHelper aResHelper, @Nullable final IPMode aSendingPMode, @Nonnull final Locale aLocale, @Nonnull final IAS4IncomingMessageMetadata aMessageMetadata, @Nonnull final HttpResponse aHttpResponse, @Nonnull final byte[] aResponsePayload, @Nullable final IAS4IncomingDumper aIncomingDumper) throws Phase4Exception {
final IAS4MessageState aState = _parseMessage(aCryptoFactory, aPModeResolver, aIAF, aAS4ProfileSelector, aResHelper, aSendingPMode, aLocale, aMessageMetadata, aHttpResponse, aResponsePayload, aIncomingDumper);
if (aState == null) {
// Error message was already logged
return null;
}
final Ebms3UserMessage ret = aState.getEbmsUserMessage();
if (ret == null) {
if (aState.getEbmsSignalMessage() != null)
LOGGER.warn("A Message state is present, but it contains a SignalMessage instead of a UserMessage.");
else
LOGGER.warn("A Message state is present, but it contains neither a SignalMessage nor a UserMessage.");
}
return ret;
}
use of com.helger.phase4.servlet.IAS4MessageState in project phase4 by phax.
the class AS4IncomingHandler method processEbmsMessage.
@Nonnull
public static IAS4MessageState processEbmsMessage(@Nonnull @WillNotClose final AS4ResourceHelper aResHelper, @Nonnull final Locale aLocale, @Nonnull final SOAPHeaderElementProcessorRegistry aRegistry, @Nonnull final HttpHeaderMap aHttpHeaders, @Nonnull final Document aSoapDocument, @Nonnull final ESoapVersion eSoapVersion, @Nonnull final ICommonsList<WSS4JAttachment> aIncomingAttachments, @Nonnull final IAS4IncomingProfileSelector aAS4ProfileSelector, @Nonnull final ICommonsList<Ebms3Error> aErrorMessagesTarget) throws Phase4Exception {
ValueEnforcer.notNull(aResHelper, "ResHelper");
ValueEnforcer.notNull(aLocale, "Locale");
ValueEnforcer.notNull(aHttpHeaders, "HttpHeaders");
ValueEnforcer.notNull(aSoapDocument, "SoapDocument");
ValueEnforcer.notNull(eSoapVersion, "SoapVersion");
ValueEnforcer.notNull(aIncomingAttachments, "IncomingAttachments");
ValueEnforcer.notNull(aAS4ProfileSelector, "AS4ProfileSelector");
ValueEnforcer.notNull(aErrorMessagesTarget, "aErrorMessagesTarget");
if (LOGGER.isDebugEnabled()) {
LOGGER.debug("Received the following SOAP " + eSoapVersion.getVersion() + " document:");
LOGGER.debug(AS4XMLHelper.serializeXML(aSoapDocument));
if (aIncomingAttachments.isEmpty()) {
LOGGER.debug("Without any incoming attachments");
} else {
LOGGER.debug("Including the following " + aIncomingAttachments.size() + " attachments:");
LOGGER.debug(aIncomingAttachments.toString());
}
}
// This is where all data from the SOAP headers is stored to
final AS4MessageState aState = new AS4MessageState(eSoapVersion, aResHelper, aLocale);
// Handle all headers - modifies the state
_processSoapHeaderElements(aRegistry, aSoapDocument, aIncomingAttachments, aState, aErrorMessagesTarget);
// Remember if header processing was successful or not
final boolean bSoapHeaderElementProcessingSuccess = aErrorMessagesTarget.isEmpty();
aState.setSoapHeaderElementProcessingSuccessful(bSoapHeaderElementProcessingSuccess);
if (bSoapHeaderElementProcessingSuccess) {
// Every message can only contain 1 User message or 1 pull message
// aUserMessage can be null on incoming Pull-Message!
final Ebms3UserMessage aEbmsUserMessage = aState.getEbmsUserMessage();
final Ebms3Error aEbmsError = aState.getEbmsError();
final Ebms3PullRequest aEbmsPullRequest = aState.getEbmsPullRequest();
final Ebms3Receipt aEbmsReceipt = aState.getEbmsReceipt();
// Check payload consistency
final int nCountData = (aEbmsUserMessage != null ? 1 : 0) + (aEbmsPullRequest != null ? 1 : 0) + (aEbmsReceipt != null ? 1 : 0) + (aEbmsError != null ? 1 : 0);
if (nCountData != 1) {
LOGGER.error("Expected a UserMessage(" + (aEbmsUserMessage != null ? 1 : 0) + "), a PullRequest(" + (aEbmsPullRequest != null ? 1 : 0) + "), a Receipt(" + (aEbmsReceipt != null ? 1 : 0) + ") or an Error(" + (aEbmsError != null ? 1 : 0) + ")");
// send EBMS:0001 error back
aErrorMessagesTarget.add(EEbmsError.EBMS_VALUE_NOT_RECOGNIZED.getAsEbms3Error(aLocale, aState.getMessageID()));
}
// Determine AS4 profile ID (since 0.13.0)
final String sProfileID = aAS4ProfileSelector.getAS4ProfileID(aState);
if (LOGGER.isDebugEnabled())
LOGGER.debug("Determined AS4 profile ID '" + sProfileID + "' for current message");
aState.setProfileID(sProfileID);
final IPMode aPMode = aState.getPMode();
final PModeLeg aEffectiveLeg = aState.getEffectivePModeLeg();
if (aEbmsUserMessage != null) {
// User message requires PMode
if (aPMode == null)
throw new Phase4Exception("No AS4 P-Mode configuration found for user-message!");
// Only check leg if the message is a usermessage
if (aEffectiveLeg == null)
throw new Phase4Exception("No AS4 P-Mode leg could be determined!");
// Only do profile checks if a profile is set
if (StringHelper.hasText(sProfileID)) {
// Resolve profile ID
final IAS4Profile aProfile = MetaAS4Manager.getProfileMgr().getProfileOfID(sProfileID);
if (aProfile == null)
throw new IllegalStateException("The configured AS4 profile '" + sProfileID + "' does not exist.");
// Profile Checks gets set when started with Server
final IAS4ProfileValidator aValidator = aProfile.getValidator();
if (aValidator != null) {
if (aAS4ProfileSelector.validateAgainstProfile()) {
final ErrorList aErrorList = new ErrorList();
aValidator.validatePMode(aPMode, aErrorList);
aValidator.validateUserMessage(aEbmsUserMessage, aErrorList);
if (aErrorList.isNotEmpty()) {
throw new Phase4Exception("Error validating incoming AS4 message with the profile " + aProfile.getDisplayName() + "\n Following errors are present: " + aErrorList.getAllErrors().getAllTexts(aLocale));
}
} else {
LOGGER.warn("The AS4 profile '" + sProfileID + "' has a validation configured, but the usage was disabled using the AS4ProfileSelector");
}
}
} else {
if (LOGGER.isDebugEnabled())
LOGGER.debug("AS4 state contains no AS4 profile ID - therefore no consistency checks are performed");
}
// Ensure the decrypted attachments are used
final ICommonsList<WSS4JAttachment> aDecryptedAttachments = aState.hasDecryptedAttachments() ? aState.getDecryptedAttachments() : aState.getOriginalAttachments();
// Decompress attachments (if compressed)
// Result is directly in the decrypted attachments list!
_decompressAttachments(aDecryptedAttachments, aEbmsUserMessage, aState);
} else {
// Pull-request also requires PMode
if (aEbmsPullRequest != null && aPMode == null)
throw new Phase4Exception("No AS4 P-Mode configuration found for pull-request!");
}
final boolean bUseDecryptedSOAP = aState.hasDecryptedSoapDocument();
final Document aRealSOAPDoc = bUseDecryptedSOAP ? aState.getDecryptedSoapDocument() : aSoapDocument;
assert aRealSOAPDoc != null;
// Find SOAP body (mandatory according to SOAP XSD)
final Node aBodyNode = XMLHelper.getFirstChildElementOfName(aRealSOAPDoc.getDocumentElement(), eSoapVersion.getNamespaceURI(), eSoapVersion.getBodyElementName());
if (aBodyNode == null)
throw new Phase4Exception((bUseDecryptedSOAP ? "Decrypted" : "Original") + " SOAP document is missing a Body element");
aState.setSoapBodyPayloadNode(aBodyNode.getFirstChild());
final boolean bIsPingMessage = AS4Helper.isPingMessage(aPMode);
aState.setPingMessage(bIsPingMessage);
if (bIsPingMessage)
LOGGER.info("Received an AS4 Ping message - meaning it will NOT be handled by the custom handlers.");
}
return aState;
}
Aggregations