Google Git
Sign in
apache / camel / 2dead9b15c598c26bb7c9b7acf694127c38de35b / . / core / camel-endpointdsl / src / main / java / org / apache / camel / builder / endpoint / dsl / AS2EndpointBuilderFactory.java
blob: bf4c928d34c716a9b4e21f21402557c8f10c70a2 [file] [log] [blame]
/*
* 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.builder.endpoint.dsl;
import java.security.PrivateKey;
import java.security.cert.Certificate;
import java.util.Map;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.apache.camel.ExchangePattern;
import org.apache.camel.LoggingLevel;
import org.apache.camel.builder.EndpointConsumerBuilder;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
import org.apache.camel.spi.ExceptionHandler;
import org.apache.camel.spi.PollingConsumerPollStrategy;
/**
* Component used for transferring data secure and reliable over the internet
* using the AS2 protocol.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.maven.packaging.EndpointDslMojo")
public interface AS2EndpointBuilderFactory {
/**
* Builder for endpoint consumers for the AS2 component.
*/
public interface AS2EndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default AdvancedAS2EndpointConsumerBuilder advanced() {
return (AdvancedAS2EndpointConsumerBuilder) this;
}
/**
* The value of the AS2From header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder as2From(String as2From) {
doSetProperty("as2From", as2From);
return this;
}
/**
* The structure of AS2 Message. One of: PLAIN - No encryption, no
* signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption,
* no signature, ENCRYPTED_SIGNED - Encryption, signature.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2MessageStructure</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder as2MessageStructure(
AS2MessageStructure as2MessageStructure) {
doSetProperty("as2MessageStructure", as2MessageStructure);
return this;
}
/**
* The structure of AS2 Message. One of: PLAIN - No encryption, no
* signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption,
* no signature, ENCRYPTED_SIGNED - Encryption, signature.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2MessageStructure</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder as2MessageStructure(
String as2MessageStructure) {
doSetProperty("as2MessageStructure", as2MessageStructure);
return this;
}
/**
* The value of the AS2To header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder as2To(String as2To) {
doSetProperty("as2To", as2To);
return this;
}
/**
* The version of the AS2 protocol.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder as2Version(String as2Version) {
doSetProperty("as2Version", as2Version);
return this;
}
/**
* The Client Fully Qualified Domain Name (FQDN). Used in message ids
* sent by endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder clientFqdn(String clientFqdn) {
doSetProperty("clientFqdn", clientFqdn);
return this;
}
/**
* The algorithm used to compress EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2CompressionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder compressionAlgorithm(
AS2CompressionAlgorithm compressionAlgorithm) {
doSetProperty("compressionAlgorithm", compressionAlgorithm);
return this;
}
/**
* The algorithm used to compress EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2CompressionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder compressionAlgorithm(
String compressionAlgorithm) {
doSetProperty("compressionAlgorithm", compressionAlgorithm);
return this;
}
/**
* The key used to encrypt the EDI message.
*
* The option is a: <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder decryptingPrivateKey(
PrivateKey decryptingPrivateKey) {
doSetProperty("decryptingPrivateKey", decryptingPrivateKey);
return this;
}
/**
* The key used to encrypt the EDI message.
*
* The option will be converted to a
* <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder decryptingPrivateKey(
String decryptingPrivateKey) {
doSetProperty("decryptingPrivateKey", decryptingPrivateKey);
return this;
}
/**
* The value of the Disposition-Notification-To header. Assigning a
* value to this parameter requests a message disposition notification
* (MDN) for the AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder dispositionNotificationTo(
String dispositionNotificationTo) {
doSetProperty("dispositionNotificationTo", dispositionNotificationTo);
return this;
}
/**
* The transfer encoding of EDI message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder ediMessageTransferEncoding(
String ediMessageTransferEncoding) {
doSetProperty("ediMessageTransferEncoding", ediMessageTransferEncoding);
return this;
}
/**
* The content type of EDI message. One of application/edifact,
* application/edi-x12, application/edi-consent.
*
* The option is a: <code>org.apache.http.entity.ContentType</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder ediMessageType(Object ediMessageType) {
doSetProperty("ediMessageType", ediMessageType);
return this;
}
/**
* The content type of EDI message. One of application/edifact,
* application/edi-x12, application/edi-consent.
*
* The option will be converted to a
* <code>org.apache.http.entity.ContentType</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder ediMessageType(String ediMessageType) {
doSetProperty("ediMessageType", ediMessageType);
return this;
}
/**
* The algorithm used to encrypt EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2EncryptionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder encryptingAlgorithm(
AS2EncryptionAlgorithm encryptingAlgorithm) {
doSetProperty("encryptingAlgorithm", encryptingAlgorithm);
return this;
}
/**
* The algorithm used to encrypt EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2EncryptionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder encryptingAlgorithm(
String encryptingAlgorithm) {
doSetProperty("encryptingAlgorithm", encryptingAlgorithm);
return this;
}
/**
* The chain of certificates used to encrypt EDI message.
*
* The option is a: <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder encryptingCertificateChain(
Certificate[] encryptingCertificateChain) {
doSetProperty("encryptingCertificateChain", encryptingCertificateChain);
return this;
}
/**
* The chain of certificates used to encrypt EDI message.
*
* The option will be converted to a
* <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder encryptingCertificateChain(
String encryptingCertificateChain) {
doSetProperty("encryptingCertificateChain", encryptingCertificateChain);
return this;
}
/**
* The value of the From header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder from(String from) {
doSetProperty("from", from);
return this;
}
/**
* Sets the name of a parameter to be passed in the exchange In Body.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder inBody(String inBody) {
doSetProperty("inBody", inBody);
return this;
}
/**
* The template used to format MDN message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder mdnMessageTemplate(
String mdnMessageTemplate) {
doSetProperty("mdnMessageTemplate", mdnMessageTemplate);
return this;
}
/**
* The request URI of EDI message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder requestUri(String requestUri) {
doSetProperty("requestUri", requestUri);
return this;
}
/**
* The value included in the Server message header identifying the AS2
* Server.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder server(String server) {
doSetProperty("server", server);
return this;
}
/**
* The Server Fully Qualified Domain Name (FQDN). Used in message ids
* sent by endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder serverFqdn(String serverFqdn) {
doSetProperty("serverFqdn", serverFqdn);
return this;
}
/**
* The port number of server.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder serverPortNumber(
Integer serverPortNumber) {
doSetProperty("serverPortNumber", serverPortNumber);
return this;
}
/**
* The port number of server.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder serverPortNumber(
String serverPortNumber) {
doSetProperty("serverPortNumber", serverPortNumber);
return this;
}
/**
* The list of algorithms, in order of preference, requested to generate
* a message integrity check (MIC) returned in message dispostion
* notification (MDN).
*
* The option is a: <code>java.lang.String[]</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signedReceiptMicAlgorithms(
String[] signedReceiptMicAlgorithms) {
doSetProperty("signedReceiptMicAlgorithms", signedReceiptMicAlgorithms);
return this;
}
/**
* The list of algorithms, in order of preference, requested to generate
* a message integrity check (MIC) returned in message dispostion
* notification (MDN).
*
* The option will be converted to a <code>java.lang.String[]</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signedReceiptMicAlgorithms(
String signedReceiptMicAlgorithms) {
doSetProperty("signedReceiptMicAlgorithms", signedReceiptMicAlgorithms);
return this;
}
/**
* The algorithm used to sign EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2SignatureAlgorithm</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signingAlgorithm(
AS2SignatureAlgorithm signingAlgorithm) {
doSetProperty("signingAlgorithm", signingAlgorithm);
return this;
}
/**
* The algorithm used to sign EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2SignatureAlgorithm</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signingAlgorithm(
String signingAlgorithm) {
doSetProperty("signingAlgorithm", signingAlgorithm);
return this;
}
/**
* The chain of certificates used to sign EDI message.
*
* The option is a: <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signingCertificateChain(
Certificate[] signingCertificateChain) {
doSetProperty("signingCertificateChain", signingCertificateChain);
return this;
}
/**
* The chain of certificates used to sign EDI message.
*
* The option will be converted to a
* <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signingCertificateChain(
String signingCertificateChain) {
doSetProperty("signingCertificateChain", signingCertificateChain);
return this;
}
/**
* The key used to sign the EDI message.
*
* The option is a: <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signingPrivateKey(
PrivateKey signingPrivateKey) {
doSetProperty("signingPrivateKey", signingPrivateKey);
return this;
}
/**
* The key used to sign the EDI message.
*
* The option will be converted to a
* <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder signingPrivateKey(
String signingPrivateKey) {
doSetProperty("signingPrivateKey", signingPrivateKey);
return this;
}
/**
* The value of Subject header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder subject(String subject) {
doSetProperty("subject", subject);
return this;
}
/**
* The host name (IP or DNS name) of target host.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder targetHostname(String targetHostname) {
doSetProperty("targetHostname", targetHostname);
return this;
}
/**
* The port number of target host. -1 indicates the scheme default port.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder targetPortNumber(
Integer targetPortNumber) {
doSetProperty("targetPortNumber", targetPortNumber);
return this;
}
/**
* The port number of target host. -1 indicates the scheme default port.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder targetPortNumber(
String targetPortNumber) {
doSetProperty("targetPortNumber", targetPortNumber);
return this;
}
/**
* The value included in the User-Agent message header identifying the
* AS2 user agent.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointConsumerBuilder userAgent(String userAgent) {
doSetProperty("userAgent", userAgent);
return this;
}
/**
* Allows for bridging the consumer to the Camel routing Error Handler,
* which mean any exceptions occurred while the consumer is trying to
* pickup incoming messages, or the likes, will now be processed as a
* message and handled by the routing Error Handler. By default the
* consumer will use the org.apache.camel.spi.ExceptionHandler to deal
* with exceptions, that will be logged at WARN or ERROR level and
* ignored.
*
* The option is a: <code>boolean</code> type.
*
* Group: consumer
*/
default AS2EndpointConsumerBuilder bridgeErrorHandler(
boolean bridgeErrorHandler) {
doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
/**
* Allows for bridging the consumer to the Camel routing Error Handler,
* which mean any exceptions occurred while the consumer is trying to
* pickup incoming messages, or the likes, will now be processed as a
* message and handled by the routing Error Handler. By default the
* consumer will use the org.apache.camel.spi.ExceptionHandler to deal
* with exceptions, that will be logged at WARN or ERROR level and
* ignored.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: consumer
*/
default AS2EndpointConsumerBuilder bridgeErrorHandler(
String bridgeErrorHandler) {
doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
/**
* If the polling consumer did not poll any files, you can enable this
* option to send an empty message (no body) instead.
*
* The option is a: <code>boolean</code> type.
*
* Group: consumer
*/
default AS2EndpointConsumerBuilder sendEmptyMessageWhenIdle(
boolean sendEmptyMessageWhenIdle) {
doSetProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
return this;
}
/**
* If the polling consumer did not poll any files, you can enable this
* option to send an empty message (no body) instead.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: consumer
*/
default AS2EndpointConsumerBuilder sendEmptyMessageWhenIdle(
String sendEmptyMessageWhenIdle) {
doSetProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
return this;
}
/**
* The number of subsequent error polls (failed due some error) that
* should happen before the backoffMultipler should kick-in.
*
* The option is a: <code>int</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder backoffErrorThreshold(
int backoffErrorThreshold) {
doSetProperty("backoffErrorThreshold", backoffErrorThreshold);
return this;
}
/**
* The number of subsequent error polls (failed due some error) that
* should happen before the backoffMultipler should kick-in.
*
* The option will be converted to a <code>int</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder backoffErrorThreshold(
String backoffErrorThreshold) {
doSetProperty("backoffErrorThreshold", backoffErrorThreshold);
return this;
}
/**
* The number of subsequent idle polls that should happen before the
* backoffMultipler should kick-in.
*
* The option is a: <code>int</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder backoffIdleThreshold(
int backoffIdleThreshold) {
doSetProperty("backoffIdleThreshold", backoffIdleThreshold);
return this;
}
/**
* The number of subsequent idle polls that should happen before the
* backoffMultipler should kick-in.
*
* The option will be converted to a <code>int</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder backoffIdleThreshold(
String backoffIdleThreshold) {
doSetProperty("backoffIdleThreshold", backoffIdleThreshold);
return this;
}
/**
* To let the scheduled polling consumer backoff if there has been a
* number of subsequent idles/errors in a row. The multiplier is then
* the number of polls that will be skipped before the next actual
* attempt is happening again. When this option is in use then
* backoffIdleThreshold and/or backoffErrorThreshold must also be
* configured.
*
* The option is a: <code>int</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder backoffMultiplier(
int backoffMultiplier) {
doSetProperty("backoffMultiplier", backoffMultiplier);
return this;
}
/**
* To let the scheduled polling consumer backoff if there has been a
* number of subsequent idles/errors in a row. The multiplier is then
* the number of polls that will be skipped before the next actual
* attempt is happening again. When this option is in use then
* backoffIdleThreshold and/or backoffErrorThreshold must also be
* configured.
*
* The option will be converted to a <code>int</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder backoffMultiplier(
String backoffMultiplier) {
doSetProperty("backoffMultiplier", backoffMultiplier);
return this;
}
/**
* Milliseconds before the next poll. You can also specify time values
* using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option is a: <code>long</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder delay(long delay) {
doSetProperty("delay", delay);
return this;
}
/**
* Milliseconds before the next poll. You can also specify time values
* using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option will be converted to a <code>long</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder delay(String delay) {
doSetProperty("delay", delay);
return this;
}
/**
* If greedy is enabled, then the ScheduledPollConsumer will run
* immediately again, if the previous run polled 1 or more messages.
*
* The option is a: <code>boolean</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder greedy(boolean greedy) {
doSetProperty("greedy", greedy);
return this;
}
/**
* If greedy is enabled, then the ScheduledPollConsumer will run
* immediately again, if the previous run polled 1 or more messages.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder greedy(String greedy) {
doSetProperty("greedy", greedy);
return this;
}
/**
* Milliseconds before the first poll starts. You can also specify time
* values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option is a: <code>long</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder initialDelay(long initialDelay) {
doSetProperty("initialDelay", initialDelay);
return this;
}
/**
* Milliseconds before the first poll starts. You can also specify time
* values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30
* seconds), and 1h (1 hour).
*
* The option will be converted to a <code>long</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder initialDelay(String initialDelay) {
doSetProperty("initialDelay", initialDelay);
return this;
}
/**
* Specifies a maximum limit of number of fires. So if you set it to 1,
* the scheduler will only fire once. If you set it to 5, it will only
* fire five times. A value of zero or negative means fire forever.
*
* The option is a: <code>long</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder repeatCount(long repeatCount) {
doSetProperty("repeatCount", repeatCount);
return this;
}
/**
* Specifies a maximum limit of number of fires. So if you set it to 1,
* the scheduler will only fire once. If you set it to 5, it will only
* fire five times. A value of zero or negative means fire forever.
*
* The option will be converted to a <code>long</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder repeatCount(String repeatCount) {
doSetProperty("repeatCount", repeatCount);
return this;
}
/**
* The consumer logs a start/complete log line when it polls. This
* option allows you to configure the logging level for that.
*
* The option is a: <code>org.apache.camel.LoggingLevel</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder runLoggingLevel(
LoggingLevel runLoggingLevel) {
doSetProperty("runLoggingLevel", runLoggingLevel);
return this;
}
/**
* The consumer logs a start/complete log line when it polls. This
* option allows you to configure the logging level for that.
*
* The option will be converted to a
* <code>org.apache.camel.LoggingLevel</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder runLoggingLevel(
String runLoggingLevel) {
doSetProperty("runLoggingLevel", runLoggingLevel);
return this;
}
/**
* Allows for configuring a custom/shared thread pool to use for the
* consumer. By default each consumer has its own single threaded thread
* pool.
*
* The option is a:
* <code>java.util.concurrent.ScheduledExecutorService</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder scheduledExecutorService(
ScheduledExecutorService scheduledExecutorService) {
doSetProperty("scheduledExecutorService", scheduledExecutorService);
return this;
}
/**
* Allows for configuring a custom/shared thread pool to use for the
* consumer. By default each consumer has its own single threaded thread
* pool.
*
* The option will be converted to a
* <code>java.util.concurrent.ScheduledExecutorService</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder scheduledExecutorService(
String scheduledExecutorService) {
doSetProperty("scheduledExecutorService", scheduledExecutorService);
return this;
}
/**
* To use a cron scheduler from either camel-spring or camel-quartz
* component.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder scheduler(String scheduler) {
doSetProperty("scheduler", scheduler);
return this;
}
/**
* To configure additional properties when using a custom scheduler or
* any of the Quartz, Spring based scheduler.
*
* The option is a: <code>java.util.Map&lt;java.lang.String,
* java.lang.Object&gt;</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder schedulerProperties(
Map<String, Object> schedulerProperties) {
doSetProperty("schedulerProperties", schedulerProperties);
return this;
}
/**
* To configure additional properties when using a custom scheduler or
* any of the Quartz, Spring based scheduler.
*
* The option will be converted to a
* <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code>
* type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder schedulerProperties(
String schedulerProperties) {
doSetProperty("schedulerProperties", schedulerProperties);
return this;
}
/**
* Whether the scheduler should be auto started.
*
* The option is a: <code>boolean</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder startScheduler(boolean startScheduler) {
doSetProperty("startScheduler", startScheduler);
return this;
}
/**
* Whether the scheduler should be auto started.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder startScheduler(String startScheduler) {
doSetProperty("startScheduler", startScheduler);
return this;
}
/**
* Time unit for initialDelay and delay options.
*
* The option is a: <code>java.util.concurrent.TimeUnit</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder timeUnit(TimeUnit timeUnit) {
doSetProperty("timeUnit", timeUnit);
return this;
}
/**
* Time unit for initialDelay and delay options.
*
* The option will be converted to a
* <code>java.util.concurrent.TimeUnit</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder timeUnit(String timeUnit) {
doSetProperty("timeUnit", timeUnit);
return this;
}
/**
* Controls if fixed delay or fixed rate is used. See
* ScheduledExecutorService in JDK for details.
*
* The option is a: <code>boolean</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) {
doSetProperty("useFixedDelay", useFixedDelay);
return this;
}
/**
* Controls if fixed delay or fixed rate is used. See
* ScheduledExecutorService in JDK for details.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: scheduler
*/
default AS2EndpointConsumerBuilder useFixedDelay(String useFixedDelay) {
doSetProperty("useFixedDelay", useFixedDelay);
return this;
}
}
/**
* Advanced builder for endpoint consumers for the AS2 component.
*/
public interface AdvancedAS2EndpointConsumerBuilder
extends
EndpointConsumerBuilder {
default AS2EndpointConsumerBuilder basic() {
return (AS2EndpointConsumerBuilder) this;
}
/**
* To let the consumer use a custom ExceptionHandler. Notice if the
* option bridgeErrorHandler is enabled then this option is not in use.
* By default the consumer will deal with exceptions, that will be
* logged at WARN or ERROR level and ignored.
*
* The option is a: <code>org.apache.camel.spi.ExceptionHandler</code>
* type.
*
* Group: consumer (advanced)
*/
default AdvancedAS2EndpointConsumerBuilder exceptionHandler(
ExceptionHandler exceptionHandler) {
doSetProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* To let the consumer use a custom ExceptionHandler. Notice if the
* option bridgeErrorHandler is enabled then this option is not in use.
* By default the consumer will deal with exceptions, that will be
* logged at WARN or ERROR level and ignored.
*
* The option will be converted to a
* <code>org.apache.camel.spi.ExceptionHandler</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedAS2EndpointConsumerBuilder exceptionHandler(
String exceptionHandler) {
doSetProperty("exceptionHandler", exceptionHandler);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option is a: <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedAS2EndpointConsumerBuilder exchangePattern(
ExchangePattern exchangePattern) {
doSetProperty("exchangePattern", exchangePattern);
return this;
}
/**
* Sets the exchange pattern when the consumer creates an exchange.
*
* The option will be converted to a
* <code>org.apache.camel.ExchangePattern</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedAS2EndpointConsumerBuilder exchangePattern(
String exchangePattern) {
doSetProperty("exchangePattern", exchangePattern);
return this;
}
/**
* A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
* you to provide your custom implementation to control error handling
* usually occurred during the poll operation before an Exchange have
* been created and being routed in Camel.
*
* The option is a:
* <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedAS2EndpointConsumerBuilder pollStrategy(
PollingConsumerPollStrategy pollStrategy) {
doSetProperty("pollStrategy", pollStrategy);
return this;
}
/**
* A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
* you to provide your custom implementation to control error handling
* usually occurred during the poll operation before an Exchange have
* been created and being routed in Camel.
*
* The option will be converted to a
* <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
*
* Group: consumer (advanced)
*/
default AdvancedAS2EndpointConsumerBuilder pollStrategy(
String pollStrategy) {
doSetProperty("pollStrategy", pollStrategy);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointConsumerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointConsumerBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointConsumerBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointConsumerBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* Builder for endpoint producers for the AS2 component.
*/
public interface AS2EndpointProducerBuilder
extends
EndpointProducerBuilder {
default AdvancedAS2EndpointProducerBuilder advanced() {
return (AdvancedAS2EndpointProducerBuilder) this;
}
/**
* The value of the AS2From header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder as2From(String as2From) {
doSetProperty("as2From", as2From);
return this;
}
/**
* The structure of AS2 Message. One of: PLAIN - No encryption, no
* signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption,
* no signature, ENCRYPTED_SIGNED - Encryption, signature.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2MessageStructure</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder as2MessageStructure(
AS2MessageStructure as2MessageStructure) {
doSetProperty("as2MessageStructure", as2MessageStructure);
return this;
}
/**
* The structure of AS2 Message. One of: PLAIN - No encryption, no
* signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption,
* no signature, ENCRYPTED_SIGNED - Encryption, signature.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2MessageStructure</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder as2MessageStructure(
String as2MessageStructure) {
doSetProperty("as2MessageStructure", as2MessageStructure);
return this;
}
/**
* The value of the AS2To header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder as2To(String as2To) {
doSetProperty("as2To", as2To);
return this;
}
/**
* The version of the AS2 protocol.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder as2Version(String as2Version) {
doSetProperty("as2Version", as2Version);
return this;
}
/**
* The Client Fully Qualified Domain Name (FQDN). Used in message ids
* sent by endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder clientFqdn(String clientFqdn) {
doSetProperty("clientFqdn", clientFqdn);
return this;
}
/**
* The algorithm used to compress EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2CompressionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder compressionAlgorithm(
AS2CompressionAlgorithm compressionAlgorithm) {
doSetProperty("compressionAlgorithm", compressionAlgorithm);
return this;
}
/**
* The algorithm used to compress EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2CompressionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder compressionAlgorithm(
String compressionAlgorithm) {
doSetProperty("compressionAlgorithm", compressionAlgorithm);
return this;
}
/**
* The key used to encrypt the EDI message.
*
* The option is a: <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder decryptingPrivateKey(
PrivateKey decryptingPrivateKey) {
doSetProperty("decryptingPrivateKey", decryptingPrivateKey);
return this;
}
/**
* The key used to encrypt the EDI message.
*
* The option will be converted to a
* <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder decryptingPrivateKey(
String decryptingPrivateKey) {
doSetProperty("decryptingPrivateKey", decryptingPrivateKey);
return this;
}
/**
* The value of the Disposition-Notification-To header. Assigning a
* value to this parameter requests a message disposition notification
* (MDN) for the AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder dispositionNotificationTo(
String dispositionNotificationTo) {
doSetProperty("dispositionNotificationTo", dispositionNotificationTo);
return this;
}
/**
* The transfer encoding of EDI message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder ediMessageTransferEncoding(
String ediMessageTransferEncoding) {
doSetProperty("ediMessageTransferEncoding", ediMessageTransferEncoding);
return this;
}
/**
* The content type of EDI message. One of application/edifact,
* application/edi-x12, application/edi-consent.
*
* The option is a: <code>org.apache.http.entity.ContentType</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder ediMessageType(Object ediMessageType) {
doSetProperty("ediMessageType", ediMessageType);
return this;
}
/**
* The content type of EDI message. One of application/edifact,
* application/edi-x12, application/edi-consent.
*
* The option will be converted to a
* <code>org.apache.http.entity.ContentType</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder ediMessageType(String ediMessageType) {
doSetProperty("ediMessageType", ediMessageType);
return this;
}
/**
* The algorithm used to encrypt EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2EncryptionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder encryptingAlgorithm(
AS2EncryptionAlgorithm encryptingAlgorithm) {
doSetProperty("encryptingAlgorithm", encryptingAlgorithm);
return this;
}
/**
* The algorithm used to encrypt EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2EncryptionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder encryptingAlgorithm(
String encryptingAlgorithm) {
doSetProperty("encryptingAlgorithm", encryptingAlgorithm);
return this;
}
/**
* The chain of certificates used to encrypt EDI message.
*
* The option is a: <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder encryptingCertificateChain(
Certificate[] encryptingCertificateChain) {
doSetProperty("encryptingCertificateChain", encryptingCertificateChain);
return this;
}
/**
* The chain of certificates used to encrypt EDI message.
*
* The option will be converted to a
* <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder encryptingCertificateChain(
String encryptingCertificateChain) {
doSetProperty("encryptingCertificateChain", encryptingCertificateChain);
return this;
}
/**
* The value of the From header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder from(String from) {
doSetProperty("from", from);
return this;
}
/**
* Sets the name of a parameter to be passed in the exchange In Body.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder inBody(String inBody) {
doSetProperty("inBody", inBody);
return this;
}
/**
* The template used to format MDN message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder mdnMessageTemplate(
String mdnMessageTemplate) {
doSetProperty("mdnMessageTemplate", mdnMessageTemplate);
return this;
}
/**
* The request URI of EDI message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder requestUri(String requestUri) {
doSetProperty("requestUri", requestUri);
return this;
}
/**
* The value included in the Server message header identifying the AS2
* Server.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder server(String server) {
doSetProperty("server", server);
return this;
}
/**
* The Server Fully Qualified Domain Name (FQDN). Used in message ids
* sent by endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder serverFqdn(String serverFqdn) {
doSetProperty("serverFqdn", serverFqdn);
return this;
}
/**
* The port number of server.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder serverPortNumber(
Integer serverPortNumber) {
doSetProperty("serverPortNumber", serverPortNumber);
return this;
}
/**
* The port number of server.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder serverPortNumber(
String serverPortNumber) {
doSetProperty("serverPortNumber", serverPortNumber);
return this;
}
/**
* The list of algorithms, in order of preference, requested to generate
* a message integrity check (MIC) returned in message dispostion
* notification (MDN).
*
* The option is a: <code>java.lang.String[]</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signedReceiptMicAlgorithms(
String[] signedReceiptMicAlgorithms) {
doSetProperty("signedReceiptMicAlgorithms", signedReceiptMicAlgorithms);
return this;
}
/**
* The list of algorithms, in order of preference, requested to generate
* a message integrity check (MIC) returned in message dispostion
* notification (MDN).
*
* The option will be converted to a <code>java.lang.String[]</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signedReceiptMicAlgorithms(
String signedReceiptMicAlgorithms) {
doSetProperty("signedReceiptMicAlgorithms", signedReceiptMicAlgorithms);
return this;
}
/**
* The algorithm used to sign EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2SignatureAlgorithm</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signingAlgorithm(
AS2SignatureAlgorithm signingAlgorithm) {
doSetProperty("signingAlgorithm", signingAlgorithm);
return this;
}
/**
* The algorithm used to sign EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2SignatureAlgorithm</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signingAlgorithm(
String signingAlgorithm) {
doSetProperty("signingAlgorithm", signingAlgorithm);
return this;
}
/**
* The chain of certificates used to sign EDI message.
*
* The option is a: <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signingCertificateChain(
Certificate[] signingCertificateChain) {
doSetProperty("signingCertificateChain", signingCertificateChain);
return this;
}
/**
* The chain of certificates used to sign EDI message.
*
* The option will be converted to a
* <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signingCertificateChain(
String signingCertificateChain) {
doSetProperty("signingCertificateChain", signingCertificateChain);
return this;
}
/**
* The key used to sign the EDI message.
*
* The option is a: <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signingPrivateKey(
PrivateKey signingPrivateKey) {
doSetProperty("signingPrivateKey", signingPrivateKey);
return this;
}
/**
* The key used to sign the EDI message.
*
* The option will be converted to a
* <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder signingPrivateKey(
String signingPrivateKey) {
doSetProperty("signingPrivateKey", signingPrivateKey);
return this;
}
/**
* The value of Subject header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder subject(String subject) {
doSetProperty("subject", subject);
return this;
}
/**
* The host name (IP or DNS name) of target host.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder targetHostname(String targetHostname) {
doSetProperty("targetHostname", targetHostname);
return this;
}
/**
* The port number of target host. -1 indicates the scheme default port.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder targetPortNumber(
Integer targetPortNumber) {
doSetProperty("targetPortNumber", targetPortNumber);
return this;
}
/**
* The port number of target host. -1 indicates the scheme default port.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: common
*/
default AS2EndpointProducerBuilder targetPortNumber(
String targetPortNumber) {
doSetProperty("targetPortNumber", targetPortNumber);
return this;
}
/**
* The value included in the User-Agent message header identifying the
* AS2 user agent.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointProducerBuilder userAgent(String userAgent) {
doSetProperty("userAgent", userAgent);
return this;
}
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
* startup in situations where a producer may otherwise fail during
* starting and cause the route to fail being started. By deferring this
* startup to be lazy then the startup failure can be handled during
* routing messages via Camel's routing error handlers. Beware that when
* the first message is processed then creating and starting the
* producer may take a little time and prolong the total processing time
* of the processing.
*
* The option is a: <code>boolean</code> type.
*
* Group: producer
*/
default AS2EndpointProducerBuilder lazyStartProducer(
boolean lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
/**
* Whether the producer should be started lazy (on the first message).
* By starting lazy you can use this to allow CamelContext and routes to
* startup in situations where a producer may otherwise fail during
* starting and cause the route to fail being started. By deferring this
* startup to be lazy then the startup failure can be handled during
* routing messages via Camel's routing error handlers. Beware that when
* the first message is processed then creating and starting the
* producer may take a little time and prolong the total processing time
* of the processing.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: producer
*/
default AS2EndpointProducerBuilder lazyStartProducer(
String lazyStartProducer) {
doSetProperty("lazyStartProducer", lazyStartProducer);
return this;
}
}
/**
* Advanced builder for endpoint producers for the AS2 component.
*/
public interface AdvancedAS2EndpointProducerBuilder
extends
EndpointProducerBuilder {
default AS2EndpointProducerBuilder basic() {
return (AS2EndpointProducerBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointProducerBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointProducerBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointProducerBuilder synchronous(
boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointProducerBuilder synchronous(
String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* Builder for endpoint for the AS2 component.
*/
public interface AS2EndpointBuilder
extends
AS2EndpointConsumerBuilder, AS2EndpointProducerBuilder {
default AdvancedAS2EndpointBuilder advanced() {
return (AdvancedAS2EndpointBuilder) this;
}
/**
* The value of the AS2From header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder as2From(String as2From) {
doSetProperty("as2From", as2From);
return this;
}
/**
* The structure of AS2 Message. One of: PLAIN - No encryption, no
* signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption,
* no signature, ENCRYPTED_SIGNED - Encryption, signature.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2MessageStructure</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder as2MessageStructure(
AS2MessageStructure as2MessageStructure) {
doSetProperty("as2MessageStructure", as2MessageStructure);
return this;
}
/**
* The structure of AS2 Message. One of: PLAIN - No encryption, no
* signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption,
* no signature, ENCRYPTED_SIGNED - Encryption, signature.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2MessageStructure</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder as2MessageStructure(
String as2MessageStructure) {
doSetProperty("as2MessageStructure", as2MessageStructure);
return this;
}
/**
* The value of the AS2To header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder as2To(String as2To) {
doSetProperty("as2To", as2To);
return this;
}
/**
* The version of the AS2 protocol.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder as2Version(String as2Version) {
doSetProperty("as2Version", as2Version);
return this;
}
/**
* The Client Fully Qualified Domain Name (FQDN). Used in message ids
* sent by endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder clientFqdn(String clientFqdn) {
doSetProperty("clientFqdn", clientFqdn);
return this;
}
/**
* The algorithm used to compress EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2CompressionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointBuilder compressionAlgorithm(
AS2CompressionAlgorithm compressionAlgorithm) {
doSetProperty("compressionAlgorithm", compressionAlgorithm);
return this;
}
/**
* The algorithm used to compress EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2CompressionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointBuilder compressionAlgorithm(
String compressionAlgorithm) {
doSetProperty("compressionAlgorithm", compressionAlgorithm);
return this;
}
/**
* The key used to encrypt the EDI message.
*
* The option is a: <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointBuilder decryptingPrivateKey(
PrivateKey decryptingPrivateKey) {
doSetProperty("decryptingPrivateKey", decryptingPrivateKey);
return this;
}
/**
* The key used to encrypt the EDI message.
*
* The option will be converted to a
* <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointBuilder decryptingPrivateKey(
String decryptingPrivateKey) {
doSetProperty("decryptingPrivateKey", decryptingPrivateKey);
return this;
}
/**
* The value of the Disposition-Notification-To header. Assigning a
* value to this parameter requests a message disposition notification
* (MDN) for the AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder dispositionNotificationTo(
String dispositionNotificationTo) {
doSetProperty("dispositionNotificationTo", dispositionNotificationTo);
return this;
}
/**
* The transfer encoding of EDI message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder ediMessageTransferEncoding(
String ediMessageTransferEncoding) {
doSetProperty("ediMessageTransferEncoding", ediMessageTransferEncoding);
return this;
}
/**
* The content type of EDI message. One of application/edifact,
* application/edi-x12, application/edi-consent.
*
* The option is a: <code>org.apache.http.entity.ContentType</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder ediMessageType(Object ediMessageType) {
doSetProperty("ediMessageType", ediMessageType);
return this;
}
/**
* The content type of EDI message. One of application/edifact,
* application/edi-x12, application/edi-consent.
*
* The option will be converted to a
* <code>org.apache.http.entity.ContentType</code> type.
*
* Group: common
*/
default AS2EndpointBuilder ediMessageType(String ediMessageType) {
doSetProperty("ediMessageType", ediMessageType);
return this;
}
/**
* The algorithm used to encrypt EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2EncryptionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointBuilder encryptingAlgorithm(
AS2EncryptionAlgorithm encryptingAlgorithm) {
doSetProperty("encryptingAlgorithm", encryptingAlgorithm);
return this;
}
/**
* The algorithm used to encrypt EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2EncryptionAlgorithm</code> type.
*
* Group: common
*/
default AS2EndpointBuilder encryptingAlgorithm(
String encryptingAlgorithm) {
doSetProperty("encryptingAlgorithm", encryptingAlgorithm);
return this;
}
/**
* The chain of certificates used to encrypt EDI message.
*
* The option is a: <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointBuilder encryptingCertificateChain(
Certificate[] encryptingCertificateChain) {
doSetProperty("encryptingCertificateChain", encryptingCertificateChain);
return this;
}
/**
* The chain of certificates used to encrypt EDI message.
*
* The option will be converted to a
* <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointBuilder encryptingCertificateChain(
String encryptingCertificateChain) {
doSetProperty("encryptingCertificateChain", encryptingCertificateChain);
return this;
}
/**
* The value of the From header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder from(String from) {
doSetProperty("from", from);
return this;
}
/**
* Sets the name of a parameter to be passed in the exchange In Body.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder inBody(String inBody) {
doSetProperty("inBody", inBody);
return this;
}
/**
* The template used to format MDN message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder mdnMessageTemplate(String mdnMessageTemplate) {
doSetProperty("mdnMessageTemplate", mdnMessageTemplate);
return this;
}
/**
* The request URI of EDI message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder requestUri(String requestUri) {
doSetProperty("requestUri", requestUri);
return this;
}
/**
* The value included in the Server message header identifying the AS2
* Server.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder server(String server) {
doSetProperty("server", server);
return this;
}
/**
* The Server Fully Qualified Domain Name (FQDN). Used in message ids
* sent by endpoint.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder serverFqdn(String serverFqdn) {
doSetProperty("serverFqdn", serverFqdn);
return this;
}
/**
* The port number of server.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: common
*/
default AS2EndpointBuilder serverPortNumber(Integer serverPortNumber) {
doSetProperty("serverPortNumber", serverPortNumber);
return this;
}
/**
* The port number of server.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder serverPortNumber(String serverPortNumber) {
doSetProperty("serverPortNumber", serverPortNumber);
return this;
}
/**
* The list of algorithms, in order of preference, requested to generate
* a message integrity check (MIC) returned in message dispostion
* notification (MDN).
*
* The option is a: <code>java.lang.String[]</code> type.
*
* Group: common
*/
default AS2EndpointBuilder signedReceiptMicAlgorithms(
String[] signedReceiptMicAlgorithms) {
doSetProperty("signedReceiptMicAlgorithms", signedReceiptMicAlgorithms);
return this;
}
/**
* The list of algorithms, in order of preference, requested to generate
* a message integrity check (MIC) returned in message dispostion
* notification (MDN).
*
* The option will be converted to a <code>java.lang.String[]</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder signedReceiptMicAlgorithms(
String signedReceiptMicAlgorithms) {
doSetProperty("signedReceiptMicAlgorithms", signedReceiptMicAlgorithms);
return this;
}
/**
* The algorithm used to sign EDI message.
*
* The option is a:
* <code>org.apache.camel.component.as2.api.AS2SignatureAlgorithm</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder signingAlgorithm(
AS2SignatureAlgorithm signingAlgorithm) {
doSetProperty("signingAlgorithm", signingAlgorithm);
return this;
}
/**
* The algorithm used to sign EDI message.
*
* The option will be converted to a
* <code>org.apache.camel.component.as2.api.AS2SignatureAlgorithm</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder signingAlgorithm(String signingAlgorithm) {
doSetProperty("signingAlgorithm", signingAlgorithm);
return this;
}
/**
* The chain of certificates used to sign EDI message.
*
* The option is a: <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointBuilder signingCertificateChain(
Certificate[] signingCertificateChain) {
doSetProperty("signingCertificateChain", signingCertificateChain);
return this;
}
/**
* The chain of certificates used to sign EDI message.
*
* The option will be converted to a
* <code>java.security.cert.Certificate[]</code> type.
*
* Group: common
*/
default AS2EndpointBuilder signingCertificateChain(
String signingCertificateChain) {
doSetProperty("signingCertificateChain", signingCertificateChain);
return this;
}
/**
* The key used to sign the EDI message.
*
* The option is a: <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointBuilder signingPrivateKey(
PrivateKey signingPrivateKey) {
doSetProperty("signingPrivateKey", signingPrivateKey);
return this;
}
/**
* The key used to sign the EDI message.
*
* The option will be converted to a
* <code>java.security.PrivateKey</code> type.
*
* Group: common
*/
default AS2EndpointBuilder signingPrivateKey(String signingPrivateKey) {
doSetProperty("signingPrivateKey", signingPrivateKey);
return this;
}
/**
* The value of Subject header of AS2 message.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder subject(String subject) {
doSetProperty("subject", subject);
return this;
}
/**
* The host name (IP or DNS name) of target host.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder targetHostname(String targetHostname) {
doSetProperty("targetHostname", targetHostname);
return this;
}
/**
* The port number of target host. -1 indicates the scheme default port.
*
* The option is a: <code>java.lang.Integer</code> type.
*
* Group: common
*/
default AS2EndpointBuilder targetPortNumber(Integer targetPortNumber) {
doSetProperty("targetPortNumber", targetPortNumber);
return this;
}
/**
* The port number of target host. -1 indicates the scheme default port.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
*
* Group: common
*/
default AS2EndpointBuilder targetPortNumber(String targetPortNumber) {
doSetProperty("targetPortNumber", targetPortNumber);
return this;
}
/**
* The value included in the User-Agent message header identifying the
* AS2 user agent.
*
* The option is a: <code>java.lang.String</code> type.
*
* Group: common
*/
default AS2EndpointBuilder userAgent(String userAgent) {
doSetProperty("userAgent", userAgent);
return this;
}
}
/**
* Advanced builder for endpoint for the AS2 component.
*/
public interface AdvancedAS2EndpointBuilder
extends
AdvancedAS2EndpointConsumerBuilder, AdvancedAS2EndpointProducerBuilder {
default AS2EndpointBuilder basic() {
return (AS2EndpointBuilder) this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointBuilder basicPropertyBinding(
boolean basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointBuilder basicPropertyBinding(
String basicPropertyBinding) {
doSetProperty("basicPropertyBinding", basicPropertyBinding);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option is a: <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointBuilder synchronous(boolean synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
/**
* Sets whether synchronous processing should be strictly used, or Camel
* is allowed to use asynchronous processing (if supported).
*
* The option will be converted to a <code>boolean</code> type.
*
* Group: advanced
*/
default AdvancedAS2EndpointBuilder synchronous(String synchronous) {
doSetProperty("synchronous", synchronous);
return this;
}
}
/**
* Proxy enum for
* <code>org.apache.camel.component.as2.api.AS2MessageStructure</code> enum.
*/
enum AS2MessageStructure {
PLAIN,
SIGNED,
ENCRYPTED,
SIGNED_ENCRYPTED,
PLAIN_COMPRESSED,
SIGNED_COMPRESSED,
ENCRYPTED_COMPRESSED,
ENCRYPTED_COMPRESSED_SIGNED;
}
/**
* Proxy enum for
* <code>org.apache.camel.component.as2.api.AS2CompressionAlgorithm</code>
* enum.
*/
enum AS2CompressionAlgorithm {
ZLIB;
}
/**
* Proxy enum for
* <code>org.apache.camel.component.as2.api.AS2EncryptionAlgorithm</code>
* enum.
*/
enum AS2EncryptionAlgorithm {
AES128_CBC,
AES192_CBC,
AES256_CBC,
AES128_CCM,
AES192_CCM,
AES256_CCM,
AES128_GCM,
AES192_GCM,
AES256_GCM,
CAMELLIA128_CBC,
CAMELLIA192_CBC,
CAMELLIA256_CBC,
CAST5_CBC,
DES_CBC,
DES_EDE3_CBC,
GOST28147_GCFB,
IDEA_CBC,
RC2_CBC,
RC4,
SEED_CBC;
}
/**
* Proxy enum for
* <code>org.apache.camel.component.as2.api.AS2SignatureAlgorithm</code>
* enum.
*/
enum AS2SignatureAlgorithm {
SHA3_224WITHRSA,
SHA3_256WITHRSA,
SHA3_384withRSA,
SHA3_512WITHRSA,
MD5WITHRSA,
SHA1WITHRSA,
MD2WITHRSA,
SHA224WITHRSA,
SHA256WITHRSA,
SHA384WITHRSA,
SHA512WITHRSA,
RIPEMD128WITHRSA,
RIPEMD160WITHRSA,
RIPEMD256WITHRSA,
SHA224WITHDSA,
SHA256WITHDSA,
SHA384WITHDSA,
SHA512WITHDSA,
SHA3_224WITHDSA,
SHA3_256WITHDSA,
SHA3_384WITHDSA,
SHA3_512WITHDSA,
SHA1WITHDSA,
SHA3_224WITHECDSA,
SHA3_256WITHECDSA,
SHA3_384WITHECDSA,
SHA3_512WITHECDSA,
SHA1WITHECDSA,
SHA224WITHECDSA,
SHA256WITHECDSA,
SHA384WITHECDSA,
SHA512WITHECDSA,
SHA1WITHPLAIN_ECDSA,
SHA224WITHPLAIN_ECDSA,
SHA256WITHPLAIN_ECDSA,
SHA384WITHPLAIN_ECDSA,
SHA512WITHPLAIN_ECDSA,
RIPEMD160WITHPLAIN_ECDSA,
SHA1WITHRSAANDMGF1,
SHA224WITHRSAANDMGF1,
SHA256WITHRSAANDMGF1,
SHA384WITHRSAANDMGF1,
SHA512WITHRSAANDMGF1,
SHA3_224WITHRSAANDMGF1,
SHA3_256WITHRSAANDMGF1,
SHA3_384WITHRSAANDMGF1,
SHA3_512WITHRSAANDMGF1;
}
/**
* AS2 (camel-as2)
* Component used for transferring data secure and reliable over the
* internet using the AS2 protocol.
*
* Category: AS2
* Since: 2.22
* Maven coordinates: org.apache.camel:camel-as2
*
* Syntax: <code>as2:apiName/methodName</code>
*
* Path parameter: apiName (required)
* What kind of operation to perform
* The value can be one of: CLIENT, SERVER
*
* Path parameter: methodName (required)
* What sub operation to use for the selected operation
*/
default AS2EndpointBuilder as2(String path) {
class AS2EndpointBuilderImpl extends AbstractEndpointBuilder implements AS2EndpointBuilder, AdvancedAS2EndpointBuilder {
public AS2EndpointBuilderImpl(String path) {
super("as2", path);
}
}
return new AS2EndpointBuilderImpl(path);
}
}