org.apache.camel.component.as2.api.AS2ClientManager Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.component.as2.api;
import java.io.IOException;
import java.security.PrivateKey;
import java.security.cert.Certificate;
import org.apache.camel.component.as2.api.entity.ApplicationEDIEntity;
import org.apache.camel.component.as2.api.entity.EntityParser;
import org.apache.camel.component.as2.api.entity.MultipartSignedEntity;
import org.apache.camel.component.as2.api.util.EntityUtils;
import org.apache.camel.component.as2.api.util.SigningUtils;
import org.apache.http.HttpException;
import org.apache.http.HttpResponse;
import org.apache.http.entity.ContentType;
import org.apache.http.message.BasicHttpEntityEnclosingRequest;
import org.apache.http.protocol.HttpCoreContext;
import org.apache.http.util.Args;
/**
* AS2 Client Manager
*
*
* Sends EDI Messages over HTTP
*
*/
public class AS2ClientManager {
//
// AS2 HTTP Context Attribute Keys
//
/**
* Prefix for all AS2 HTTP Context Attributes used by the AS2 Client
* Manager.
*/
public static final String CAMEL_AS2_CLIENT_PREFIX = "camel-as2.client.";
/**
* The HTTP Context Attribute indicating the AS2 message structure to be sent.
*/
public static final String AS2_MESSAGE_STRUCTURE = CAMEL_AS2_CLIENT_PREFIX + "as2-message-structure";
/**
* The HTTP Context Attribute indicating the EDI message content type to be sent.
*/
public static final String EDI_MESSAGE_CONTENT_TYPE = CAMEL_AS2_CLIENT_PREFIX + "edi-message-content-type";
/**
* The HTTP Context Attribute indicating the EDI message transfer encoding to be sent.
*/
public static final String EDI_MESSAGE_TRANSFER_ENCODING = CAMEL_AS2_CLIENT_PREFIX + "edi-message-transfer-encoding";
/**
* The HTTP Context Attribute containing the HTTP request message
* transporting the EDI message
*/
public static final String HTTP_REQUEST = HttpCoreContext.HTTP_REQUEST;
/**
* The HTTP Context Attribute containing the HTTP response message
* transporting the EDI message
*/
public static final String HTTP_RESPONSE = HttpCoreContext.HTTP_RESPONSE;
/**
* The HTTP Context Attribute containing the AS2 Connection used to send
* request message.
*/
public static final String AS2_CONNECTION = CAMEL_AS2_CLIENT_PREFIX + "as2-connection";
/**
* The HTTP Context Attribute containing the request URI identifying the
* process on the receiving system responsible for unpacking and handling of
* message data and generating a reply for the sending system that contains
* a Message Disposition Acknowledgement (MDN)
*/
public static final String REQUEST_URI = CAMEL_AS2_CLIENT_PREFIX + "request-uri";
/**
* The HTTP Context Attribute containing the subject header sent in an AS2
* message.
*/
public static final String SUBJECT = CAMEL_AS2_CLIENT_PREFIX + "subject";
/**
* The HTTP Context Attribute containing the internet e-mail address of
* sending system
*/
public static final String FROM = CAMEL_AS2_CLIENT_PREFIX + "from";
/**
* The HTTP Context Attribute containing the AS2 System Identifier of the
* sending system
*/
public static final String AS2_FROM = CAMEL_AS2_CLIENT_PREFIX + "as2-from";
/**
* The HTTP Context Attribute containing the AS2 System Identifier of the
* receiving system
*/
public static final String AS2_TO = CAMEL_AS2_CLIENT_PREFIX + "as2-to";
/**
* The HTTP Context Attribute containing the algorithm name used to sign EDI
* message
*/
public static final String SIGNING_ALGORITHM_NAME = CAMEL_AS2_CLIENT_PREFIX + "signing-algorithm-name";
/**
* The HTTP Context Attribute containing the certificate chain used to sign
* EDI message
*/
public static final String SIGNING_CERTIFICATE_CHAIN = CAMEL_AS2_CLIENT_PREFIX + "signing-certificate-chain";
/**
* The HTTP Context Attribute containing the private key used to sign EDI
* message
*/
public static final String SIGNING_PRIVATE_KEY = CAMEL_AS2_CLIENT_PREFIX + "signing-private-key";
/**
* The HTTP Context Attribute containing the internet e-mail address of
* sending system requesting a message disposition notification.
*/
public static final String DISPOSITION_NOTIFICATION_TO = CAMEL_AS2_CLIENT_PREFIX + "disposition-notification-to";
/**
* The HTTP Context Attribute containing the list of names of the requested MIC algorithms to be used
* by the receiving system to construct a message disposition notification.
*/
public static final String SIGNED_RECEIPT_MIC_ALGORITHMS = CAMEL_AS2_CLIENT_PREFIX + "signed-receipt-mic-algorithms";
//
private AS2ClientConnection as2ClientConnection;
public AS2ClientManager(AS2ClientConnection as2ClientConnection) {
this.as2ClientConnection = as2ClientConnection;
}
/**
* Send ediMessage to trading partner.
*
* @param ediMessage
* - EDI message to transport
* @param requestUri
* - resource location to deliver message
* @param subject - message subject
* @param from - RFC2822 address of sender
* @param as2From - AS2 name of sender
* @param as2To - AS2 name of recipient
* @param as2MessageStructure - the structure of AS2 to send; see {@link AS2MessageStructure}
* @param ediMessageContentType - the content typw of EDI message
* @param ediMessageTransferEncoding - the transfer encoding used to transport EDI message
* @param signingCertificateChain - the chain of certificates used to sign the message or null if sending EDI message unsigned
* @param signingPrivateKey - the private key used to sign EDI message
* @param dispositionNotificationTo - an RFC2822 address to request a receipt or null if no receipt requested
* @param signedReceiptMicAlgorithms - the senders list of signing algorithms for signing receipt, in preferred order, or null if requesting an unsigned receipt.
* @return {@link HttpCoreContext} containing request and response used to send EDI message
* @throws HttpException when things go wrong.
*/
public HttpCoreContext send(String ediMessage,
String requestUri,
String subject,
String from,
String as2From,
String as2To,
AS2MessageStructure as2MessageStructure,
ContentType ediMessageContentType,
String ediMessageTransferEncoding,
Certificate[] signingCertificateChain,
PrivateKey signingPrivateKey,
String dispositionNotificationTo,
String[] signedReceiptMicAlgorithms)
throws HttpException {
Args.notNull(ediMessage, "EDI Message");
Args.notNull(as2MessageStructure, "AS2 Message Structure");
Args.notNull(requestUri, "Request URI");
Args.notNull(ediMessageContentType, "EDI Message Content Type");
// Add Context attributes
HttpCoreContext httpContext = HttpCoreContext.create();
httpContext.setAttribute(AS2ClientManager.REQUEST_URI, requestUri);
httpContext.setAttribute(AS2ClientManager.SUBJECT, subject);
httpContext.setAttribute(AS2ClientManager.FROM, from);
httpContext.setAttribute(AS2ClientManager.AS2_FROM, as2From);
httpContext.setAttribute(AS2ClientManager.AS2_TO, as2To);
httpContext.setAttribute(AS2ClientManager.AS2_MESSAGE_STRUCTURE, as2MessageStructure);
httpContext.setAttribute(AS2ClientManager.EDI_MESSAGE_CONTENT_TYPE, ediMessageContentType);
httpContext.setAttribute(AS2ClientManager.EDI_MESSAGE_TRANSFER_ENCODING, ediMessageTransferEncoding);
httpContext.setAttribute(AS2ClientManager.SIGNING_CERTIFICATE_CHAIN, signingCertificateChain);
httpContext.setAttribute(AS2ClientManager.SIGNING_PRIVATE_KEY, signingPrivateKey);
httpContext.setAttribute(AS2ClientManager.DISPOSITION_NOTIFICATION_TO, dispositionNotificationTo);
httpContext.setAttribute(AS2ClientManager.SIGNED_RECEIPT_MIC_ALGORITHMS, signedReceiptMicAlgorithms);
BasicHttpEntityEnclosingRequest request = new BasicHttpEntityEnclosingRequest("POST", requestUri);
httpContext.setAttribute(HTTP_REQUEST, request);
// Create Message Body
ApplicationEDIEntity applicationEDIEntity;
try {
applicationEDIEntity = EntityUtils.createEDIEntity(ediMessage, ediMessageContentType, ediMessageTransferEncoding, false);
} catch (Exception e) {
throw new HttpException("Failed to create EDI message entity", e);
}
switch (as2MessageStructure) {
case PLAIN:
applicationEDIEntity.setMainBody(true);
EntityUtils.setMessageEntity(request, applicationEDIEntity);
break;
case SIGNED:
AS2SignedDataGenerator gen = createSigningGenerator(httpContext);
// Create Multipart Signed Entity
try {
MultipartSignedEntity multipartSignedEntity = new MultipartSignedEntity(applicationEDIEntity, gen,
AS2Charset.US_ASCII, AS2TransferEncoding.BASE64, true, null);
multipartSignedEntity.setMainBody(true);
EntityUtils.setMessageEntity(request, multipartSignedEntity);
} catch (Exception e) {
throw new HttpException("Failed to sign message", e);
}
break;
case ENCRYPTED:
// TODO : Add code here to add application/pkcs7-mime entity when encryption facility available.
break;
case ENCRYPTED_SIGNED:
// TODO : Add code here to add application/pkcs7-mime entity when encryption facility available.
break;
default:
throw new HttpException("Unknown AS2 Message Structure");
}
HttpResponse response;
try {
httpContext.setAttribute(AS2_CONNECTION, as2ClientConnection);
response = as2ClientConnection.send(request, httpContext);
EntityParser.parseAS2MessageEntity(response);
} catch (IOException e) {
throw new HttpException("Failed to send http request message", e);
}
httpContext.setAttribute(HTTP_RESPONSE, response);
return httpContext;
}
public AS2SignedDataGenerator createSigningGenerator(HttpCoreContext httpContext) throws HttpException {
Certificate[] certificateChain = httpContext.getAttribute(SIGNING_CERTIFICATE_CHAIN, Certificate[].class);
if (certificateChain == null) {
throw new HttpException("Signing certificate chain missing");
}
PrivateKey privateKey = httpContext.getAttribute(SIGNING_PRIVATE_KEY, PrivateKey.class);
if (privateKey == null) {
throw new HttpException("Signing private key missing");
}
return SigningUtils.createSigningGenerator(certificateChain, privateKey);
}
}