Interface SipEndpointBuilderFactory.SipEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,SipEndpointBuilderFactory.SipEndpointConsumerBuilder
,SipEndpointBuilderFactory.SipEndpointProducerBuilder
- Enclosing interface:
- SipEndpointBuilderFactory
public static interface SipEndpointBuilderFactory.SipEndpointBuilder extends SipEndpointBuilderFactory.SipEndpointConsumerBuilder, SipEndpointBuilderFactory.SipEndpointProducerBuilder
Builder for endpoint for the SIP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SipEndpointBuilderFactory.AdvancedSipEndpointBuilder
advanced()
default SipEndpointBuilderFactory.SipEndpointBuilder
cacheConnections(boolean cacheConnections)
Should connections be cached by the SipStack to reduce cost of connection creation.default SipEndpointBuilderFactory.SipEndpointBuilder
cacheConnections(String cacheConnections)
Should connections be cached by the SipStack to reduce cost of connection creation.default SipEndpointBuilderFactory.SipEndpointBuilder
contentSubType(String contentSubType)
Setting for contentSubType can be set to any valid MimeSubType.default SipEndpointBuilderFactory.SipEndpointBuilder
contentType(String contentType)
Setting for contentType can be set to any valid MimeType.default SipEndpointBuilderFactory.SipEndpointBuilder
eventHeaderName(String eventHeaderName)
Setting for a String based event type.default SipEndpointBuilderFactory.SipEndpointBuilder
eventId(String eventId)
Setting for a String based event Id.default SipEndpointBuilderFactory.SipEndpointBuilder
fromHost(String fromHost)
Hostname of the message originator.default SipEndpointBuilderFactory.SipEndpointBuilder
fromPort(int fromPort)
Port of the message originator.default SipEndpointBuilderFactory.SipEndpointBuilder
fromPort(String fromPort)
Port of the message originator.default SipEndpointBuilderFactory.SipEndpointBuilder
fromUser(String fromUser)
Username of the message originator.default SipEndpointBuilderFactory.SipEndpointBuilder
implementationDebugLogFile(String implementationDebugLogFile)
Name of client debug log file to use for logging.default SipEndpointBuilderFactory.SipEndpointBuilder
implementationServerLogFile(String implementationServerLogFile)
Name of server log file to use for logging.default SipEndpointBuilderFactory.SipEndpointBuilder
implementationTraceLevel(String implementationTraceLevel)
Logging level for tracing.default SipEndpointBuilderFactory.SipEndpointBuilder
maxForwards(int maxForwards)
Number of maximum proxy forwards.default SipEndpointBuilderFactory.SipEndpointBuilder
maxForwards(String maxForwards)
Number of maximum proxy forwards.default SipEndpointBuilderFactory.SipEndpointBuilder
msgExpiration(int msgExpiration)
The amount of time a message received at an endpoint is considered valid.default SipEndpointBuilderFactory.SipEndpointBuilder
msgExpiration(String msgExpiration)
The amount of time a message received at an endpoint is considered valid.default SipEndpointBuilderFactory.SipEndpointBuilder
receiveTimeoutMillis(long receiveTimeoutMillis)
Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack.default SipEndpointBuilderFactory.SipEndpointBuilder
receiveTimeoutMillis(String receiveTimeoutMillis)
Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack.default SipEndpointBuilderFactory.SipEndpointBuilder
stackName(String stackName)
Name of the SIP Stack instance associated with an SIP Endpoint.default SipEndpointBuilderFactory.SipEndpointBuilder
toHost(String toHost)
Hostname of the message receiver.default SipEndpointBuilderFactory.SipEndpointBuilder
toPort(int toPort)
Portname of the message receiver.default SipEndpointBuilderFactory.SipEndpointBuilder
toPort(String toPort)
Portname of the message receiver.default SipEndpointBuilderFactory.SipEndpointBuilder
toUser(String toUser)
Username of the message receiver.default SipEndpointBuilderFactory.SipEndpointBuilder
transport(String transport)
Setting for choice of transport protocol.default SipEndpointBuilderFactory.SipEndpointBuilder
useRouterForAllUris(boolean useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy.default SipEndpointBuilderFactory.SipEndpointBuilder
useRouterForAllUris(String useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy.-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SipEndpointBuilderFactory.SipEndpointConsumerBuilder
bridgeErrorHandler, bridgeErrorHandler, consumer, consumer, presenceAgent, presenceAgent
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SipEndpointBuilderFactory.SipEndpointProducerBuilder
lazyStartProducer, lazyStartProducer
-
-
-
-
Method Detail
-
advanced
default SipEndpointBuilderFactory.AdvancedSipEndpointBuilder advanced()
- Specified by:
advanced
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
advanced
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
-
cacheConnections
default SipEndpointBuilderFactory.SipEndpointBuilder cacheConnections(boolean 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. The option is a: <code>boolean</code> type. Default: false Group: common- Specified by:
cacheConnections
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
cacheConnections
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
cacheConnections
- the value to set- Returns:
- the dsl builder
-
cacheConnections
default SipEndpointBuilderFactory.SipEndpointBuilder cacheConnections(String 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. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Specified by:
cacheConnections
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
cacheConnections
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
cacheConnections
- the value to set- Returns:
- the dsl builder
-
contentSubType
default SipEndpointBuilderFactory.SipEndpointBuilder contentSubType(String contentSubType)
Setting for contentSubType can be set to any valid MimeSubType. The option is a: <code>java.lang.String</code> type. Default: plain Group: common- Specified by:
contentSubType
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
contentSubType
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
contentSubType
- the value to set- Returns:
- the dsl builder
-
contentType
default SipEndpointBuilderFactory.SipEndpointBuilder contentType(String contentType)
Setting for contentType can be set to any valid MimeType. The option is a: <code>java.lang.String</code> type. Default: text Group: common- Specified by:
contentType
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
contentType
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
contentType
- the value to set- Returns:
- the dsl builder
-
eventHeaderName
default SipEndpointBuilderFactory.SipEndpointBuilder eventHeaderName(String eventHeaderName)
Setting for a String based event type. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
eventHeaderName
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
eventHeaderName
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
eventHeaderName
- the value to set- Returns:
- the dsl builder
-
eventId
default SipEndpointBuilderFactory.SipEndpointBuilder eventId(String eventId)
Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
eventId
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
eventId
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
eventId
- the value to set- Returns:
- the dsl builder
-
fromHost
default SipEndpointBuilderFactory.SipEndpointBuilder fromHost(String fromHost)
Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
fromHost
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
fromHost
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
fromHost
- the value to set- Returns:
- the dsl builder
-
fromPort
default SipEndpointBuilderFactory.SipEndpointBuilder fromPort(int fromPort)
Port of the message originator. Mandatory setting unless a registry based FromHeader is specified. The option is a: <code>int</code> type. Group: common- Specified by:
fromPort
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
fromPort
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
fromPort
- the value to set- Returns:
- the dsl builder
-
fromPort
default SipEndpointBuilderFactory.SipEndpointBuilder fromPort(String fromPort)
Port of the message originator. Mandatory setting unless a registry based FromHeader is specified. The option will be converted to a <code>int</code> type. Group: common- Specified by:
fromPort
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
fromPort
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
fromPort
- the value to set- Returns:
- the dsl builder
-
fromUser
default SipEndpointBuilderFactory.SipEndpointBuilder fromUser(String fromUser)
Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
fromUser
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
fromUser
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
fromUser
- the value to set- Returns:
- the dsl builder
-
msgExpiration
default SipEndpointBuilderFactory.SipEndpointBuilder msgExpiration(int msgExpiration)
The amount of time a message received at an endpoint is considered valid. The option is a: <code>int</code> type. Default: 3600 Group: common- Specified by:
msgExpiration
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
msgExpiration
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
msgExpiration
- the value to set- Returns:
- the dsl builder
-
msgExpiration
default SipEndpointBuilderFactory.SipEndpointBuilder msgExpiration(String msgExpiration)
The amount of time a message received at an endpoint is considered valid. The option will be converted to a <code>int</code> type. Default: 3600 Group: common- Specified by:
msgExpiration
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
msgExpiration
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
msgExpiration
- the value to set- Returns:
- the dsl builder
-
receiveTimeoutMillis
default SipEndpointBuilderFactory.SipEndpointBuilder receiveTimeoutMillis(long receiveTimeoutMillis)
Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack. The option is a: <code>long</code> type. Default: 10000 Group: common- Specified by:
receiveTimeoutMillis
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
receiveTimeoutMillis
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
receiveTimeoutMillis
- the value to set- Returns:
- the dsl builder
-
receiveTimeoutMillis
default SipEndpointBuilderFactory.SipEndpointBuilder receiveTimeoutMillis(String receiveTimeoutMillis)
Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack. The option will be converted to a <code>long</code> type. Default: 10000 Group: common- Specified by:
receiveTimeoutMillis
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
receiveTimeoutMillis
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
receiveTimeoutMillis
- the value to set- Returns:
- the dsl builder
-
stackName
default SipEndpointBuilderFactory.SipEndpointBuilder stackName(String stackName)
Name of the SIP Stack instance associated with an SIP Endpoint. The option is a: <code>java.lang.String</code> type. Default: NAME_NOT_SET Group: common- Specified by:
stackName
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
stackName
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
stackName
- the value to set- Returns:
- the dsl builder
-
toHost
default SipEndpointBuilderFactory.SipEndpointBuilder toHost(String toHost)
Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
toHost
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
toHost
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
toHost
- the value to set- Returns:
- the dsl builder
-
toPort
default SipEndpointBuilderFactory.SipEndpointBuilder toPort(int toPort)
Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified. The option is a: <code>int</code> type. Group: common- Specified by:
toPort
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
toPort
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
toPort
- the value to set- Returns:
- the dsl builder
-
toPort
default SipEndpointBuilderFactory.SipEndpointBuilder toPort(String toPort)
Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified. The option will be converted to a <code>int</code> type. Group: common- Specified by:
toPort
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
toPort
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
toPort
- the value to set- Returns:
- the dsl builder
-
toUser
default SipEndpointBuilderFactory.SipEndpointBuilder toUser(String toUser)
Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
toUser
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
toUser
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
toUser
- the value to set- Returns:
- the dsl builder
-
transport
default SipEndpointBuilderFactory.SipEndpointBuilder transport(String transport)
Setting for choice of transport protocol. Valid choices are tcp or udp. The option is a: <code>java.lang.String</code> type. Default: tcp Group: common- Specified by:
transport
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
transport
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
transport
- the value to set- Returns:
- the dsl builder
-
implementationDebugLogFile
default SipEndpointBuilderFactory.SipEndpointBuilder implementationDebugLogFile(String implementationDebugLogFile)
Name of client debug log file to use for logging. The option is a: <code>java.lang.String</code> type. Group: logging- Specified by:
implementationDebugLogFile
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
implementationDebugLogFile
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
implementationDebugLogFile
- the value to set- Returns:
- the dsl builder
-
implementationServerLogFile
default SipEndpointBuilderFactory.SipEndpointBuilder implementationServerLogFile(String implementationServerLogFile)
Name of server log file to use for logging. The option is a: <code>java.lang.String</code> type. Group: logging- Specified by:
implementationServerLogFile
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
implementationServerLogFile
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
implementationServerLogFile
- the value to set- Returns:
- the dsl builder
-
implementationTraceLevel
default SipEndpointBuilderFactory.SipEndpointBuilder implementationTraceLevel(String implementationTraceLevel)
Logging level for tracing. The option is a: <code>java.lang.String</code> type. Default: 0 Group: logging- Specified by:
implementationTraceLevel
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
implementationTraceLevel
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
implementationTraceLevel
- the value to set- Returns:
- the dsl builder
-
maxForwards
default SipEndpointBuilderFactory.SipEndpointBuilder maxForwards(int maxForwards)
Number of maximum proxy forwards. The option is a: <code>int</code> type. Group: proxy- Specified by:
maxForwards
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
maxForwards
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
maxForwards
- the value to set- Returns:
- the dsl builder
-
maxForwards
default SipEndpointBuilderFactory.SipEndpointBuilder maxForwards(String maxForwards)
Number of maximum proxy forwards. The option will be converted to a <code>int</code> type. Group: proxy- Specified by:
maxForwards
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
maxForwards
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
maxForwards
- the value to set- Returns:
- the dsl builder
-
useRouterForAllUris
default SipEndpointBuilderFactory.SipEndpointBuilder useRouterForAllUris(boolean useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy. The option is a: <code>boolean</code> type. Default: false Group: proxy- Specified by:
useRouterForAllUris
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
useRouterForAllUris
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
useRouterForAllUris
- the value to set- Returns:
- the dsl builder
-
useRouterForAllUris
default SipEndpointBuilderFactory.SipEndpointBuilder useRouterForAllUris(String useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy. The option will be converted to a <code>boolean</code> type. Default: false Group: proxy- Specified by:
useRouterForAllUris
in interfaceSipEndpointBuilderFactory.SipEndpointConsumerBuilder
- Specified by:
useRouterForAllUris
in interfaceSipEndpointBuilderFactory.SipEndpointProducerBuilder
- Parameters:
useRouterForAllUris
- the value to set- Returns:
- the dsl builder
-
-