SIP (Session Initiation Protocol)

SIP (Session Initiation Protocol)

Scheme: sip
Name Kind Type Required Deprecated Default Value Enum Values Description
uri path java.net.URI true false URI of the SIP server to connect to (the username and password can be included such as: john:secret@myserver:9999)
addressFactory parameter javax.sip.address.AddressFactory false To use a custom AddressFactory
messageFactory parameter javax.sip.message.MessageFactory false To use a custom MessageFactory
headerFactory parameter javax.sip.header.HeaderFactory false To use a custom HeaderFactory
sipStack parameter javax.sip.SipStack false To use a custom SipStack
listeningPoint parameter javax.sip.ListeningPoint false To use a custom ListeningPoint implementation
sipUri parameter javax.sip.address.SipURI false To use a custom SipURI. If none configured, then the SipUri fallback to use the options toUser toHost:toPort
stackName parameter java.lang.String false NAME_NOT_SET Name of the SIP Stack instance associated with an SIP Endpoint.
transport parameter java.lang.String false tcp tcp
udp
Setting for choice of transport protocol. Valid choices are "tcp" or "udp".
maxForwards parameter int false Number of maximum proxy forwards
consumer parameter boolean false This setting is used to determine whether the kind of header (FromHeader,ToHeader etc) that needs to be created for this endpoint
eventHeaderName parameter java.lang.String false Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified
eventId parameter java.lang.String false Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified
msgExpiration parameter int false 3600 The amount of time a message received at an endpoint is considered valid
useRouterForAllUris parameter boolean false This setting is used when requests are sent to the Presence Agent via a proxy.
receiveTimeoutMillis parameter long false 10000 Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack
maxMessageSize parameter int false 1048576 Setting for maximum allowed Message size in bytes.
cacheConnections parameter boolean false 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.
contentType parameter java.lang.String false text Setting for contentType can be set to any valid MimeType.
contentSubType parameter java.lang.String false plain Setting for contentSubType can be set to any valid MimeSubType.
automaticDialogSupport parameter java.lang.String false off Setting to specify whether every communication should be associated with a dialog.
implementationServerLogFile parameter java.lang.String false Name of server log file to use for logging
implementationDebugLogFile parameter java.lang.String false Name of client debug log file to use for logging
implementationTraceLevel parameter java.lang.String false 0 Logging level for tracing
sipFactory parameter javax.sip.SipFactory false To use a custom SipFactory to create the SipStack to be used
fromUser parameter java.lang.String false Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified.
fromHost parameter java.lang.String false Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified
fromPort parameter int false Port of the message originator. Mandatory setting unless a registry based FromHeader is specified
toUser parameter java.lang.String false Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified.
toHost parameter java.lang.String false Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified
toPort parameter int false Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified
presenceAgent parameter boolean false This setting is used to distinguish between a Presence Agent & 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.
fromHeader parameter javax.sip.header.FromHeader false A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader
toHeader parameter javax.sip.header.ToHeader false A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader
viaHeaders parameter java.util.List false 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)
contentTypeHeader parameter javax.sip.header.ContentTypeHeader false A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader
callIdHeader parameter javax.sip.header.CallIdHeader false A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader
maxForwardsHeader parameter javax.sip.header.MaxForwardsHeader false 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
contactHeader parameter javax.sip.header.ContactHeader false An optional custom Header object containing verbose contact details (email, phone number etc). Must implement the type javax.sip.header.ContactHeader
eventHeader parameter javax.sip.header.EventHeader false A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader
extensionHeader parameter javax.sip.header.ExtensionHeader false A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader
expiresHeader parameter javax.sip.header.ExpiresHeader false A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).