blob: 5c6b45ca97e8a0791424fd102ddf23242e23adda [file] [log] [blame]
{"component":{"kind":"component","name":"cmis","title":"CMIS","description":"Read and write data from to/from a CMIS compliant content repositories.","deprecated":false,"firstVersion":"2.11.0","label":"cms,database","javaType":"org.apache.camel.component.cmis.CMISComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-cmis","version":"3.18.1","scheme":"cmis","extendsScheme":"","syntax":"cmis:cmsUrl","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"cmis:action":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.apache.camel.component.cmis.CamelCMISActions","enum":["CREATE","DELETE_DOCUMENT","DELETE_FOLDER","MOVE_DOCUMENT","MOVE_FOLDER","COPY_DOCUMENT","COPY_FOLDER","RENAME","CHECK_IN","CHECK_OUT","CANCEL_CHECK_OUT","GET_FOLDER","LIST_FOLDER","FIND_OBJECT_BY_ID","FIND_OBJECT_BY_PATH","CREATE_FOLDER_BY_PATH","DOWNLOAD_DOCUMENT"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to perform","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CMIS_ACTION"},"cmis:path":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If CamelCMISFolderPath is not set, will try to find out the path of the node from this cmis property and it is name","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#PATH"},"cmis:name":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"If CamelCMISFolderPath is not set, will try to find out the path of the node from this cmis property and it is path","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#NAME"},"cmis:objectTypeId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the node","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#OBJECT_TYPE_ID"},"cmis:checkinComment":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The check-in comment for the document version","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CHECKIN_COMMENT"},"cmis:contentStreamMimeType":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The mimetype to set for a document","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CONTENT_STREAM_MIME_TYPE"},"CamelCMISFolderPath":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"/","description":"The current folder to use during the execution. If not specified will use the root folder","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CMIS_FOLDER_PATH"},"CamelCMISObjectId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the object","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CMIS_OBJECT_ID"},"CamelCMISDestinationFolderId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the destination folder","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CMIS_DESTIONATION_FOLDER_ID"},"CamelCMISSourceFolderId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the source folder","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CMIS_SOURCE_FOLDER_ID"},"CamelCMISResultCount":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Number of nodes returned from the query","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CAMEL_CMIS_RESULT_COUNT"},"CamelCMISRetrieveContent":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"In queryMode this header will force the producer to retrieve the content of document nodes.","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CAMEL_CMIS_RETRIEVE_CONTENT"},"CamelCMISReadSize":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Max number of nodes to read.","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#CAMEL_CMIS_READ_SIZE"},"CamelCMISAllVersions":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Apply only to this version (false) or all versions (true)","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#ALL_VERSIONS"},"cmis:versioningState":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The versioning state","constantName":"org.apache.camel.component.cmis.CamelCMISConstants#VERSIONING_STATE"}},"properties":{"cmsUrl":{"kind":"path","displayName":"Cms Url","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"URL to the cmis repository"},"pageSize":{"kind":"parameter","displayName":"Page Size","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":100,"configurationClass":"org.apache.camel.component.cmis.CMISSessionFacade","configurationField":"sessionFacade","description":"Number of nodes to retrieve per page"},"readContent":{"kind":"parameter","displayName":"Read Content","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.cmis.CMISSessionFacade","configurationField":"sessionFacade","description":"If set to true, the content of document node will be retrieved in addition to the properties"},"readCount":{"kind":"parameter","displayName":"Read Count","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cmis.CMISSessionFacade","configurationField":"sessionFacade","description":"Max number of nodes to read"},"repositoryId":{"kind":"parameter","displayName":"Repository Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cmis.CMISSessionFacade","configurationField":"sessionFacade","description":"The Id of the repository to use. If not specified the first available repository is used"},"query":{"kind":"parameter","displayName":"Query","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.cmis.CMISSessionFacade","configurationField":"sessionFacade","description":"The cmis query to execute against the repository. If not specified, the consumer will retrieve every node from the content repository by iterating the content tree recursively"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","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."},"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."},"queryMode":{"kind":"parameter","displayName":"Query Mode","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"If true, will execute the cmis query from the message body and return result, otherwise will create a node in the cmis repository"},"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."},"sessionFacadeFactory":{"kind":"parameter","displayName":"Session Facade Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"org.apache.camel.component.cmis.CMISSessionFacadeFactory","deprecated":false,"autowired":false,"secret":false,"description":"To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances"},"password":{"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.cmis.CMISSessionFacade","configurationField":"sessionFacade","description":"Password for the cmis repository"},"username":{"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.cmis.CMISSessionFacade","configurationField":"sessionFacade","description":"Username for the cmis repository"}}}