Interface SipEndpointBuilderFactory.SipEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
SipEndpointBuilderFactory.SipEndpointBuilder
- Enclosing interface:
- SipEndpointBuilderFactory
public static interface SipEndpointBuilderFactory.SipEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the SIP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder
advanced()
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
bridgeErrorHandler(boolean 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.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
bridgeErrorHandler(String 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.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
cacheConnections(boolean cacheConnections)
Should connections be cached by the SipStack to reduce cost of connection creation.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
cacheConnections(String cacheConnections)
Should connections be cached by the SipStack to reduce cost of connection creation.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
consumer(boolean consumer)
This setting is used to determine whether the kind of header (FromHeader,ToHeader etc) that needs to be created for this endpoint.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
consumer(String consumer)
This setting is used to determine whether the kind of header (FromHeader,ToHeader etc) that needs to be created for this endpoint.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
contentSubType(String contentSubType)
Setting for contentSubType can be set to any valid MimeSubType.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
contentType(String contentType)
Setting for contentType can be set to any valid MimeType.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
eventHeaderName(String eventHeaderName)
Setting for a String based event type.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
eventId(String eventId)
Setting for a String based event Id.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
fromHost(String fromHost)
Hostname of the message originator.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
fromPort(int fromPort)
Port of the message originator.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
fromPort(String fromPort)
Port of the message originator.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
fromUser(String fromUser)
Username of the message originator.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
implementationDebugLogFile(String implementationDebugLogFile)
Name of client debug log file to use for logging.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
implementationServerLogFile(String implementationServerLogFile)
Name of server log file to use for logging.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
implementationTraceLevel(String implementationTraceLevel)
Logging level for tracing.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
maxForwards(int maxForwards)
Number of maximum proxy forwards.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
maxForwards(String maxForwards)
Number of maximum proxy forwards.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
msgExpiration(int msgExpiration)
The amount of time a message received at an endpoint is considered valid.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
msgExpiration(String msgExpiration)
The amount of time a message received at an endpoint is considered valid.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
presenceAgent(boolean presenceAgent)
This setting is used to distinguish between a Presence Agent & a consumer.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
presenceAgent(String presenceAgent)
This setting is used to distinguish between a Presence Agent & a consumer.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
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.SipEndpointConsumerBuilder
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.SipEndpointConsumerBuilder
stackName(String stackName)
Name of the SIP Stack instance associated with an SIP Endpoint.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
toHost(String toHost)
Hostname of the message receiver.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
toPort(int toPort)
Portname of the message receiver.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
toPort(String toPort)
Portname of the message receiver.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
toUser(String toUser)
Username of the message receiver.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
transport(String transport)
Setting for choice of transport protocol.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
useRouterForAllUris(boolean useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy.default SipEndpointBuilderFactory.SipEndpointConsumerBuilder
useRouterForAllUris(String useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy.
-
-
-
Method Detail
-
advanced
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder advanced()
-
cacheConnections
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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:boolean
type. Default: false Group: common
-
cacheConnections
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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 aboolean
type. Default: false Group: common
-
contentSubType
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder contentSubType(String contentSubType)
Setting for contentSubType can be set to any valid MimeSubType. The option is a:java.lang.String
type. Default: plain Group: common
-
contentType
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder contentType(String contentType)
Setting for contentType can be set to any valid MimeType. The option is a:java.lang.String
type. Default: text Group: common
-
eventHeaderName
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder eventHeaderName(String eventHeaderName)
Setting for a String based event type. The option is a:java.lang.String
type. Group: common
-
eventId
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder eventId(String eventId)
Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified. The option is a:java.lang.String
type. Group: common
-
fromHost
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder fromHost(String fromHost)
Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified. The option is a:java.lang.String
type. Group: common
-
fromPort
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder fromPort(int fromPort)
Port of the message originator. Mandatory setting unless a registry based FromHeader is specified. The option is a:int
type. Group: common
-
fromPort
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder fromPort(String fromPort)
Port of the message originator. Mandatory setting unless a registry based FromHeader is specified. The option will be converted to aint
type. Group: common
-
fromUser
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder fromUser(String fromUser)
Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. The option is a:java.lang.String
type. Group: common
-
msgExpiration
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder msgExpiration(int msgExpiration)
The amount of time a message received at an endpoint is considered valid. The option is a:int
type. Default: 3600 Group: common
-
msgExpiration
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder msgExpiration(String msgExpiration)
The amount of time a message received at an endpoint is considered valid. The option will be converted to aint
type. Default: 3600 Group: common
-
receiveTimeoutMillis
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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:long
type. Default: 10000 Group: common
-
receiveTimeoutMillis
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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 along
type. Default: 10000 Group: common
-
stackName
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder stackName(String stackName)
Name of the SIP Stack instance associated with an SIP Endpoint. The option is a:java.lang.String
type. Default: NAME_NOT_SET Group: common
-
toHost
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder toHost(String toHost)
Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified. The option is a:java.lang.String
type. Group: common
-
toPort
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder toPort(int toPort)
Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified. The option is a:int
type. Group: common
-
toPort
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder toPort(String toPort)
Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified. The option will be converted to aint
type. Group: common
-
toUser
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder toUser(String toUser)
Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. The option is a:java.lang.String
type. Group: common
-
transport
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder transport(String transport)
Setting for choice of transport protocol. Valid choices are tcp or udp. The option is a:java.lang.String
type. Default: tcp Group: common
-
bridgeErrorHandler
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder bridgeErrorHandler(boolean 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. The option is a:boolean
type. Default: false Group: consumer
-
bridgeErrorHandler
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder bridgeErrorHandler(String 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. The option will be converted to aboolean
type. Default: false Group: consumer
-
consumer
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder consumer(boolean consumer)
This setting is used to determine whether the kind of header (FromHeader,ToHeader etc) that needs to be created for this endpoint. The option is a:boolean
type. Default: false Group: consumer
-
consumer
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder consumer(String consumer)
This setting is used to determine whether the kind of header (FromHeader,ToHeader etc) that needs to be created for this endpoint. The option will be converted to aboolean
type. Default: false Group: consumer
-
presenceAgent
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder presenceAgent(boolean presenceAgent)
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. The option is a:boolean
type. Default: false Group: consumer
-
presenceAgent
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder presenceAgent(String presenceAgent)
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. The option will be converted to aboolean
type. Default: false Group: consumer
-
implementationDebugLogFile
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder implementationDebugLogFile(String implementationDebugLogFile)
Name of client debug log file to use for logging. The option is a:java.lang.String
type. Group: logging
-
implementationServerLogFile
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder implementationServerLogFile(String implementationServerLogFile)
Name of server log file to use for logging. The option is a:java.lang.String
type. Group: logging
-
implementationTraceLevel
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder implementationTraceLevel(String implementationTraceLevel)
Logging level for tracing. The option is a:java.lang.String
type. Default: 0 Group: logging
-
maxForwards
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder maxForwards(int maxForwards)
Number of maximum proxy forwards. The option is a:int
type. Group: proxy
-
maxForwards
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder maxForwards(String maxForwards)
Number of maximum proxy forwards. The option will be converted to aint
type. Group: proxy
-
useRouterForAllUris
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder useRouterForAllUris(boolean useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy. The option is a:boolean
type. Default: false Group: proxy
-
useRouterForAllUris
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder useRouterForAllUris(String useRouterForAllUris)
This setting is used when requests are sent to the Presence Agent via a proxy. The option will be converted to aboolean
type. Default: false Group: proxy
-
-