Package org.apache.camel.builder.endpoint.dsl

Interface AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
AS2EndpointBuilderFactory.AS2EndpointBuilder
Enclosing interface:
AS2EndpointBuilderFactory
public static interface AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the AS2 component.

  • Method Details

    • advanced

      default AS2EndpointBuilderFactory.AdvancedAS2EndpointConsumerBuilder advanced()

    • as2From

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder as2From(String as2From)
      The value of the AS2From header of AS2 message. The option is a: java.lang.String type. Group: common
      Parameters:
      as2From - the value to set
      Returns:
      the dsl builder

    • as2MessageStructure

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder as2MessageStructure(org.apache.camel.component.as2.api.AS2MessageStructure as2MessageStructure)
      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: org.apache.camel.component.as2.api.AS2MessageStructure type. Group: common
      Parameters:
      as2MessageStructure - the value to set
      Returns:
      the dsl builder

    • as2MessageStructure

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder as2MessageStructure(String as2MessageStructure)
      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 org.apache.camel.component.as2.api.AS2MessageStructure type. Group: common
      Parameters:
      as2MessageStructure - the value to set
      Returns:
      the dsl builder

    • as2To

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder as2To(String as2To)
      The value of the AS2To header of AS2 message. The option is a: java.lang.String type. Group: common
      Parameters:
      as2To - the value to set
      Returns:
      the dsl builder

    • as2Version

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder as2Version(String as2Version)
      The version of the AS2 protocol. The option is a: java.lang.String type. Default: 1.1 Group: common
      Parameters:
      as2Version - the value to set
      Returns:
      the dsl builder

    • asyncMdnPortNumber

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder asyncMdnPortNumber(Integer asyncMdnPortNumber)
      The port number of asynchronous MDN server. The option is a: java.lang.Integer type. Group: common
      Parameters:
      asyncMdnPortNumber - the value to set
      Returns:
      the dsl builder

    • asyncMdnPortNumber

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder asyncMdnPortNumber(String asyncMdnPortNumber)
      The port number of asynchronous MDN server. The option will be converted to a java.lang.Integer type. Group: common
      Parameters:
      asyncMdnPortNumber - the value to set
      Returns:
      the dsl builder

    • attachedFileName

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder attachedFileName(String attachedFileName)
      The name of the attached file. The option is a: java.lang.String type. Group: common
      Parameters:
      attachedFileName - the value to set
      Returns:
      the dsl builder

    • clientFqdn

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder clientFqdn(String clientFqdn)
      The Client Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint. The option is a: java.lang.String type. Default: camel.apache.org Group: common
      Parameters:
      clientFqdn - the value to set
      Returns:
      the dsl builder

    • compressionAlgorithm

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder compressionAlgorithm(org.apache.camel.component.as2.api.AS2CompressionAlgorithm compressionAlgorithm)
      The algorithm used to compress EDI message. The option is a: org.apache.camel.component.as2.api.AS2CompressionAlgorithm type. Group: common
      Parameters:
      compressionAlgorithm - the value to set
      Returns:
      the dsl builder

    • compressionAlgorithm

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder compressionAlgorithm(String compressionAlgorithm)
      The algorithm used to compress EDI message. The option will be converted to a org.apache.camel.component.as2.api.AS2CompressionAlgorithm type. Group: common
      Parameters:
      compressionAlgorithm - the value to set
      Returns:
      the dsl builder

    • dispositionNotificationTo

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder dispositionNotificationTo(String dispositionNotificationTo)
      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: java.lang.String type. Group: common
      Parameters:
      dispositionNotificationTo - the value to set
      Returns:
      the dsl builder

    • ediMessageCharset

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder ediMessageCharset(String ediMessageCharset)
      The charset of the content type of EDI message. The option is a: java.lang.String type. Default: us-ascii Group: common
      Parameters:
      ediMessageCharset - the value to set
      Returns:
      the dsl builder

    • ediMessageTransferEncoding

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder ediMessageTransferEncoding(String ediMessageTransferEncoding)
      The transfer encoding of EDI message. The option is a: java.lang.String type. Group: common
      Parameters:
      ediMessageTransferEncoding - the value to set
      Returns:
      the dsl builder

    • ediMessageType

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder ediMessageType(String ediMessageType)
      The content type of EDI message. One of application/edifact, application/edi-x12, application/edi-consent, application/xml. The option is a: java.lang.String type. Group: common
      Parameters:
      ediMessageType - the value to set
      Returns:
      the dsl builder

    • from

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder from(String from)
      The value of the From header of AS2 message. The option is a: java.lang.String type. Group: common
      Parameters:
      from - the value to set
      Returns:
      the dsl builder

    • httpConnectionPoolSize

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpConnectionPoolSize(Integer httpConnectionPoolSize)
      The maximum size of the connection pool for http connections (client only). The option is a: java.lang.Integer type. Default: 5 Group: common
      Parameters:
      httpConnectionPoolSize - the value to set
      Returns:
      the dsl builder

    • httpConnectionPoolSize

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpConnectionPoolSize(String httpConnectionPoolSize)
      The maximum size of the connection pool for http connections (client only). The option will be converted to a java.lang.Integer type. Default: 5 Group: common
      Parameters:
      httpConnectionPoolSize - the value to set
      Returns:
      the dsl builder

    • httpConnectionPoolTtl

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpConnectionPoolTtl(Duration httpConnectionPoolTtl)
      The time to live for connections in the connection pool (client only). The option is a: java.time.Duration type. Default: 15m Group: common
      Parameters:
      httpConnectionPoolTtl - the value to set
      Returns:
      the dsl builder

    • httpConnectionPoolTtl

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpConnectionPoolTtl(String httpConnectionPoolTtl)
      The time to live for connections in the connection pool (client only). The option will be converted to a java.time.Duration type. Default: 15m Group: common
      Parameters:
      httpConnectionPoolTtl - the value to set
      Returns:
      the dsl builder

    • httpConnectionTimeout

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpConnectionTimeout(Duration httpConnectionTimeout)
      The timeout of the http connection (client only). The option is a: java.time.Duration type. Default: 5s Group: common
      Parameters:
      httpConnectionTimeout - the value to set
      Returns:
      the dsl builder

    • httpConnectionTimeout

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpConnectionTimeout(String httpConnectionTimeout)
      The timeout of the http connection (client only). The option will be converted to a java.time.Duration type. Default: 5s Group: common
      Parameters:
      httpConnectionTimeout - the value to set
      Returns:
      the dsl builder

    • httpSocketTimeout

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpSocketTimeout(Duration httpSocketTimeout)
      The timeout of the underlying http socket (client only). The option is a: java.time.Duration type. Default: 5s Group: common
      Parameters:
      httpSocketTimeout - the value to set
      Returns:
      the dsl builder

    • httpSocketTimeout

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder httpSocketTimeout(String httpSocketTimeout)
      The timeout of the underlying http socket (client only). The option will be converted to a java.time.Duration type. Default: 5s Group: common
      Parameters:
      httpSocketTimeout - the value to set
      Returns:
      the dsl builder

    • inBody

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder inBody(String inBody)
      Sets the name of a parameter to be passed in the exchange In Body. The option is a: java.lang.String type. Group: common
      Parameters:
      inBody - the value to set
      Returns:
      the dsl builder

    • mdnMessageTemplate

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder mdnMessageTemplate(String mdnMessageTemplate)
      The template used to format MDN message. The option is a: java.lang.String type. Group: common
      Parameters:
      mdnMessageTemplate - the value to set
      Returns:
      the dsl builder

    • receiptDeliveryOption

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder receiptDeliveryOption(String receiptDeliveryOption)
      The return URL that the message receiver should send an asynchronous MDN to. If not present the receipt is synchronous. (Client only). The option is a: java.lang.String type. Group: common
      Parameters:
      receiptDeliveryOption - the value to set
      Returns:
      the dsl builder

    • requestUri

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder requestUri(String requestUri)
      The request URI of EDI message. The option is a: java.lang.String type. Default: / Group: common
      Parameters:
      requestUri - the value to set
      Returns:
      the dsl builder

    • server

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder server(String server)
      The value included in the Server message header identifying the AS2 Server. The option is a: java.lang.String type. Default: Camel AS2 Server Endpoint Group: common
      Parameters:
      server - the value to set
      Returns:
      the dsl builder

    • serverFqdn

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder serverFqdn(String serverFqdn)
      The Server Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint. The option is a: java.lang.String type. Default: camel.apache.org Group: common
      Parameters:
      serverFqdn - the value to set
      Returns:
      the dsl builder

    • serverPortNumber

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder serverPortNumber(Integer serverPortNumber)
      The port number of server. The option is a: java.lang.Integer type. Group: common
      Parameters:
      serverPortNumber - the value to set
      Returns:
      the dsl builder

    • serverPortNumber

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder serverPortNumber(String serverPortNumber)
      The port number of server. The option will be converted to a java.lang.Integer type. Group: common
      Parameters:
      serverPortNumber - the value to set
      Returns:
      the dsl builder

    • subject

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder subject(String subject)
      The value of Subject header of AS2 message. The option is a: java.lang.String type. Group: common
      Parameters:
      subject - the value to set
      Returns:
      the dsl builder

    • targetHostname

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder targetHostname(String targetHostname)
      The host name (IP or DNS name) of target host. The option is a: java.lang.String type. Group: common
      Parameters:
      targetHostname - the value to set
      Returns:
      the dsl builder

    • targetPortNumber

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder targetPortNumber(Integer targetPortNumber)
      The port number of target host. -1 indicates the scheme default port. The option is a: java.lang.Integer type. Default: 80 Group: common
      Parameters:
      targetPortNumber - the value to set
      Returns:
      the dsl builder

    • targetPortNumber

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder targetPortNumber(String targetPortNumber)
      The port number of target host. -1 indicates the scheme default port. The option will be converted to a java.lang.Integer type. Default: 80 Group: common
      Parameters:
      targetPortNumber - the value to set
      Returns:
      the dsl builder

    • userAgent

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder userAgent(String userAgent)
      The value included in the User-Agent message header identifying the AS2 user agent. The option is a: java.lang.String type. Default: Camel AS2 Client Endpoint Group: common
      Parameters:
      userAgent - the value to set
      Returns:
      the dsl builder

    • accessToken

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder accessToken(String accessToken)
      The access token that is used by the client for bearer authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder

    • decryptingPrivateKey

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder decryptingPrivateKey(PrivateKey decryptingPrivateKey)
      The key used to encrypt the EDI message. The option is a: java.security.PrivateKey type. Group: security
      Parameters:
      decryptingPrivateKey - the value to set
      Returns:
      the dsl builder

    • decryptingPrivateKey

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder decryptingPrivateKey(String decryptingPrivateKey)
      The key used to encrypt the EDI message. The option will be converted to a java.security.PrivateKey type. Group: security
      Parameters:
      decryptingPrivateKey - the value to set
      Returns:
      the dsl builder

    • encryptingAlgorithm

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder encryptingAlgorithm(org.apache.camel.component.as2.api.AS2EncryptionAlgorithm encryptingAlgorithm)
      The algorithm used to encrypt EDI message. The option is a: org.apache.camel.component.as2.api.AS2EncryptionAlgorithm type. Group: security
      Parameters:
      encryptingAlgorithm - the value to set
      Returns:
      the dsl builder

    • encryptingAlgorithm

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder encryptingAlgorithm(String encryptingAlgorithm)
      The algorithm used to encrypt EDI message. The option will be converted to a org.apache.camel.component.as2.api.AS2EncryptionAlgorithm type. Group: security
      Parameters:
      encryptingAlgorithm - the value to set
      Returns:
      the dsl builder

    • encryptingCertificateChain

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder encryptingCertificateChain(Certificate[] encryptingCertificateChain)
      The chain of certificates used to encrypt EDI message. The option is a: java.security.cert.Certificate[] type. Group: security
      Parameters:
      encryptingCertificateChain - the value to set
      Returns:
      the dsl builder

    • encryptingCertificateChain

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder encryptingCertificateChain(String encryptingCertificateChain)
      The chain of certificates used to encrypt EDI message. The option will be converted to a java.security.cert.Certificate[] type. Group: security
      Parameters:
      encryptingCertificateChain - the value to set
      Returns:
      the dsl builder

    • hostnameVerifier

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder hostnameVerifier(HostnameVerifier hostnameVerifier)
      Set hostname verifier for SSL session. The option is a: javax.net.ssl.HostnameVerifier type. Group: security
      Parameters:
      hostnameVerifier - the value to set
      Returns:
      the dsl builder

    • hostnameVerifier

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder hostnameVerifier(String hostnameVerifier)
      Set hostname verifier for SSL session. The option will be converted to a javax.net.ssl.HostnameVerifier type. Group: security
      Parameters:
      hostnameVerifier - the value to set
      Returns:
      the dsl builder

    • mdnAccessToken

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder mdnAccessToken(String mdnAccessToken)
      The access token that is used by the server when it sends an async MDN. The option is a: java.lang.String type. Group: security
      Parameters:
      mdnAccessToken - the value to set
      Returns:
      the dsl builder

    • mdnPassword

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder mdnPassword(String mdnPassword)
      The password that is used by the server for basic authentication when it sends an async MDN. The option is a: java.lang.String type. Group: security
      Parameters:
      mdnPassword - the value to set
      Returns:
      the dsl builder

    • mdnUserName

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder mdnUserName(String mdnUserName)
      The user-name that is used by the server for basic authentication when it sends an async MDN. If options for basic authentication and bearer authentication are both set then basic authentication takes precedence. The option is a: java.lang.String type. Group: security
      Parameters:
      mdnUserName - the value to set
      Returns:
      the dsl builder

    • password

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder password(String password)
      The password that is used by the client for basic authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • signedReceiptMicAlgorithms

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder signedReceiptMicAlgorithms(String signedReceiptMicAlgorithms)
      The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message disposition notification (MDN). Multiple algorithms can be separated by comma. The option is a: java.lang.String type. Group: security
      Parameters:
      signedReceiptMicAlgorithms - the value to set
      Returns:
      the dsl builder

    • signingAlgorithm

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder signingAlgorithm(org.apache.camel.component.as2.api.AS2SignatureAlgorithm signingAlgorithm)
      The algorithm used to sign EDI message. The option is a: org.apache.camel.component.as2.api.AS2SignatureAlgorithm type. Group: security
      Parameters:
      signingAlgorithm - the value to set
      Returns:
      the dsl builder

    • signingAlgorithm

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder signingAlgorithm(String signingAlgorithm)
      The algorithm used to sign EDI message. The option will be converted to a org.apache.camel.component.as2.api.AS2SignatureAlgorithm type. Group: security
      Parameters:
      signingAlgorithm - the value to set
      Returns:
      the dsl builder

    • signingCertificateChain

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder signingCertificateChain(Certificate[] signingCertificateChain)
      The chain of certificates used to sign EDI message. The option is a: java.security.cert.Certificate[] type. Group: security
      Parameters:
      signingCertificateChain - the value to set
      Returns:
      the dsl builder

    • signingCertificateChain

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder signingCertificateChain(String signingCertificateChain)
      The chain of certificates used to sign EDI message. The option will be converted to a java.security.cert.Certificate[] type. Group: security
      Parameters:
      signingCertificateChain - the value to set
      Returns:
      the dsl builder

    • signingPrivateKey

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder signingPrivateKey(PrivateKey signingPrivateKey)
      The key used to sign the EDI message. The option is a: java.security.PrivateKey type. Group: security
      Parameters:
      signingPrivateKey - the value to set
      Returns:
      the dsl builder

    • signingPrivateKey

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder signingPrivateKey(String signingPrivateKey)
      The key used to sign the EDI message. The option will be converted to a java.security.PrivateKey type. Group: security
      Parameters:
      signingPrivateKey - the value to set
      Returns:
      the dsl builder

    • sslContext

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder sslContext(SSLContext sslContext)
      Set SSL context for connection to remote server. The option is a: javax.net.ssl.SSLContext type. Group: security
      Parameters:
      sslContext - the value to set
      Returns:
      the dsl builder

    • sslContext

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder sslContext(String sslContext)
      Set SSL context for connection to remote server. The option will be converted to a javax.net.ssl.SSLContext type. Group: security
      Parameters:
      sslContext - the value to set
      Returns:
      the dsl builder

    • userName

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder userName(String userName)
      The user-name that is used by the client for basic authentication. If options for basic authentication and bearer authentication are both set then basic authentication takes precedence. The option is a: java.lang.String type. Group: security
      Parameters:
      userName - the value to set
      Returns:
      the dsl builder

    • validateSigningCertificateChain

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder validateSigningCertificateChain(Certificate[] validateSigningCertificateChain)
      Certificates to validate the message's signature against. If not supplied, validation will not take place. Server: validates the received message. Client: not yet implemented, should validate the MDN. The option is a: java.security.cert.Certificate[] type. Group: security
      Parameters:
      validateSigningCertificateChain - the value to set
      Returns:
      the dsl builder

    • validateSigningCertificateChain

      default AS2EndpointBuilderFactory.AS2EndpointConsumerBuilder validateSigningCertificateChain(String validateSigningCertificateChain)
      Certificates to validate the message's signature against. If not supplied, validation will not take place. Server: validates the received message. Client: not yet implemented, should validate the MDN. The option will be converted to a java.security.cert.Certificate[] type. Group: security
      Parameters:
      validateSigningCertificateChain - the value to set
      Returns:
      the dsl builder