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