The printer component is used for sending messages to printers as print jobs. Obviously the payload has to be a formatted piece of payload in order for the component to appropriately print it. The objective is to be able to direct specific payloads as jobs to a line printer in a camel flow. The functionality allows for the payload to be printed on a default printer, named local, remote or wirelessly linked printer using the javax printing API under the covers.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| hostname | path | producer | true | java.lang.String | Hostname of the printer | ||
| port | path | producer | int | Port number of the printer | |||
| printername | path | producer | java.lang.String | Name of the printer | |||
| bridgeErrorHandler | parameter | consumer | boolean | 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/ERROR level and ignored. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| copies | parameter | producer | 1 | int | Number of copies to print | ||
| docFlavor | parameter | producer | javax.print.DocFlavor | Sets DocFlavor to use. | |||
| flavor | parameter | producer | java.lang.String | Sets DocFlavor to use. | |||
| mediaSize | parameter | producer | na-letter | java.lang.String | 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 | parameter | producer | java.lang.String | Sets MediaTray supported by the javax.print.DocFlavor API, for example upper,middle etc. | |||
| mimeType | parameter | producer | java.lang.String | Sets mimeTypes supported by the javax.print.DocFlavor API | |||
| orientation | parameter | producer | portrait | java.lang.String | portrait landscape reverse-portrait reverse-landscape |
Sets the page orientation. | |
| printerPrefix | parameter | producer | java.lang.String | Sets the prefix name of the printer, it is useful when the printer name does not start with //hostname/printer | |||
| sendToPrinter | parameter | producer | true | boolean | etting this option to false prevents sending of the print data to the printer | ||
| sides | parameter | producer | one-sided | java.lang.String | one-sided duplex tumble two-sided-short-edge two-sided-long-edge |
Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API | |
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |