org.apache.camel.builder.endpoint.dsl

Interface SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

SipEndpointBuilderFactory.AdvancedSipEndpointBuilder

Enclosing interface:

SipEndpointBuilderFactory

public static interface SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the SIP component.

Method Summary

Modifier and Type	Method and Description
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	addressFactory(Object addressFactory) To use a custom AddressFactory.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	addressFactory(String addressFactory) To use a custom AddressFactory.
default SipEndpointBuilderFactory.SipEndpointConsumerBuilder	basic()
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	callIdHeader(Object callIdHeader) A custom Header object containing call details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	callIdHeader(String callIdHeader) A custom Header object containing call details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	contactHeader(Object contactHeader) An optional custom Header object containing verbose contact details (email, phone number etc).
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	contactHeader(String contactHeader) An optional custom Header object containing verbose contact details (email, phone number etc).
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	contentTypeHeader(Object contentTypeHeader) A custom Header object containing message content details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	contentTypeHeader(String contentTypeHeader) A custom Header object containing message content details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	eventHeader(Object eventHeader) A custom Header object containing event details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	eventHeader(String eventHeader) A custom Header object containing event details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	expiresHeader(Object expiresHeader) A custom Header object containing message expiration details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	expiresHeader(String expiresHeader) A custom Header object containing message expiration details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	extensionHeader(Object extensionHeader) A custom Header object containing user/application specific details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	extensionHeader(String extensionHeader) A custom Header object containing user/application specific details.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	fromHeader(Object fromHeader) A custom Header object containing message originator settings.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	fromHeader(String fromHeader) A custom Header object containing message originator settings.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	headerFactory(Object headerFactory) To use a custom HeaderFactory.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	headerFactory(String headerFactory) To use a custom HeaderFactory.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	listeningPoint(Object listeningPoint) To use a custom ListeningPoint implementation.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	listeningPoint(String listeningPoint) To use a custom ListeningPoint implementation.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	maxForwardsHeader(Object maxForwardsHeader) A custom Header object containing details on maximum proxy forwards.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	maxForwardsHeader(String maxForwardsHeader) A custom Header object containing details on maximum proxy forwards.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	maxMessageSize(int maxMessageSize) Setting for maximum allowed Message size in bytes.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	maxMessageSize(String maxMessageSize) Setting for maximum allowed Message size in bytes.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	messageFactory(Object messageFactory) To use a custom MessageFactory.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	messageFactory(String messageFactory) To use a custom MessageFactory.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	sipFactory(Object sipFactory) To use a custom SipFactory to create the SipStack to be used.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	sipFactory(String sipFactory) To use a custom SipFactory to create the SipStack to be used.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	sipStack(Object sipStack) To use a custom SipStack.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	sipStack(String sipStack) To use a custom SipStack.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	sipUri(Object sipUri) To use a custom SipURI.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	sipUri(String sipUri) To use a custom SipURI.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	toHeader(Object toHeader) A custom Header object containing message receiver settings.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	toHeader(String toHeader) A custom Header object containing message receiver settings.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	viaHeaders(List<Object> viaHeaders) List of custom Header objects of the type javax.sip.header.ViaHeader.
default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder	viaHeaders(String viaHeaders) List of custom Header objects of the type javax.sip.header.ViaHeader.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default SipEndpointBuilderFactory.SipEndpointConsumerBuilder basic()

exceptionHandler

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler 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. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exceptionHandler

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder exceptionHandler(String 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. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

addressFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder addressFactory(Object addressFactory)

To use a custom AddressFactory. The option is a: <code>javax.sip.address.AddressFactory</code> type. Group: advanced

Parameters:

addressFactory - the value to set

Returns:

the dsl builder

addressFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder addressFactory(String addressFactory)

To use a custom AddressFactory. The option will be converted to a <code>javax.sip.address.AddressFactory</code> type. Group: advanced

Parameters:

addressFactory - the value to set

Returns:

the dsl builder

callIdHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder callIdHeader(Object callIdHeader)

A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader. The option is a: <code>javax.sip.header.CallIdHeader</code> type. Group: advanced

Parameters:

callIdHeader - the value to set

Returns:

the dsl builder

callIdHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder callIdHeader(String callIdHeader)

A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader. The option will be converted to a <code>javax.sip.header.CallIdHeader</code> type. Group: advanced

Parameters:

callIdHeader - the value to set

Returns:

the dsl builder

contactHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder contactHeader(Object contactHeader)

An optional custom Header object containing verbose contact details (email, phone number etc). Must implement the type javax.sip.header.ContactHeader. The option is a: <code>javax.sip.header.ContactHeader</code> type. Group: advanced

Parameters:

contactHeader - the value to set

Returns:

the dsl builder

contactHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder contactHeader(String contactHeader)

An optional custom Header object containing verbose contact details (email, phone number etc). Must implement the type javax.sip.header.ContactHeader. The option will be converted to a <code>javax.sip.header.ContactHeader</code> type. Group: advanced

Parameters:

contactHeader - the value to set

Returns:

the dsl builder

contentTypeHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder contentTypeHeader(Object contentTypeHeader)

A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader. The option is a: <code>javax.sip.header.ContentTypeHeader</code> type. Group: advanced

Parameters:

contentTypeHeader - the value to set

Returns:

the dsl builder

contentTypeHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder contentTypeHeader(String contentTypeHeader)

A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader. The option will be converted to a <code>javax.sip.header.ContentTypeHeader</code> type. Group: advanced

Parameters:

contentTypeHeader - the value to set

Returns:

the dsl builder

eventHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder eventHeader(Object eventHeader)

A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader. The option is a: <code>javax.sip.header.EventHeader</code> type. Group: advanced

Parameters:

eventHeader - the value to set

Returns:

the dsl builder

eventHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder eventHeader(String eventHeader)

A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader. The option will be converted to a <code>javax.sip.header.EventHeader</code> type. Group: advanced

Parameters:

eventHeader - the value to set

Returns:

the dsl builder

expiresHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder expiresHeader(Object expiresHeader)

A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader. The option is a: <code>javax.sip.header.ExpiresHeader</code> type. Group: advanced

Parameters:

expiresHeader - the value to set

Returns:

the dsl builder

expiresHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder expiresHeader(String expiresHeader)

A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader. The option will be converted to a <code>javax.sip.header.ExpiresHeader</code> type. Group: advanced

Parameters:

expiresHeader - the value to set

Returns:

the dsl builder

extensionHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder extensionHeader(Object extensionHeader)

A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader. The option is a: <code>javax.sip.header.ExtensionHeader</code> type. Group: advanced

Parameters:

extensionHeader - the value to set

Returns:

the dsl builder

extensionHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder extensionHeader(String extensionHeader)

A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader. The option will be converted to a <code>javax.sip.header.ExtensionHeader</code> type. Group: advanced

Parameters:

extensionHeader - the value to set

Returns:

the dsl builder

fromHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder fromHeader(Object fromHeader)

A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader. The option is a: <code>javax.sip.header.FromHeader</code> type. Group: advanced

Parameters:

fromHeader - the value to set

Returns:

the dsl builder

fromHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder fromHeader(String fromHeader)

A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader. The option will be converted to a <code>javax.sip.header.FromHeader</code> type. Group: advanced

Parameters:

fromHeader - the value to set

Returns:

the dsl builder

headerFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder headerFactory(Object headerFactory)

To use a custom HeaderFactory. The option is a: <code>javax.sip.header.HeaderFactory</code> type. Group: advanced

Parameters:

headerFactory - the value to set

Returns:

the dsl builder

headerFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder headerFactory(String headerFactory)

To use a custom HeaderFactory. The option will be converted to a <code>javax.sip.header.HeaderFactory</code> type. Group: advanced

Parameters:

headerFactory - the value to set

Returns:

the dsl builder

listeningPoint

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder listeningPoint(Object listeningPoint)

To use a custom ListeningPoint implementation. The option is a: <code>javax.sip.ListeningPoint</code> type. Group: advanced

Parameters:

listeningPoint - the value to set

Returns:

the dsl builder

listeningPoint

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder listeningPoint(String listeningPoint)

To use a custom ListeningPoint implementation. The option will be converted to a <code>javax.sip.ListeningPoint</code> type. Group: advanced

Parameters:

listeningPoint - the value to set

Returns:

the dsl builder

maxForwardsHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder maxForwardsHeader(Object 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. The option is a: <code>javax.sip.header.MaxForwardsHeader</code> type. Group: advanced

Parameters:

maxForwardsHeader - the value to set

Returns:

the dsl builder

maxForwardsHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder maxForwardsHeader(String 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. The option will be converted to a <code>javax.sip.header.MaxForwardsHeader</code> type. Group: advanced

Parameters:

maxForwardsHeader - the value to set

Returns:

the dsl builder

maxMessageSize

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder maxMessageSize(int maxMessageSize)

Setting for maximum allowed Message size in bytes. The option is a: <code>int</code> type. Default: 1048576 Group: advanced

Parameters:

maxMessageSize - the value to set

Returns:

the dsl builder

maxMessageSize

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder maxMessageSize(String maxMessageSize)

Setting for maximum allowed Message size in bytes. The option will be converted to a <code>int</code> type. Default: 1048576 Group: advanced

Parameters:

maxMessageSize - the value to set

Returns:

the dsl builder

messageFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder messageFactory(Object messageFactory)

To use a custom MessageFactory. The option is a: <code>javax.sip.message.MessageFactory</code> type. Group: advanced

Parameters:

messageFactory - the value to set

Returns:

the dsl builder

messageFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder messageFactory(String messageFactory)

To use a custom MessageFactory. The option will be converted to a <code>javax.sip.message.MessageFactory</code> type. Group: advanced

Parameters:

messageFactory - the value to set

Returns:

the dsl builder

sipFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder sipFactory(Object sipFactory)

To use a custom SipFactory to create the SipStack to be used. The option is a: <code>javax.sip.SipFactory</code> type. Group: advanced

Parameters:

sipFactory - the value to set

Returns:

the dsl builder

sipFactory

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder sipFactory(String sipFactory)

To use a custom SipFactory to create the SipStack to be used. The option will be converted to a <code>javax.sip.SipFactory</code> type. Group: advanced

Parameters:

sipFactory - the value to set

Returns:

the dsl builder

sipStack

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder sipStack(Object sipStack)

To use a custom SipStack. The option is a: <code>javax.sip.SipStack</code> type. Group: advanced

Parameters:

sipStack - the value to set

Returns:

the dsl builder

sipStack

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder sipStack(String sipStack)

To use a custom SipStack. The option will be converted to a <code>javax.sip.SipStack</code> type. Group: advanced

Parameters:

sipStack - the value to set

Returns:

the dsl builder

sipUri

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder sipUri(Object sipUri)

To use a custom SipURI. If none configured, then the SipUri fallback to use the options toUser toHost:toPort. The option is a: <code>javax.sip.address.SipURI</code> type. Group: advanced

Parameters:

sipUri - the value to set

Returns:

the dsl builder

sipUri

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder sipUri(String sipUri)

To use a custom SipURI. If none configured, then the SipUri fallback to use the options toUser toHost:toPort. The option will be converted to a <code>javax.sip.address.SipURI</code> type. Group: advanced

Parameters:

sipUri - the value to set

Returns:

the dsl builder

toHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder toHeader(Object toHeader)

A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader. The option is a: <code>javax.sip.header.ToHeader</code> type. Group: advanced

Parameters:

toHeader - the value to set

Returns:

the dsl builder

toHeader

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder toHeader(String toHeader)

A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader. The option will be converted to a <code>javax.sip.header.ToHeader</code> type. Group: advanced

Parameters:

toHeader - the value to set

Returns:

the dsl builder

viaHeaders

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder viaHeaders(List<Object> 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). The option is a: <code>java.util.List&lt;javax.sip.header.ViaHeader&gt;</code> type. Group: advanced

Parameters:

viaHeaders - the value to set

Returns:

the dsl builder

viaHeaders

default SipEndpointBuilderFactory.AdvancedSipEndpointConsumerBuilder viaHeaders(String 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). The option will be converted to a <code>java.util.List&lt;javax.sip.header.ViaHeader&gt;</code> type. Group: advanced

Parameters:

viaHeaders - the value to set

Returns:

the dsl builder