| Package | Description |
|---|---|
| com.zebra.sdk.comm |
Provides implementation for communication protocols.
|
| com.zebra.sdk.common.card.device |
Provides interfaces for implementing card devices.
|
| com.zebra.sdk.common.card.graphics |
Provides interfaces for card printer graphics utilities.
|
| com.zebra.sdk.common.card.job |
Provides interfaces for card print job related functions.
|
| com.zebra.sdk.common.card.job.template |
Utility package to support template printing within Zebra card printers
|
| com.zebra.sdk.common.card.printer |
Provides interfaces for card printer related functions.
|
| com.zebra.sdk.common.card.template |
Utility package to support template printing within Zebra card printers
|
| com.zebra.sdk.printer.discovery |
Provides implementation for finding Zebra branded printers.
|
| com.zebra.sdk.zmotif.device |
Provides ZMotif card printer objects.
|
| com.zebra.sdk.zmotif.job |
Provides container for ZMotif card printer job related functions.
|
| com.zebra.sdk.zmotif.settings |
Provides container for accessing ZMotif card printer settings.
|
| com.zebra.sdk.zxp.settings |
Provides container for ZXP settings access
|
| Modifier and Type | Class and Description |
|---|---|
class |
LogStreamException
Signals that an error has occurred while writing to the connections log stream.
|
| Modifier and Type | Method and Description |
|---|---|
static Connection |
ConnectionBuilder.build(String descriptionString)
Creates a Connection type based on the contents of
descriptionString. |
int |
Connection.bytesAvailable()
Returns an estimate of the number of bytes that can be read from this connection without blocking.
|
int |
ConnectionA.bytesAvailable() |
int |
UsbConnection.bytesAvailable()
Returns number of bytes currently read from printer.
|
void |
Connection.close()
Closes this connection and releases any system resources associated with the connection.
|
void |
ConnectionA.close() |
void |
UsbConnection.close() |
com.zebra.sdk.comm.ConnectionReestablisher |
Connection.getConnectionReestablisher(long thresholdTime)
Returns a
ConnectionReestablisher which allows for easy recreation of a connection which may have
been closed. |
com.zebra.sdk.comm.ConnectionReestablisher |
ConnectionA.getConnectionReestablisher(long thresholdTime) |
com.zebra.sdk.comm.ConnectionReestablisher |
TcpConnection.getConnectionReestablisher(long thresholdTime) |
com.zebra.sdk.comm.ConnectionReestablisher |
UsbConnection.getConnectionReestablisher(long thresholdTime) |
void |
Connection.open()
Opens the connection to a device.
|
void |
ConnectionA.open() |
void |
UsbConnection.open() |
byte[] |
Connection.read()
Reads all the available data from the connection.
|
byte[] |
ConnectionA.read() |
byte[] |
ConnectionA.read(int maxBytesToRead)
Reads
maxBytesToRead of the available data from the connection. |
byte[] |
UsbConnection.read(int maxBytesToRead)
Reads up to maxBytesToRead into byte array
Performing reads using DriverPrinterConnection and UsbConnection concurrently could cause indeterminate reads |
byte[] |
ConnectionA.read(int maxBytesToRead,
boolean exitOnFirstRead)
Reads
maxBytesToRead of the available data from the connection. |
void |
Connection.read(java.io.OutputStream destinationStream)
Reads all the available data from the connection.
|
void |
ConnectionA.read(java.io.OutputStream destinationStream) |
int |
Connection.readChar()
Reads the next byte of data from the connection, similar to a Java InputStream.
|
int |
ConnectionA.readChar() |
int |
UsbConnection.readChar() |
void |
CardConnectionReestablisher.reestablishConnection(CardPrinterReconnectionHandler handler)
Reestablishes a connection to a printer which may have been closed due to an event, like a reboot.
|
byte[] |
Connection.sendAndWaitForResponse(byte[] dataToSend,
int initialResponseTimeout,
int responseCompletionTimeout,
String terminator)
Sends
dataToSend and returns the response data. |
byte[] |
ConnectionA.sendAndWaitForResponse(byte[] dataToSend,
int initialResponseTimeout,
int responseCompletionTimeout,
String terminator) |
void |
Connection.sendAndWaitForResponse(java.io.OutputStream destinationStream,
java.io.InputStream sourceStream,
int initialResponseTimeout,
int responseCompletionTimeout,
String terminator)
Sends data from
sourceStream and writes the response data to destinationStream. |
void |
ConnectionA.sendAndWaitForResponse(java.io.OutputStream destinationStream,
java.io.InputStream sourceStream,
int initialResponseTimeout,
int responseCompletionTimeout,
String terminator) |
byte[] |
Connection.sendAndWaitForValidResponse(byte[] dataToSend,
int initialResponseTimeout,
int responseCompletionTimeout,
ResponseValidator validator)
Sends
dataToSend and returns the response data. |
byte[] |
ConnectionA.sendAndWaitForValidResponse(byte[] dataToSend,
int initialResponseTimeout,
int responseCompletionTimeout,
ResponseValidator validator) |
void |
Connection.sendAndWaitForValidResponse(java.io.OutputStream destinationStream,
java.io.InputStream sourceStream,
int initialResponseTimeout,
int responseCompletionTimeout,
ResponseValidator validator)
Sends data from
sourceStream and writes the response data to destinationStream. |
void |
ConnectionA.sendAndWaitForValidResponse(java.io.OutputStream destinationStream,
java.io.InputStream sourceStream,
int initialResponseTimeout,
int responseCompletionTimeout,
ResponseValidator validator) |
void |
ConnectionA.setReadTimeout(int timeout)
Sets the underlying socket read timeout value
|
void |
Connection.waitForData(int maxTimeout)
Causes the currently executing thread to sleep until
Connection.bytesAvailable() > 0, or for a maximum of
maxTimeout milliseconds. |
void |
ConnectionA.waitForData(int maxTimeout) |
void |
Connection.write(byte[] data)
Writes
data.length bytes from the specified byte array to this output stream. |
void |
ConnectionA.write(byte[] data) |
void |
UsbConnection.write(byte[] data) |
void |
Connection.write(byte[] data,
int offset,
int length)
Writes
length bytes from data starting at offset. |
void |
ConnectionA.write(byte[] data,
int offset,
int length) |
void |
UsbConnection.write(byte[] data,
int offset,
int length) |
void |
Connection.write(java.io.InputStream dataSource)
Writes all available bytes from the data source to this output stream.
|
void |
ConnectionA.write(java.io.InputStream dataSource) |
| Constructor and Description |
|---|
UsbConnection(String symbolicName)
Initializes a new instance of the
UsbConnection class. |
UsbConnection(String symbolicName,
int maxTimeoutForRead,
int timeToWaitForMoreData)
Initializes a new instance of the
UsbConnection class. |
| Modifier and Type | Method and Description |
|---|---|
AlarmInfo |
DeviceUtil.checkForAlarm()
Gets the printer's current alarm code.
|
void |
DeviceUtil.clearOCPDisplay(boolean lockOCP)
Clears any custom line data from the OCP and returns it to the main view.
ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only. |
CardCountInfo |
DeviceUtil.getCardCount()
Returns the printer's total card count values.
|
MagneticEncoderInfo |
DeviceUtil.getMagneticEncoderConfiguration()
Returns the printer's magnetic encoder configuration.
|
java.util.List<MediaInfo> |
DeviceUtil.getMediaInformation()
Returns a List of the printer's installed media information.
|
OCPDisplayInfo |
DeviceUtil.getOCPDisplay()
Returns the line data currently displayed on the printer's OCP.
ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only. |
TransferType |
DeviceUtil.getPrintCapability()
Returns the transfer type of the printer.
|
PrinterInfo |
DeviceUtil.getPrinterInformation()
Returns the printer's specific device information.
|
PrinterStatusInfo |
DeviceUtil.getPrinterStatus()
Returns the printer's current status information.
|
java.util.Map<String,String> |
DeviceUtil.getSensorStates()
Returns the printer's sensor states.
|
java.util.Map<String,String> |
DeviceUtil.getSensorValues()
Returns the printer's sensor values.
|
SmartCardInfo |
DeviceUtil.getSmartCardConfiguration()
Deprecated.
|
java.util.Map<String,String> |
DeviceUtil.getSmartCardConfigurations()
Returns the printer's smart card configuration.
|
boolean |
DeviceUtil.hasLaminator()
Returns true if printer includes a laminator.
|
boolean |
DeviceUtil.hasMagneticEncoder()
Returns true if printer includes magnetic encoder
|
boolean |
DeviceUtil.hasSmartCardEncoder()
Returns true if printer includes a smart card encoder.
|
void |
DeviceUtil.reset()
Resets the printer.
|
void |
DeviceUtil.setOCPDisplay(OCPDisplayInfo ocpDisplay)
Displays the specified line data on the printer's OCP.
ZXP Series 1 and 3 and ZMotif series 7, 8, and 9 printers only. |
void |
DeviceUtil.updateFirmware(String firmwareFilePath)
Updates the printers firmware.
|
void |
DeviceUtil.updateFirmware(String firmwareFilePath,
CardFirmwareUpdateHandler handler)
Updates the printers firmware.
|
| Constructor and Description |
|---|
ZebraCardGraphics(ZebraCardPrinter genericPrinter)
Public Constructor to construct the ZebraCardGraphics object.
|
| Modifier and Type | Method and Description |
|---|---|
void |
JobUtil.cancel(int jobID)
Cancels all jobs or a specific job.
|
void |
JobUtil.ejectCard()
Sends the card to the eject bin.
|
java.util.List<JobStatus> |
JobUtil.getJobList()
Returns a list of all the current jobs in the printer's queue.
|
JobStatusInfo |
JobUtil.getJobStatus(int jobId)
Returns the job status for the specified
jobId. |
int |
JobUtil.magEncode(int copies,
String track1Data,
String track2Data,
String track3Data)
Encodes a magnetic card for the current job.
|
int |
JobUtil.positionCard()
Moves a card from the specified source to the specified destination.
|
int |
JobUtil.print(int copies,
java.util.List<GraphicsInfo> graphicsData)
Prints a card with the images provided.
|
int |
JobUtil.printAndMagEncode(int copies,
java.util.List<GraphicsInfo> graphicsData,
String track1Data,
String track2Data,
String track3Data)
Encodes the magnetic encoding data and prints a card with the images provided.
|
int |
JobUtil.printTemplate(int copies,
TemplateJob jobData)
Prints a card with the provided template.
|
MagTrackData |
JobUtil.readMagData(java.util.EnumSet<DataSource> tracksToRead)
Reads the data from a magnetically encoded card.
|
MagTrackData |
JobUtil.readMagData(java.util.EnumSet<DataSource> tracksToRead,
boolean isVerbose)
Reads the data from a magnetically encoded card.
|
void |
JobUtil.reprint(int copies)
Reprints the last rendered job.
|
void |
JobUtil.resume()
Resumes the processing of a held job such as a smart card encoding job.
|
int |
JobUtil.smartCardEncode(int copies)
Positions a card at the smartcard station, suspends the job to allow the card to be read or encoded, and waits for
JobUtil.resume() to be called before
completing the job. |
| Modifier and Type | Method and Description |
|---|---|
TemplateJob |
ZebraTemplate.generateTemplateDataJob(String templateData,
java.util.Map<String,String> fieldDataMap)
Returns an instance of TemplateJob containing the job specific data.
|
TemplateJob |
ZebraTemplate.generateTemplateJob(String templateName,
java.util.Map<String,String> fieldDataMap)
Returns an instance of TemplateJob containing the job specific data.
|
| Modifier and Type | Method and Description |
|---|---|
static ZebraPrinterZmotif |
ZebraCardPrinterFactory.createZmotifPrinter(ZebraCardPrinter printer)
Create a wrapper around a Zebra printer that provides access to ZebraPrinterZmotif object from ZebraCardPrinter.
|
static ZebraPrinterZxp |
ZebraCardPrinterFactory.createZxpPrinter(ZebraCardPrinter printer)
Create a wrapper around a Zebra printer that provides access to ZebraPrinterZxp object from ZebraCardPrinter.
|
static ZebraCardPrinter |
ZebraCardPrinterFactory.getInstance(Connection connection)
Factory method to create the correct ZebraCardPrinter concrete class based on the printer's type.
|
static ZebraPrinterZmotif |
ZebraCardPrinterFactory.getZmotifPrinter(Connection connection)
Create a wrapper around a Zebra printer that provides access to ZebraPrinterZmotif object from Connection.
|
static ZebraPrinterZxp |
ZebraCardPrinterFactory.getZxpPrinter(Connection connection)
Create a wrapper around a Zebra printer that provides access to ZebraPrinterZxp object from Connection.
|
void |
ZebraCardPrinter.setConnection(Connection newConnection)
Sets the printer connection
|
| Modifier and Type | Method and Description |
|---|---|
TemplateJob |
ZebraCardTemplate.generateTemplateDataJob(String templateData,
java.util.Map<String,String> fieldDataMap) |
TemplateJob |
ZebraCardTemplate.generateTemplateJob(String templateName,
java.util.Map<String,String> fieldDataMap) |
| Modifier and Type | Method and Description |
|---|---|
static DiscoveredPrinterDriver[] |
UsbDiscoverer.getZebraDriverPrinters()
Enumerate locally installed Zebra Designer Drivers.
|
static DiscoveredUsbPrinter[] |
UsbDiscoverer.getZebraUsbPrinters()
Enumerate all currently connected Zebra USB printers.
|
static DiscoveredUsbPrinter[] |
UsbDiscoverer.getZebraUsbPrinters(DiscoveredPrinterFilter discoveredPrinterFilter)
Enumerate currently connected Zebra USB printers that meet the specified DiscoveredPrinterFilter criteria.
|
| Constructor and Description |
|---|
DiscoveredUsbPrinter(String symbolicName)
Returns an instance of a
DiscoveredUsbPrinter built using the symbolicName returned by
UsbDiscoverer.getZebraUsbPrinters() |
| Modifier and Type | Method and Description |
|---|---|
void |
LaminatorUtilZmotif.calibrateLaminate()
Calibrates the Laminator.
|
AlarmInfo |
DeviceUtilZmotif.clearError()
Clears the printer error and returns the printer alarm information.
|
void |
DeviceUtilZmotif.clearRejectBinCounter()
Clears the printer's Reject Bin counter.
|
java.util.List<String> |
DeviceUtilZmotif.getAvailableCardTypes()
Queries the printer and returns the available card types.
|
MemoryInfo |
DeviceUtilZmotif.getAvailableMemory()
Queries the printer and returns the memory available for job storage.
|
CardTypeInfo |
DeviceUtilZmotif.getCardTypeInformation(String cardType)
Queries the printer and returns the card type information for specified card type.
|
LaminatorCardCountInfo |
LaminatorUtilZmotif.getLaminatorCardCount()
Queries the printer and returns the Laminator card count.
|
LaminatorInfo |
LaminatorUtilZmotif.getLaminatorInformation()
Queries the printer and returns Laminator information.
|
java.util.Map<String,String> |
LaminatorUtilZmotif.getLaminatorOdometerValues()
Returns the odometer names and values.
|
java.util.Map<String,String> |
LaminatorUtilZmotif.getLaminatorSensorStates()
Queries the printer and returns a Map of Laminator Sensor and their states.
|
java.util.Map<String,String> |
LaminatorUtilZmotif.getLaminatorSensorValues()
Returns Map of Laminator sensors and their values.
|
String |
LaminatorUtilZmotif.getLaminatorStatus()
Queries the printer and returns the Laminator Status.
|
String |
DeviceUtilZmotif.getLog(LogType logType,
boolean clearLog)
Queries the printer and returns the specified log.
|
java.util.Map<String,String> |
DeviceUtilZmotif.getWirelessRadioStatus()
Queries the printer and returns the Wireless Radio Status.
|
java.util.Map<String,String> |
DeviceUtilZmotif.getWirelessStatus()
Queries the printer and returns the Wireless Status.
|
boolean |
DeviceUtilZmotif.hasBarcodeReader()
Queries the printer's configuration and returns true if printer includes barcode reader.
|
boolean |
DeviceUtilZmotif.isEncryptionEnabled()
Returns whether encryption is enabled on the printer.
|
boolean |
DeviceUtilZmotif.isHostAuthenticationEnabled()
Returns whether host authentication mode is enabled.
|
void |
DeviceUtilZmotif.resetNetwork()
Sends the network reset command to the printer.
|
void |
LaminatorUtilZmotif.restoreLaminatorDefaultConfiguration()
Restores the Laminator to default configuration
|
void |
DeviceUtilZmotif.resumeFromStandby()
Resume from standby.
|
java.util.List<WirelessAccessPointInfo> |
DeviceUtilZmotif.scanWirelessAccessPoints(int scanIterations)
Gets the Access points discoverable by printer.
|
| Modifier and Type | Method and Description |
|---|---|
void |
JobUtilZmotif.abort(boolean reject)
Aborts a print job.
|
String |
JobControlHelperUtilZmotif.getCardType()
Returns the currently selected card type.
|
ReservationInfo |
JobUtilZmotif.getReservationStatus(int reservationToken)
Queries the printer and returns the current status of the printer from the supplied reservation token.
|
java.util.List<String> |
JobUtilZmotif.getTestPrintImageNames()
Queries the printer and returns a list of available test print image names.
ZC Series printers only. |
ReservationInfo |
JobUtilZmotif.isDeviceInSession()
Queries the printer and returns whether the printer is currently in session.
|
int |
JobUtilZmotif.printTestCard(byte imageNumber,
int copies,
boolean dualSided)
Prints the specified test image.
ZMotif series 7, 8, and 9 printers only. |
void |
JobUtilZmotif.printTestCard(String testPrintName)
Prints the specified test image.
ZC Series printers only. |
BarcodeReadInfo |
JobUtilZmotif.readBarcodeData()
Sends a job to the printer to scan and return the barcode data from a card.
|
void |
JobUtilZmotif.reject()
Rejects a card from the printer's home position.
|
void |
JobUtilZmotif.releaseDeviceReservation(int reservationToken)
Releases the reservation session associated with the reservationToken.
|
int |
JobUtilZmotif.reserveDevice(ReservationType type)
Requests a reservation to a shared printer.
|
void |
JobUtilZmotif.retrySmartCard(SmartCardType type)
Repositions a smart card that is already present at the encoder.
|
void |
JobControlHelperUtilZmotif.setCardType(String cardType)
Sets the card type to be used for the job.
|
void |
JobControlHelperUtilZmotif.setJobConfiguration(JobConfigInfo jobConfig)
Method for configuring the current print job.
|
void |
JobControlHelperUtilZmotif.setMagConfiguration(MagConfigInfo magConfig)
Method for configuring settings for a magnetic encoding job.
|
| Modifier and Type | Method and Description |
|---|---|
CalibrationTable |
SettingsHelperUtilZmotif.getActiveLUTTable()
Get the printer's Active LUT Table.
ZMotif series 7, 8, and 9 printers only. |
String |
SettingsHelperUtilZmotif.getCalibrationTableData(CalibrationTable table)
Get the printer's specified Calibration Table data.
ZMotif series 7, 8, and 9 printers only. |
java.util.Map<CalibrationTable,String> |
SettingsHelperUtilZmotif.getCalibrationTableNames()
Get the list of all the stored calibration tables from the printer.
ZMotif series 7, 8, and 9 printers only. |
String |
SettingsHelperUtilZmotif.getCapabilities(CapabilitiesType reportType)
Get the printer's specified Capabilities in an XML format.
|
ParameterInfo |
SettingsHelperUtilZmotif.getCleaningInterval(CleaningPath path)
Get specified Cleaning Path ParameterInfo object
|
ParameterInfo |
SettingsHelperUtilZmotif.getCleanWarningThreshold()
Get the printer's Cleaning Warning Threshold.
|
String |
SettingsHelperUtilZmotif.getConfiguration()
Get the XML configuration.
|
ParameterInfo |
SettingsHelperUtilZmotif.getContactlessSmartCardOffset(String encoderType)
Returns the offset value for the specified contactless smart card encoder type.
|
ErrorControlLevel |
SettingsHelperUtilZmotif.getErrorControlLevel()
Get the Error Control Level.
|
ParameterInfo |
SettingsHelperUtilZmotif.getHeadResistance()
Returns the ParameterInfo object.
|
TransferType |
SettingsHelperUtilZmotif.getImageTransferType()
Get the printer's Image Transfer Type.
|
ParameterInfo |
SettingsHelperUtilZmotif.getLaminatorOffset(LaminatorOffsetType type)
Get the printer's laminator offset value and range.
|
MagneticEncoderOffsetInfo |
SettingsHelperUtilZmotif.getMagneticEncoderOffsets()
Gets the Magnetic Encoder Offset Info object
|
OCPSettings |
SettingsHelperUtilZmotif.getOCPParameters()
Gets the printer's OCP configuration.
ZMotif series 7, 8, and 9 printers only. |
ParameterInfo |
SettingsHelperUtilZmotif.getPanelPowerLevel(PanelType panel)
Gets the specified panel Power Level.
|
ParameterInfo |
SettingsHelperUtilZmotif.getSmartCardOffset()
Gets the Smart Card Offset ParameterInfo object.
|
Timeout |
SettingsHelperUtilZmotif.getStandbyTimeout()
Get the printer's Standby Timeout.
|
ParameterInfo |
SettingsHelperUtilZmotif.getTransferTemperatureOffset(TransferTemperatureType type)
Get the transfer temperature offset for the specified transfer sensor.
For ZMotif Series re-transfer printers only. |
void |
SettingsHelperUtilZmotif.loadCalibrationTableData(String xmlCalibrationData)
Load the Calibration table data from an XML Calibration Data document.
ZMotif series 7, 8, and 9 printers only. |
void |
SettingsHelperUtilZmotif.setConfiguration(String xmlConfiguration)
Set specified values for settings with an XML form.
|
void |
SettingsHelperUtilZmotif.setContactlessSmartCardOffset(String encoderType,
int offset)
Sets the contactless smart card encoding position offset value.
|
void |
SettingsHelperUtilZmotif.setMagneticEncoderOffsets(MagneticEncoderOffsetInfo offsets)
Set Magnetic Encoder Offsets.
|
| Modifier and Type | Method and Description |
|---|---|
ATMMode |
SettingsHelperUtilZxp.getATMMode()
Returns the ATM card feed mode.
|
ParameterInfo |
SettingsHelperUtilZxp.getEndCardOffset()
Returns the printer's end of print value.
|
ParameterInfo |
SettingsHelperUtilZxp.getHeadResistance()
Returns the print head resistance value and valid range.
|
MagneticEncoderOffsetInfo |
SettingsHelperUtilZxp.getMagneticEncoderOffsets()
Returns the magnetic encoder offset values.
|
ParameterInfo |
SettingsHelperUtilZxp.getMonochromeBias()
Returns the monochrome bias value.
|
ParameterInfo |
SettingsHelperUtilZxp.getXOffset(CardSide side)
Returns the x-offset for the specified card side.
|
ParameterInfo |
SettingsHelperUtilZxp.getYOffset(CardSide side)
Returns the y-offset for the specified card side.
|
boolean |
SettingsHelperUtilZxp.isCardPrefeed()
Returns the card pre-feed enabled state.
|
© 2016 ZIH Corp. All Rights Reserved.