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

Interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    BoxEndpointBuilderFactory.BoxEndpointBuilder
    Enclosing interface:
    BoxEndpointBuilderFactory
    public static interface BoxEndpointBuilderFactory.BoxEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Box component.

    • Method Detail

      • enterpriseId

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder enterpriseId​(String enterpriseId)
        The enterprise ID to use for an App Enterprise. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        enterpriseId - the value to set
        Returns:
        the dsl builder

      • inBody

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder 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

      • lazyStartProducer

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder 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 BoxEndpointBuilderFactory.BoxEndpointProducerBuilder 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

      • authenticationType

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder authenticationType​(String authenticationType)
        The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens. The option is a: <code>java.lang.String</code> type. Default: APP_USER_AUTHENTICATION Group: authentication
        Parameters:
        authenticationType - the value to set
        Returns:
        the dsl builder

      • privateKeyFile

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder privateKeyFile​(String privateKeyFile)
        The private key for generating the JWT signature. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        privateKeyFile - the value to set
        Returns:
        the dsl builder

      • privateKeyPassword

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder privateKeyPassword​(String privateKeyPassword)
        The password for the private key. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        privateKeyPassword - the value to set
        Returns:
        the dsl builder

      • publicKeyId

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder publicKeyId​(String publicKeyId)
        The ID for public key for validating the JWT signature. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        publicKeyId - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder sslContextParameters​(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
        To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder

      • sslContextParameters

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder sslContextParameters​(String sslContextParameters)
        To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
        Parameters:
        sslContextParameters - the value to set
        Returns:
        the dsl builder

      • userPassword

        default BoxEndpointBuilderFactory.BoxEndpointProducerBuilder userPassword​(String userPassword)
        Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        userPassword - the value to set
        Returns:
        the dsl builder