| { |
| "component": { |
| "kind": "component", |
| "name": "sip", |
| "title": "SIP", |
| "description": "Send and receive messages using the SIP protocol (used in telecommunications).", |
| "deprecated": false, |
| "firstVersion": "2.5.0", |
| "label": "mobile", |
| "javaType": "org.apache.camel.component.sip.SipComponent", |
| "supportLevel": "Stable", |
| "groupId": "org.apache.camel.springboot", |
| "artifactId": "camel-sip-starter", |
| "version": "3.11.1-SNAPSHOT", |
| "scheme": "sip", |
| "extendsScheme": "", |
| "alternativeSchemes": "sip,sips", |
| "syntax": "sip:uri", |
| "async": false, |
| "api": false, |
| "consumerOnly": false, |
| "producerOnly": false, |
| "lenientProperties": false |
| }, |
| "componentProperties": { |
| "bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." }, |
| "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." }, |
| "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc." } |
| }, |
| "properties": { |
| "uri": { "kind": "path", "displayName": "Uri", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.net.URI", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999)" }, |
| "cacheConnections": { "kind": "parameter", "displayName": "Cache Connections", "group": "common", "label": "common", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "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." }, |
| "contentSubType": { "kind": "parameter", "displayName": "Content Sub Type", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "plain", "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Setting for contentSubType can be set to any valid MimeSubType." }, |
| "contentType": { "kind": "parameter", "displayName": "Content Type", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "text", "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Setting for contentType can be set to any valid MimeType." }, |
| "eventHeaderName": { "kind": "parameter", "displayName": "Event Header Name", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Setting for a String based event type." }, |
| "eventId": { "kind": "parameter", "displayName": "Event Id", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified" }, |
| "fromHost": { "kind": "parameter", "displayName": "From Host", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified" }, |
| "fromPort": { "kind": "parameter", "displayName": "From Port", "group": "common", "label": "common", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Port of the message originator. Mandatory setting unless a registry based FromHeader is specified" }, |
| "fromUser": { "kind": "parameter", "displayName": "From User", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified." }, |
| "msgExpiration": { "kind": "parameter", "displayName": "Msg Expiration", "group": "common", "label": "common", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 3600, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "The amount of time a message received at an endpoint is considered valid" }, |
| "receiveTimeoutMillis": { "kind": "parameter", "displayName": "Receive Timeout Millis", "group": "common", "label": "common", "required": false, "type": "duration", "javaType": "long", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "10000", "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Setting for specifying amount of time to wait for a Response and\/or Acknowledgement can be received from another SIP stack" }, |
| "stackName": { "kind": "parameter", "displayName": "Stack Name", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "NAME_NOT_SET", "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Name of the SIP Stack instance associated with an SIP Endpoint." }, |
| "toHost": { "kind": "parameter", "displayName": "To Host", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified" }, |
| "toPort": { "kind": "parameter", "displayName": "To Port", "group": "common", "label": "common", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified" }, |
| "toUser": { "kind": "parameter", "displayName": "To User", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified." }, |
| "transport": { "kind": "parameter", "displayName": "Transport", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "tcp", "udp" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "tcp", "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Setting for choice of transport protocol. Valid choices are tcp or udp." }, |
| "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." }, |
| "consumer": { "kind": "parameter", "displayName": "Consumer", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "This setting is used to determine whether the kind of header (FromHeader,ToHeader etc) that needs to be created for this endpoint" }, |
| "presenceAgent": { "kind": "parameter", "displayName": "Presence Agent", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "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." }, |
| "exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "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." }, |
| "exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, |
| "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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." }, |
| "addressFactory": { "kind": "parameter", "displayName": "Address Factory", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.address.AddressFactory", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "To use a custom AddressFactory" }, |
| "callIdHeader": { "kind": "parameter", "displayName": "Call Id Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.CallIdHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader" }, |
| "contactHeader": { "kind": "parameter", "displayName": "Contact Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.ContactHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "An optional custom Header object containing verbose contact details (email, phone number etc). Must implement the type javax.sip.header.ContactHeader" }, |
| "contentTypeHeader": { "kind": "parameter", "displayName": "Content Type Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.ContentTypeHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader" }, |
| "eventHeader": { "kind": "parameter", "displayName": "Event Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.EventHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader" }, |
| "expiresHeader": { "kind": "parameter", "displayName": "Expires Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.ExpiresHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader" }, |
| "extensionHeader": { "kind": "parameter", "displayName": "Extension Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.ExtensionHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "A custom Header object containing user\/application specific details. Must implement the type javax.sip.header.ExtensionHeader" }, |
| "fromHeader": { "kind": "parameter", "displayName": "From Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.FromHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader" }, |
| "headerFactory": { "kind": "parameter", "displayName": "Header Factory", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.HeaderFactory", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "To use a custom HeaderFactory" }, |
| "listeningPoint": { "kind": "parameter", "displayName": "Listening Point", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.ListeningPoint", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "To use a custom ListeningPoint implementation" }, |
| "maxForwardsHeader": { "kind": "parameter", "displayName": "Max Forwards Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.MaxForwardsHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "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" }, |
| "maxMessageSize": { "kind": "parameter", "displayName": "Max Message Size", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 1048576, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Setting for maximum allowed Message size in bytes." }, |
| "messageFactory": { "kind": "parameter", "displayName": "Message Factory", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.message.MessageFactory", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "To use a custom MessageFactory" }, |
| "sipFactory": { "kind": "parameter", "displayName": "Sip Factory", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.SipFactory", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "To use a custom SipFactory to create the SipStack to be used" }, |
| "sipStack": { "kind": "parameter", "displayName": "Sip Stack", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.SipStack", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "To use a custom SipStack" }, |
| "sipUri": { "kind": "parameter", "displayName": "Sip Uri", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.address.SipURI", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "To use a custom SipURI. If none configured, then the SipUri fallback to use the options toUser toHost:toPort" }, |
| "toHeader": { "kind": "parameter", "displayName": "To Header", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "javax.sip.header.ToHeader", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader" }, |
| "viaHeaders": { "kind": "parameter", "displayName": "Via Headers", "group": "advanced", "label": "advanced", "required": false, "type": "array", "javaType": "java.util.List<javax.sip.header.ViaHeader>", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "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)" }, |
| "implementationDebugLogFile": { "kind": "parameter", "displayName": "Implementation Debug Log File", "group": "logging", "label": "logging", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Name of client debug log file to use for logging" }, |
| "implementationServerLogFile": { "kind": "parameter", "displayName": "Implementation Server Log File", "group": "logging", "label": "logging", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Name of server log file to use for logging" }, |
| "implementationTraceLevel": { "kind": "parameter", "displayName": "Implementation Trace Level", "group": "logging", "label": "logging", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "0", "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Logging level for tracing" }, |
| "maxForwards": { "kind": "parameter", "displayName": "Max Forwards", "group": "proxy", "label": "proxy", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "Number of maximum proxy forwards" }, |
| "useRouterForAllUris": { "kind": "parameter", "displayName": "Use Router For All Uris", "group": "proxy", "label": "proxy", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.sip.SipConfiguration", "configurationField": "configuration", "description": "This setting is used when requests are sent to the Presence Agent via a proxy." } |
| } |
| } |
