blob: 0bc25137d96c5ebf428f4c2339cb6aa5bcc62c93 [file] [log] [blame]
{"component":{"kind":"component","name":"milo-browse","title":"OPC UA Browser","description":"Connect to OPC UA servers using the binary protocol for browsing the node tree.","deprecated":false,"firstVersion":"3.15.0","label":"iot","javaType":"org.apache.camel.component.milo.browse.MiloBrowseComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-milo","version":"3.18.1","scheme":"milo-browse","extendsScheme":"","syntax":"milo-browse:endpointUri","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelMiloNodeIds":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The node ids.","constantName":"org.apache.camel.component.milo.MiloConstants#HEADER_NODE_IDS"}},"properties":{"endpointUri":{"kind":"path","displayName":"Endpoint Uri","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The OPC UA server endpoint"},"clientId":{"kind":"parameter","displayName":"Client Id","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"A virtual client id to force the creation of a new connection instance"},"depth":{"kind":"parameter","displayName":"Depth","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":3,"description":"When browsing recursively into sub-types, what's the maximum search depth for diving into the tree. Default value notice: Maximum depth for browsing recursively (only if recursive = true)"},"direction":{"kind":"parameter","displayName":"Direction","group":"producer","label":"","required":false,"type":"object","javaType":"org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection","enum":["Forward","Inverse","Both"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"Forward","description":"The direction to browse (forward, inverse, ...). Default value notice: The direction to browse; see org.eclipse.milo.opcua.stack.core.types.enumerated.BrowseDirection"},"discoveryEndpointSuffix":{"kind":"parameter","displayName":"Discovery Endpoint Suffix","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"A suffix for endpoint URI when discovering"},"discoveryEndpointUri":{"kind":"parameter","displayName":"Discovery Endpoint Uri","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"An alternative discovery URI"},"filter":{"kind":"parameter","displayName":"Filter","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"None","description":"Filter out node ids to limit browsing. Default value notice: Regular filter expression matching node ids"},"includeSubTypes":{"kind":"parameter","displayName":"Include Sub Types","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Whether to include sub-types for browsing; only applicable for non-recursive browsing"},"maxNodeIdsPerRequest":{"kind":"parameter","displayName":"Max Node Ids Per Request","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"description":"The maximum number node ids requested per server call. Default value notice: Maximum number of node ids requested per browse call (applies to browsing sub-types only; only if recursive = true)"},"node":{"kind":"parameter","displayName":"Node","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"ns=0;id=84","description":"The node definition (see Node ID). Default value notice: Root folder as per OPC-UA spec"},"nodeClasses":{"kind":"parameter","displayName":"Node Classes","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Variable,Object,DataType","description":"The mask indicating the node classes of interest in browsing. Default value notice: Comma-separated node class list; see org.eclipse.milo.opcua.stack.core.types.enumerated.NodeClass"},"recursive":{"kind":"parameter","displayName":"Recursive","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether to browse recursively into sub-types, ignores includeSubTypes setting as it's implied to be set to true. Default value notice: Whether to recursively browse sub-types: truefalse"},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","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."},"allowedSecurityPolicies":{"kind":"parameter","displayName":"Allowed Security Policies","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"A set of allowed security policy URIs. Default is to accept all and use the highest."},"applicationName":{"kind":"parameter","displayName":"Application Name","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"Apache Camel adapter for Eclipse Milo","configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The application name"},"applicationUri":{"kind":"parameter","displayName":"Application Uri","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://camel.apache.org/EclipseMilo/Client","configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The application URI"},"channelLifetime":{"kind":"parameter","displayName":"Channel Lifetime","group":"client","label":"client","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"Channel lifetime in milliseconds"},"keyAlias":{"kind":"parameter","displayName":"Key Alias","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The name of the key in the keystore file"},"keyPassword":{"kind":"parameter","displayName":"Key Password","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The key password"},"keyStorePassword":{"kind":"parameter","displayName":"Key Store Password","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The keystore password"},"keyStoreType":{"kind":"parameter","displayName":"Key Store Type","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The key store type"},"keyStoreUrl":{"kind":"parameter","displayName":"Key Store Url","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The URL where the key should be loaded from"},"maxPendingPublishRequests":{"kind":"parameter","displayName":"Max Pending Publish Requests","group":"client","label":"client","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The maximum number of pending publish requests"},"maxResponseMessageSize":{"kind":"parameter","displayName":"Max Response Message Size","group":"client","label":"client","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The maximum number of bytes a response message may have"},"overrideHost":{"kind":"parameter","displayName":"Override Host","group":"client","label":"client","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"Override the server reported endpoint host with the host from the endpoint URI."},"productUri":{"kind":"parameter","displayName":"Product Uri","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"http://camel.apache.org/EclipseMilo","configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The product URI"},"requestedPublishingInterval":{"kind":"parameter","displayName":"Requested Publishing Interval","group":"client","label":"client","required":false,"type":"number","javaType":"java.lang.Double","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1_000.0","configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"The requested publishing interval in milliseconds"},"requestTimeout":{"kind":"parameter","displayName":"Request Timeout","group":"client","label":"client","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"Request timeout in milliseconds"},"sessionName":{"kind":"parameter","displayName":"Session Name","group":"client","label":"client","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"Session name"},"sessionTimeout":{"kind":"parameter","displayName":"Session Timeout","group":"client","label":"client","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.milo.client.MiloClientConfiguration","configurationField":"configuration","description":"Session timeout in milliseconds"}}}