Interface AS2EndpointBuilderFactory.AS2EndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    AS2EndpointBuilderFactory.AS2EndpointBuilder
    Enclosing interface:
    AS2EndpointBuilderFactory

    public static interface AS2EndpointBuilderFactory.AS2EndpointProducerBuilder
    extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the AS2 component.
    • Method Detail

      • as2MessageStructure

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

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder 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 <code>org.apache.camel.component.as2.api.AS2MessageStructure</code> type. Group: common
        Parameters:
        as2MessageStructure - the value to set
        Returns:
        the dsl builder
      • clientFqdn

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

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder compressionAlgorithm​(String compressionAlgorithm)
        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
        Parameters:
        compressionAlgorithm - the value to set
        Returns:
        the dsl builder
      • decryptingPrivateKey

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder decryptingPrivateKey​(PrivateKey decryptingPrivateKey)
        The key used to encrypt the EDI message. The option is a: <code>java.security.PrivateKey</code> type. Group: common
        Parameters:
        decryptingPrivateKey - the value to set
        Returns:
        the dsl builder
      • decryptingPrivateKey

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder decryptingPrivateKey​(String decryptingPrivateKey)
        The key used to encrypt the EDI message. The option will be converted to a <code>java.security.PrivateKey</code> type. Group: common
        Parameters:
        decryptingPrivateKey - the value to set
        Returns:
        the dsl builder
      • dispositionNotificationTo

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        dispositionNotificationTo - the value to set
        Returns:
        the dsl builder
      • ediMessageTransferEncoding

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder ediMessageTransferEncoding​(String ediMessageTransferEncoding)
        The transfer encoding of EDI message. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        ediMessageTransferEncoding - the value to set
        Returns:
        the dsl builder
      • ediMessageType

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder ediMessageType​(Object ediMessageType)
        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
        Parameters:
        ediMessageType - the value to set
        Returns:
        the dsl builder
      • ediMessageType

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder ediMessageType​(String ediMessageType)
        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
        Parameters:
        ediMessageType - the value to set
        Returns:
        the dsl builder
      • encryptingAlgorithm

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder encryptingAlgorithm​(String encryptingAlgorithm)
        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
        Parameters:
        encryptingAlgorithm - the value to set
        Returns:
        the dsl builder
      • encryptingCertificateChain

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder encryptingCertificateChain​(Certificate[] encryptingCertificateChain)
        The chain of certificates used to encrypt EDI message. The option is a: <code>java.security.cert.Certificate[]</code> type. Group: common
        Parameters:
        encryptingCertificateChain - the value to set
        Returns:
        the dsl builder
      • encryptingCertificateChain

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder encryptingCertificateChain​(String encryptingCertificateChain)
        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
        Parameters:
        encryptingCertificateChain - the value to set
        Returns:
        the dsl builder
      • inBody

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder inBody​(String inBody)
        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
        Parameters:
        inBody - the value to set
        Returns:
        the dsl builder
      • mdnMessageTemplate

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder mdnMessageTemplate​(String mdnMessageTemplate)
        The template used to format MDN message. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        mdnMessageTemplate - the value to set
        Returns:
        the dsl builder
      • server

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

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

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder serverPortNumber​(Integer serverPortNumber)
        The port number of server. The option is a: <code>java.lang.Integer</code> type. Group: common
        Parameters:
        serverPortNumber - the value to set
        Returns:
        the dsl builder
      • serverPortNumber

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder serverPortNumber​(String serverPortNumber)
        The port number of server. The option will be converted to a <code>java.lang.Integer</code> type. Group: common
        Parameters:
        serverPortNumber - the value to set
        Returns:
        the dsl builder
      • signedReceiptMicAlgorithms

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder signedReceiptMicAlgorithms​(String[] signedReceiptMicAlgorithms)
        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
        Parameters:
        signedReceiptMicAlgorithms - the value to set
        Returns:
        the dsl builder
      • signedReceiptMicAlgorithms

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder signedReceiptMicAlgorithms​(String signedReceiptMicAlgorithms)
        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
        Parameters:
        signedReceiptMicAlgorithms - the value to set
        Returns:
        the dsl builder
      • signingAlgorithm

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder signingAlgorithm​(String signingAlgorithm)
        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
        Parameters:
        signingAlgorithm - the value to set
        Returns:
        the dsl builder
      • signingCertificateChain

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder signingCertificateChain​(Certificate[] signingCertificateChain)
        The chain of certificates used to sign EDI message. The option is a: <code>java.security.cert.Certificate[]</code> type. Group: common
        Parameters:
        signingCertificateChain - the value to set
        Returns:
        the dsl builder
      • signingCertificateChain

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder signingCertificateChain​(String signingCertificateChain)
        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
        Parameters:
        signingCertificateChain - the value to set
        Returns:
        the dsl builder
      • signingPrivateKey

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder signingPrivateKey​(PrivateKey signingPrivateKey)
        The key used to sign the EDI message. The option is a: <code>java.security.PrivateKey</code> type. Group: common
        Parameters:
        signingPrivateKey - the value to set
        Returns:
        the dsl builder
      • signingPrivateKey

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder signingPrivateKey​(String signingPrivateKey)
        The key used to sign the EDI message. The option will be converted to a <code>java.security.PrivateKey</code> type. Group: common
        Parameters:
        signingPrivateKey - the value to set
        Returns:
        the dsl builder
      • targetHostname

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder targetHostname​(String targetHostname)
        The host name (IP or DNS name) of target host. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        targetHostname - the value to set
        Returns:
        the dsl builder
      • targetPortNumber

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder targetPortNumber​(Integer targetPortNumber)
        The port number of target host. -1 indicates the scheme default port. The option is a: <code>java.lang.Integer</code> type. Group: common
        Parameters:
        targetPortNumber - the value to set
        Returns:
        the dsl builder
      • targetPortNumber

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder targetPortNumber​(String targetPortNumber)
        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
        Parameters:
        targetPortNumber - the value to set
        Returns:
        the dsl builder
      • userAgent

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

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        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. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder
      • lazyStartProducer

        default AS2EndpointBuilderFactory.AS2EndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        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. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder