blob: a9627d3a20f27809a9103d8681fb69aac21462c1 [file] [log] [blame]
{"component":{"kind":"component","name":"lpr","title":"Printer","description":"Send print jobs to printers.","deprecated":false,"firstVersion":"2.1.0","label":"printing","javaType":"org.apache.camel.component.printer.PrinterComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-printer","version":"3.18.1","scheme":"lpr","extendsScheme":"","syntax":"lpr:hostname:port/printername","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"PrinterJobName":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the job","constantName":"org.apache.camel.component.printer.PrinterEndpoint#JOB_NAME"}},"properties":{"hostname":{"kind":"path","displayName":"Hostname","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Hostname of the printer"},"port":{"kind":"path","displayName":"Port","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Port number of the printer"},"printername":{"kind":"path","displayName":"Printername","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Name of the printer"},"copies":{"kind":"parameter","displayName":"Copies","group":"producer","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":1,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Number of copies to print"},"docFlavor":{"kind":"parameter","displayName":"Doc Flavor","group":"producer","label":"","required":false,"type":"object","javaType":"javax.print.DocFlavor","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets DocFlavor to use."},"flavor":{"kind":"parameter","displayName":"Flavor","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets DocFlavor to use."},"mediaSize":{"kind":"parameter","displayName":"Media Size","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"na-letter","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored, e.g. values of iso_a4 and ISO_A4 may be used."},"mediaTray":{"kind":"parameter","displayName":"Media Tray","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets MediaTray supported by the javax.print.DocFlavor API, for example upper,middle etc."},"mimeType":{"kind":"parameter","displayName":"Mime Type","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets mimeTypes supported by the javax.print.DocFlavor API"},"orientation":{"kind":"parameter","displayName":"Orientation","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["portrait","landscape","reverse-portrait","reverse-landscape"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"portrait","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the page orientation."},"printerPrefix":{"kind":"parameter","displayName":"Printer Prefix","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets the prefix name of the printer, it is useful when the printer name does not start with //hostname/printer"},"sendToPrinter":{"kind":"parameter","displayName":"Send To Printer","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"etting this option to false prevents sending of the print data to the printer"},"sides":{"kind":"parameter","displayName":"Sides","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","enum":["one-sided","duplex","tumble","two-sided-short-edge","two-sided-long-edge"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"one-sided","configurationClass":"org.apache.camel.component.printer.PrinterConfiguration","configurationField":"config","description":"Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API"},"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."}}}