SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

SipEndpointBuilderFactory.AdvancedSipEndpointBuilder

Enclosing interface:

SipEndpointBuilderFactory
```
public static interface SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Advanced builder for endpoint producers for the SIP component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`addressFactory(Object addressFactory)` To use a custom AddressFactory.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`addressFactory(String addressFactory)` To use a custom AddressFactory.
`default SipEndpointBuilderFactory.SipEndpointProducerBuilder`	`basic()`
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`callIdHeader(Object callIdHeader)` A custom Header object containing call details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`callIdHeader(String callIdHeader)` A custom Header object containing call details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`contactHeader(Object contactHeader)` An optional custom Header object containing verbose contact details (email, phone number etc).
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`contactHeader(String contactHeader)` An optional custom Header object containing verbose contact details (email, phone number etc).
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`contentTypeHeader(Object contentTypeHeader)` A custom Header object containing message content details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`contentTypeHeader(String contentTypeHeader)` A custom Header object containing message content details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`eventHeader(Object eventHeader)` A custom Header object containing event details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`eventHeader(String eventHeader)` A custom Header object containing event details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`expiresHeader(Object expiresHeader)` A custom Header object containing message expiration details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`expiresHeader(String expiresHeader)` A custom Header object containing message expiration details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`extensionHeader(Object extensionHeader)` A custom Header object containing user/application specific details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`extensionHeader(String extensionHeader)` A custom Header object containing user/application specific details.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`fromHeader(Object fromHeader)` A custom Header object containing message originator settings.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`fromHeader(String fromHeader)` A custom Header object containing message originator settings.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`headerFactory(Object headerFactory)` To use a custom HeaderFactory.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`headerFactory(String headerFactory)` To use a custom HeaderFactory.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`listeningPoint(Object listeningPoint)` To use a custom ListeningPoint implementation.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`listeningPoint(String listeningPoint)` To use a custom ListeningPoint implementation.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`maxForwardsHeader(Object maxForwardsHeader)` A custom Header object containing details on maximum proxy forwards.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`maxForwardsHeader(String maxForwardsHeader)` A custom Header object containing details on maximum proxy forwards.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`maxMessageSize(int maxMessageSize)` Setting for maximum allowed Message size in bytes.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`maxMessageSize(String maxMessageSize)` Setting for maximum allowed Message size in bytes.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`messageFactory(Object messageFactory)` To use a custom MessageFactory.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`messageFactory(String messageFactory)` To use a custom MessageFactory.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`sipFactory(Object sipFactory)` To use a custom SipFactory to create the SipStack to be used.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`sipFactory(String sipFactory)` To use a custom SipFactory to create the SipStack to be used.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`sipStack(Object sipStack)` To use a custom SipStack.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`sipStack(String sipStack)` To use a custom SipStack.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`sipUri(Object sipUri)` To use a custom SipURI.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`sipUri(String sipUri)` To use a custom SipURI.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`synchronous(boolean synchronous)` Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`synchronous(String synchronous)` Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`toHeader(Object toHeader)` A custom Header object containing message receiver settings.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`toHeader(String toHeader)` A custom Header object containing message receiver settings.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`viaHeaders(List<Object> viaHeaders)` List of custom Header objects of the type javax.sip.header.ViaHeader.
`default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder`	`viaHeaders(String viaHeaders)` List of custom Header objects of the type javax.sip.header.ViaHeader.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- Method Detail
  - basic
```
default SipEndpointBuilderFactory.SipEndpointProducerBuilder basic()
```
  - addressFactory
```
default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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
  - synchronous
```
default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder synchronous(boolean synchronous)
```
    Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced
    
    Parameters:
    
    synchronous - the value to set
    
    Returns:
    
    the dsl builder
  - synchronous
```
default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder synchronous(String synchronous)
```
    Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
    
    Parameters:
    
    synchronous - the value to set
    
    Returns:
    
    the dsl builder
  - toHeader
```
default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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.AdvancedSipEndpointProducerBuilder 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<javax.sip.header.ViaHeader></code> type. Group: advanced
    
    Parameters:
    
    viaHeaders - the value to set
    
    Returns:
    
    the dsl builder
  - viaHeaders
```
default SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder 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<javax.sip.header.ViaHeader></code> type. Group: advanced
    
    Parameters:
    
    viaHeaders - the value to set
    
    Returns:
    
    the dsl builder

Interface SipEndpointBuilderFactory.AdvancedSipEndpointProducerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

basic

addressFactory

addressFactory

callIdHeader

callIdHeader

contactHeader

contactHeader

contentTypeHeader

contentTypeHeader

eventHeader

eventHeader

expiresHeader

expiresHeader

extensionHeader

extensionHeader

fromHeader

fromHeader

headerFactory

headerFactory

listeningPoint

listeningPoint

maxForwardsHeader

maxForwardsHeader

maxMessageSize

maxMessageSize

messageFactory

messageFactory

sipFactory

sipFactory

sipStack

sipStack

sipUri

sipUri

synchronous

synchronous

toHeader

toHeader

viaHeaders

viaHeaders