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

Interface SipEndpointBuilderFactory.SipEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    SipEndpointBuilderFactory.SipEndpointBuilder
    Enclosing interface:
    SipEndpointBuilderFactory
    public static interface SipEndpointBuilderFactory.SipEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the SIP component.

    • Method Detail

      • cacheConnections

        default SipEndpointBuilderFactory.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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

      • lazyStartProducer

        default SipEndpointBuilderFactory.SipEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default SipEndpointBuilderFactory.SipEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • implementationDebugLogFile

        default SipEndpointBuilderFactory.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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.SipEndpointProducerBuilder 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