camel-sip-kafka-connector sink configuration
Connector Description: Send and receive messages using the SIP protocol (used in telecommunications).
When using camel-sip-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-sip-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>To use this Sink connector in Kafka connect you’ll need to set the following connector.class
connector.class=org.apache.camel.kafkaconnector.sip.CamelSipSinkConnectorThe camel-sip sink connector supports 42 options, which are listed below.
| Name | Description | Default | Required | Priority |
|---|---|---|---|---|
camel.sink.path.uri |
URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999) |
null |
true |
HIGH |
camel.sink.endpoint.cacheConnections |
Should connections be cached by the SipStack to reduce cost of connection creation. This is useful if the connection is used for long running conversations. |
false |
false |
MEDIUM |
camel.sink.endpoint.contentSubType |
Setting for contentSubType can be set to any valid MimeSubType. |
"plain" |
false |
MEDIUM |
camel.sink.endpoint.contentType |
Setting for contentType can be set to any valid MimeType. |
"text" |
false |
MEDIUM |
camel.sink.endpoint.eventHeaderName |
Setting for a String based event type. |
null |
false |
MEDIUM |
camel.sink.endpoint.eventId |
Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified |
null |
false |
MEDIUM |
camel.sink.endpoint.fromHost |
Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified |
null |
false |
MEDIUM |
camel.sink.endpoint.fromPort |
Port of the message originator. Mandatory setting unless a registry based FromHeader is specified |
null |
false |
MEDIUM |
camel.sink.endpoint.fromUser |
Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. |
null |
false |
MEDIUM |
camel.sink.endpoint.msgExpiration |
The amount of time a message received at an endpoint is considered valid |
3600 |
false |
MEDIUM |
camel.sink.endpoint.receiveTimeoutMillis |
Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack |
10000L |
false |
MEDIUM |
camel.sink.endpoint.stackName |
Name of the SIP Stack instance associated with an SIP Endpoint. |
"NAME_NOT_SET" |
false |
MEDIUM |
camel.sink.endpoint.toHost |
Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified |
null |
false |
MEDIUM |
camel.sink.endpoint.toPort |
Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified |
null |
false |
MEDIUM |
camel.sink.endpoint.toUser |
Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. |
null |
false |
MEDIUM |
camel.sink.endpoint.transport |
Setting for choice of transport protocol. Valid choices are tcp or udp. One of: [tcp] [udp] |
"tcp" |
false |
MEDIUM |
camel.sink.endpoint.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. |
false |
false |
MEDIUM |
camel.sink.endpoint.addressFactory |
To use a custom AddressFactory |
null |
false |
MEDIUM |
camel.sink.endpoint.callIdHeader |
A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.contactHeader |
An optional custom Header object containing verbose contact details (email, phone number etc). Must implement the type javax.sip.header.ContactHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.contentTypeHeader |
A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.eventHeader |
A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.expiresHeader |
A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.extensionHeader |
A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.fromHeader |
A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.headerFactory |
To use a custom HeaderFactory |
null |
false |
MEDIUM |
camel.sink.endpoint.listeningPoint |
To use a custom ListeningPoint implementation |
null |
false |
MEDIUM |
camel.sink.endpoint.maxForwardsHeader |
A custom Header object containing details on maximum proxy forwards. This header places a limit on the viaHeaders possible. Must implement the type javax.sip.header.MaxForwardsHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.maxMessageSize |
Setting for maximum allowed Message size in bytes. |
1048576 |
false |
MEDIUM |
camel.sink.endpoint.messageFactory |
To use a custom MessageFactory |
null |
false |
MEDIUM |
camel.sink.endpoint.sipFactory |
To use a custom SipFactory to create the SipStack to be used |
null |
false |
MEDIUM |
camel.sink.endpoint.sipStack |
To use a custom SipStack |
null |
false |
MEDIUM |
camel.sink.endpoint.sipUri |
To use a custom SipURI. If none configured, then the SipUri fallback to use the options toUser toHost:toPort |
null |
false |
MEDIUM |
camel.sink.endpoint.toHeader |
A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader |
null |
false |
MEDIUM |
camel.sink.endpoint.viaHeaders |
List of custom Header objects of the type javax.sip.header.ViaHeader. Each ViaHeader containing a proxy address for request forwarding. (Note this header is automatically updated by each proxy when the request arrives at its listener) |
null |
false |
MEDIUM |
camel.sink.endpoint.implementationDebugLogFile |
Name of client debug log file to use for logging |
null |
false |
MEDIUM |
camel.sink.endpoint.implementationServerLogFile |
Name of server log file to use for logging |
null |
false |
MEDIUM |
camel.sink.endpoint.implementationTraceLevel |
Logging level for tracing |
"0" |
false |
MEDIUM |
camel.sink.endpoint.maxForwards |
Number of maximum proxy forwards |
null |
false |
MEDIUM |
camel.sink.endpoint.useRouterForAllUris |
This setting is used when requests are sent to the Presence Agent via a proxy. |
false |
false |
MEDIUM |
camel.component.sip.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. |
false |
false |
MEDIUM |
camel.component.sip.autowiredEnabled |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
false |
MEDIUM |
The camel-sip sink connector has no converters out of the box.
The camel-sip sink connector has no transforms out of the box.
The camel-sip sink connector has no aggregation strategies out of the box.