Package org.apache.camel.builder.endpoint.dsl

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 Detail

      • 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: <code>boolean</code> type. Default: false Group: common
        Parameters:
        cacheConnections - the value to set
        Returns:
        the dsl builder

      • 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 a <code>boolean</code> type. Default: false Group: common
        Parameters:
        cacheConnections - the value to set
        Returns:
        the dsl builder

      • contentSubType

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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
        Parameters:
        contentSubType - the value to set
        Returns:
        the dsl builder

      • contentType

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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
        Parameters:
        contentType - the value to set
        Returns:
        the dsl builder

      • eventHeaderName

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder eventHeaderName​(String eventHeaderName)
        Setting for a String based event type. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        eventHeaderName - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        eventId - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        fromHost - the value to set
        Returns:
        the dsl builder

      • 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: <code>int</code> type. Group: common
        Parameters:
        fromPort - the value to set
        Returns:
        the dsl builder

      • 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 a <code>int</code> type. Group: common
        Parameters:
        fromPort - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        fromUser - the value to set
        Returns:
        the dsl builder

      • msgExpiration

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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
        Parameters:
        msgExpiration - the value to set
        Returns:
        the dsl builder

      • 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 a <code>int</code> type. Default: 3600 Group: common
        Parameters:
        msgExpiration - the value to set
        Returns:
        the dsl builder

      • 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: <code>long</code> type. Default: 10000 Group: common
        Parameters:
        receiveTimeoutMillis - the value to set
        Returns:
        the dsl builder

      • 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 a <code>long</code> type. Default: 10000 Group: common
        Parameters:
        receiveTimeoutMillis - the value to set
        Returns:
        the dsl builder

      • stackName

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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
        Parameters:
        stackName - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        toHost - the value to set
        Returns:
        the dsl builder

      • 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: <code>int</code> type. Group: common
        Parameters:
        toPort - the value to set
        Returns:
        the dsl builder

      • 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 a <code>int</code> type. Group: common
        Parameters:
        toPort - the value to set
        Returns:
        the dsl builder

      • 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: <code>java.lang.String</code> type. Group: common
        Parameters:
        toUser - the value to set
        Returns:
        the dsl builder

      • transport

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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
        Parameters:
        transport - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • 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 a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        consumer - the value to set
        Returns:
        the dsl builder

      • 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 a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        consumer - the value to set
        Returns:
        the dsl builder

      • presenceAgent

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder presenceAgent​(boolean presenceAgent)
        This setting is used to distinguish between a Presence Agent and 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        presenceAgent - the value to set
        Returns:
        the dsl builder

      • presenceAgent

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder presenceAgent​(String presenceAgent)
        This setting is used to distinguish between a Presence Agent and 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 a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        presenceAgent - the value to set
        Returns:
        the dsl builder

      • implementationDebugLogFile

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder 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
        Parameters:
        implementationDebugLogFile - the value to set
        Returns:
        the dsl builder

      • implementationServerLogFile

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder implementationServerLogFile​(String implementationServerLogFile)
        Name of server log file to use for logging. The option is a: <code>java.lang.String</code> type. Group: logging
        Parameters:
        implementationServerLogFile - the value to set
        Returns:
        the dsl builder

      • implementationTraceLevel

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder implementationTraceLevel​(String implementationTraceLevel)
        Logging level for tracing. The option is a: <code>java.lang.String</code> type. Default: 0 Group: logging
        Parameters:
        implementationTraceLevel - the value to set
        Returns:
        the dsl builder

      • maxForwards

        default SipEndpointBuilderFactory.SipEndpointConsumerBuilder maxForwards​(int maxForwards)
        Number of maximum proxy forwards. The option is a: <code>int</code> type. Group: proxy
        Parameters:
        maxForwards - the value to set
        Returns:
        the dsl builder

      • 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: <code>boolean</code> type. Default: false Group: proxy
        Parameters:
        useRouterForAllUris - the value to set
        Returns:
        the dsl builder

      • 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 a <code>boolean</code> type. Default: false Group: proxy
        Parameters:
        useRouterForAllUris - the value to set
        Returns:
        the dsl builder