camel-sip-kafka-connector source configuration

Connector Description: Send and receive messages using the SIP protocol (used in telecommunications).

When using camel-sip-kafka-connector as source 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 source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.sip.CamelSipSourceConnector

The camel-sip source connector supports 46 options, which are listed below.

Name Description Default Priority

camel.source.path.uri

Required URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999).

HIGH

camel.source.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

MEDIUM

camel.source.endpoint.contentSubType

Setting for contentSubType can be set to any valid MimeSubType.

"plain"

MEDIUM

camel.source.endpoint.contentType

Setting for contentType can be set to any valid MimeType.

"text"

MEDIUM

camel.source.endpoint.eventHeaderName

Setting for a String based event type.

MEDIUM

camel.source.endpoint.eventId

Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified.

MEDIUM

camel.source.endpoint.fromHost

Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified.

MEDIUM

camel.source.endpoint.fromPort

Port of the message originator. Mandatory setting unless a registry based FromHeader is specified.

MEDIUM

camel.source.endpoint.fromUser

Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified.

MEDIUM

camel.source.endpoint.msgExpiration

The amount of time a message received at an endpoint is considered valid.

3600

MEDIUM

camel.source.endpoint.receiveTimeoutMillis

Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack.

10000L

MEDIUM

camel.source.endpoint.stackName

Name of the SIP Stack instance associated with an SIP Endpoint.

"NAME_NOT_SET"

MEDIUM

camel.source.endpoint.toHost

Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified.

MEDIUM

camel.source.endpoint.toPort

Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified.

MEDIUM

camel.source.endpoint.toUser

Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified.

MEDIUM

camel.source.endpoint.transport

Setting for choice of transport protocol. Valid choices are tcp or udp. One of: [tcp] [udp].

Enum values:

  • tcp

  • udp

"tcp"

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

MEDIUM

camel.source.endpoint.consumer

This setting is used to determine whether the kind of header (FromHeader,ToHeader etc) that needs to be created for this endpoint.

false

MEDIUM

camel.source.endpoint.presenceAgent

This setting is used to distinguish between a Presence Agent and a consumer. This is due to the fact that the SIP Camel component ships with a basic Presence Agent (for testing purposes only). Consumers have to set this flag to true.

false

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.addressFactory

To use a custom AddressFactory.

MEDIUM

camel.source.endpoint.callIdHeader

A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader.

MEDIUM

camel.source.endpoint.contactHeader

An optional custom Header object containing verbose contact details (email, phone number etc). Must implement the type javax.sip.header.ContactHeader.

MEDIUM

camel.source.endpoint.contentTypeHeader

A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader.

MEDIUM

camel.source.endpoint.eventHeader

A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader.

MEDIUM

camel.source.endpoint.expiresHeader

A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader.

MEDIUM

camel.source.endpoint.extensionHeader

A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader.

MEDIUM

camel.source.endpoint.fromHeader

A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader.

MEDIUM

camel.source.endpoint.headerFactory

To use a custom HeaderFactory.

MEDIUM

camel.source.endpoint.listeningPoint

To use a custom ListeningPoint implementation.

MEDIUM

camel.source.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.

MEDIUM

camel.source.endpoint.maxMessageSize

Setting for maximum allowed Message size in bytes.

1048576

MEDIUM

camel.source.endpoint.messageFactory

To use a custom MessageFactory.

MEDIUM

camel.source.endpoint.sipFactory

To use a custom SipFactory to create the SipStack to be used.

MEDIUM

camel.source.endpoint.sipStack

To use a custom SipStack.

MEDIUM

camel.source.endpoint.sipUri

To use a custom SipURI. If none configured, then the SipUri fallback to use the options toUser toHost:toPort.

MEDIUM

camel.source.endpoint.toHeader

A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader.

MEDIUM

camel.source.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).

MEDIUM

camel.source.endpoint.implementationDebugLogFile

Name of client debug log file to use for logging.

MEDIUM

camel.source.endpoint.implementationServerLogFile

Name of server log file to use for logging.

MEDIUM

camel.source.endpoint.implementationTraceLevel

Logging level for tracing.

"0"

MEDIUM

camel.source.endpoint.maxForwards

Number of maximum proxy forwards.

MEDIUM

camel.source.endpoint.useRouterForAllUris

This setting is used when requests are sent to the Presence Agent via a proxy.

false

MEDIUM

camel.component.sip.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

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

MEDIUM

The camel-sip source connector has no converters out of the box.

The camel-sip source connector has no transforms out of the box.

The camel-sip source connector has no aggregation strategies out of the box.