org.apache.camel.builder.endpoint.dsl

Interface JiraEndpointBuilderFactory.JiraEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

JiraEndpointBuilderFactory.JiraEndpointBuilder

Enclosing interface:

JiraEndpointBuilderFactory

public static interface JiraEndpointBuilderFactory.JiraEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Jira component.

Method Summary

Modifier and Type	Method and Description
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	accessToken(String accessToken) (OAuth only) The access token generated by the Jira server.
default JiraEndpointBuilderFactory.AdvancedJiraEndpointProducerBuilder	advanced()
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	consumerKey(String consumerKey) (OAuth only) The consumer key from Jira settings.
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	delay(Integer delay) Time in milliseconds to elapse for the next poll.
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	delay(String delay) Time in milliseconds to elapse for the next poll.
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	jiraUrl(String jiraUrl) The Jira server url, example: http://my_jira.com:8081.
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	password(String password) (Basic authentication only) The password to authenticate to the Jira server.
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	privateKey(String privateKey) (OAuth only) The private key generated by the client to encrypt the conversation to the server.
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	username(String username) (Basic authentication only) The username to authenticate to the Jira server.
default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder	verificationCode(String verificationCode) (OAuth only) The verification code from Jira generated in the first step of the authorization proccess.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default JiraEndpointBuilderFactory.AdvancedJiraEndpointProducerBuilder advanced()

delay

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder delay(Integer delay)

Time in milliseconds to elapse for the next poll. The option is a: <code>java.lang.Integer</code> type. Default: 6000 Group: common

Parameters:

delay - the value to set

Returns:

the dsl builder

delay

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder delay(String delay)

Time in milliseconds to elapse for the next poll. The option will be converted to a <code>java.lang.Integer</code> type. Default: 6000 Group: common

Parameters:

delay - the value to set

Returns:

the dsl builder

jiraUrl

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder jiraUrl(String jiraUrl)

The Jira server url, example: http://my_jira.com:8081. The option is a: <code>java.lang.String</code> type. Required: true Group: common

Parameters:

jiraUrl - the value to set

Returns:

the dsl builder

lazyStartProducer

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder 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 JiraEndpointBuilderFactory.JiraEndpointProducerBuilder 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

accessToken

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder accessToken(String accessToken)

(OAuth only) The access token generated by the Jira server. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

accessToken - the value to set

Returns:

the dsl builder

consumerKey

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder consumerKey(String consumerKey)

(OAuth only) The consumer key from Jira settings. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

consumerKey - the value to set

Returns:

the dsl builder

password

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder password(String password)

(Basic authentication only) The password to authenticate to the Jira server. Use only if username basic authentication is used. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

password - the value to set

Returns:

the dsl builder

privateKey

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder privateKey(String privateKey)

(OAuth only) The private key generated by the client to encrypt the conversation to the server. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

privateKey - the value to set

Returns:

the dsl builder

username

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder username(String username)

(Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

username - the value to set

Returns:

the dsl builder

verificationCode

default JiraEndpointBuilderFactory.JiraEndpointProducerBuilder verificationCode(String verificationCode)

(OAuth only) The verification code from Jira generated in the first step of the authorization proccess. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

verificationCode - the value to set

Returns:

the dsl builder