com.zebra.sdk.device

Interface FileUtilLinkOs

All Known Subinterfaces:

ZebraPrinterLinkOs

All Known Implementing Classes:

Profile

public interface FileUtilLinkOs

Utility class for performing file operations on a Zebra Link-OS™ printer.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteFile(String filePath) Deletes the file from the printer.
void	getObjectFromPrinter(java.io.OutputStream destinationStream, String filePath) Retrieves a file from the printer's file system and writes the contents of that file to destinationStream.
byte[]	getObjectFromPrinter(String filePath) Retrieves a file from the printer's file system and returns the contents of that file as a byte array.
void	getObjectFromPrinterViaFtp(java.io.OutputStream destinationStream, String filePath, String ftpPassword) Retrieves a file from the printer's file system via FTP and writes the contents of that file to destinationStream.
byte[]	getObjectFromPrinterViaFtp(String filePath, String ftpPassword) Retrieves a file from the printer's file system via FTP and returns the contents of that file as a byte array.
byte[]	getPrinterDownloadableObjectFromPrinter(String filePath) Retrieves a file from the printer's file system and returns the contents of that file as a byte array including all necessary file wrappers for redownloading to a Zebra printer.
java.util.List<StorageInfo>	getStorageInfo() Retrieves storage information for all of the printer's available drives.
void	storeFileOnPrinter(byte[] fileContents, String fileNameOnPrinter) Stores a file on the printer named fileNameOnPrinter with the file contents from fileContents using any required file wrappers.
void	storeFileOnPrinter(String filePath) Stores the file on the printer using any required file wrappers.
void	storeFileOnPrinter(String filePath, String fileNameOnPrinter) Stores the file on the printer at the specified location and name using any required file wrappers.

Method Detail

getStorageInfo

java.util.List<StorageInfo> getStorageInfo()
                                           throws ConnectionException

Retrieves storage information for all of the printer's available drives.

Returns:

A list of objects detailing information about the printer's available drives.

Throws:

ConnectionException - if there is an error connecting to the device.

See Also:

StorageInfo class for more information.

storeFileOnPrinter

void storeFileOnPrinter(String filePath)
                        throws ConnectionException,
                               java.io.IOException,
                               ZebraIllegalArgumentException

Stores the file on the printer using any required file wrappers.
Note: If the contents of filePath contains any commands which need to be processed by the printer, use FileUtil.sendFileContents(String) instead. These commands include download commands and any immediate commands (~CC, ~CD, ~DB, ~DE, ~DG, ~DY, ~EG, ~HI, ~HU, ~HM, ~HQ, ~HS, ~JA, ~JB, ~JC, ~JD, ~JE, ~JF, ~JG, ~JI, ~JL, ~JN, ~JO, ~JP, ~JQ, ~JR, ~JS, ~JX, ~NC, ~NT, ~PL, ~PP, ~PR, ~PS, ~RO, ~SD, ~TA, ~WC, ~WQ, ^DF)

Parameters:

filePath - the full file path (e.g. "C:\\Users\\%USERNAME%\\Documents\\sample.zpl").

Throws:

ConnectionException - if there is an error connecting to the device.

java.io.IOException - if there is an issue reading the file

ZebraIllegalArgumentException - if filePath cannot be used to create a printer file name.

storeFileOnPrinter

void storeFileOnPrinter(String filePath,
                      String fileNameOnPrinter)
                        throws ConnectionException,
                               java.io.IOException,
                               ZebraIllegalArgumentException

Stores the file on the printer at the specified location and name using any required file wrappers.
Note: If the contents of filePath contains any commands which need to be processed by the printer, use FileUtil.sendFileContents(String) instead. These commands include download commands and any immediate commands (~CC, ~CD, ~DB, ~DE, ~DG, ~DY, ~EG, ~HI, ~HU, ~HM, ~HQ, ~HS, ~JA, ~JB, ~JC, ~JD, ~JE, ~JF, ~JG, ~JI, ~JL, ~JN, ~JO, ~JP, ~JQ, ~JR, ~JS, ~JX, ~NC, ~NT, ~PL, ~PP, ~PR, ~PS, ~RO, ~SD, ~TA, ~WC, ~WQ, ^DF)

Parameters:

filePath - the full file path (e.g. "C:\\Users\\%USERNAME%\\Documents\\sample.zpl").

fileNameOnPrinter - the full name of the file on the printer (e.g "R:SAMPLE.ZPL").

Throws:

ConnectionException - if there is an error connecting to the device.

java.io.IOException - if there is an issue reading the file

ZebraIllegalArgumentException - if fileNameOnPrinter is not a legal printer file name.

storeFileOnPrinter

void storeFileOnPrinter(byte[] fileContents,
                      String fileNameOnPrinter)
                        throws ConnectionException,
                               ZebraIllegalArgumentException

Stores a file on the printer named fileNameOnPrinter with the file contents from fileContents using any required file wrappers.
Note: If the fileContents contains any commands which need to be processed by the printer, use FileUtil.sendFileContents(String) instead. These commands include download commands and any immediate commands (~CC, ~CD, ~DB, ~DE, ~DG, ~DY, ~EG, ~HI, ~HU, ~HM, ~HQ, ~HS, ~JA, ~JB, ~JC, ~JD, ~JE, ~JF, ~JG, ~JI, ~JL, ~JN, ~JO, ~JP, ~JQ, ~JR, ~JS, ~JX, ~NC, ~NT, ~PL, ~PP, ~PR, ~PS, ~RO, ~SD, ~TA, ~WC, ~WQ, ^DF)

Parameters:

fileContents - The contents of the file to store.

fileNameOnPrinter - the full name of the file on the printer (e.g "R:SAMPLE.ZPL").

Throws:

ConnectionException - if there is an error connecting to the device.

ZebraIllegalArgumentException - if fileNameOnPrinter is not a legal printer file name.

deleteFile

void deleteFile(String filePath)
                throws ConnectionException

Deletes the file from the printer. The filePath may also contain wildcards.

Parameters:

filePath - the location of the file on the printer. Wildcards are also accepted (e.g. "E:FORMAT.ZPL", "E:*.*")

Throws:

ConnectionException - if there is an error connecting to the device.

getObjectFromPrinter

byte[] getObjectFromPrinter(String filePath)
                            throws ConnectionException,
                                   ZebraIllegalArgumentException

Retrieves a file from the printer's file system and returns the contents of that file as a byte array. Will retrieve the following file extensions: ZPL, GRF, DAT, BAS, FMT, PNG, LBL, PCX, BMP, WML, CSV, HTM, TXT.

Files transferred between different printer models may not be compatible.

Parameters:

filePath - absolute file path on the printer ("E:SAMPLE.TXT").

Returns:

The file contents

Throws:

ConnectionException - if there is an issue communicating with the device (e.g. the connection is not open).

ZebraIllegalArgumentException - if the filePath is invalid, or if the file does not exist on the printer.

getObjectFromPrinter

void getObjectFromPrinter(java.io.OutputStream destinationStream,
                        String filePath)
                          throws ConnectionException,
                                 ZebraIllegalArgumentException

Retrieves a file from the printer's file system and writes the contents of that file to destinationStream. Will retrieve the following file extensions: ZPL, GRF, DAT, BAS, FMT, PNG, LBL, PCX, BMP, WML, CSV, HTM, TXT.

Files transferred between different printer models may not be compatible.

Parameters:

destinationStream - output stream to receive the file contents

filePath - absolute file path on the printer ("E:SAMPLE.TXT").

Throws:

ConnectionException - if there is an issue communicating with the device (e.g. the connection is not open).

ZebraIllegalArgumentException - if the filePath is invalid, or if the file does not exist on the printer.

getObjectFromPrinterViaFtp

byte[] getObjectFromPrinterViaFtp(String filePath,
                                String ftpPassword)
                                  throws ConnectionException,
                                         ZebraIllegalArgumentException

Retrieves a file from the printer's file system via FTP and returns the contents of that file as a byte array. Will retrieve the following file extensions: ZPL, GRF, DAT, BAS, FMT, PNG, LBL, PCX, BMP, WML, CSV, HTM, TXT.

Files transferred between different printer models may not be compatible.
NOTE: This method retrieves files over a network protocol and hence will only work over a TCP connected printer with FTP enabled. If ftpPassword is not provided, a default will be tried.

Parameters:

filePath - absolute file path on the printer ("E:SAMPLE.TXT")

ftpPassword - password used to login to FTP, if null, a default password ("1234") will be used.

Returns:

The file contents.

Throws:

ConnectionException - if there is an error communicating with the printer, or the ftpPassword is invalid

ZebraIllegalArgumentException - if the filePath is invalid, or if the file does not exist on the printer.

getObjectFromPrinterViaFtp

void getObjectFromPrinterViaFtp(java.io.OutputStream destinationStream,
                              String filePath,
                              String ftpPassword)
                                throws ConnectionException,
                                       ZebraIllegalArgumentException

Retrieves a file from the printer's file system via FTP and writes the contents of that file to destinationStream. Will retrieve the following file extensions: ZPL, GRF, DAT, BAS, FMT, PNG, LBL, PCX, BMP, WML, CSV, HTM, TXT.

Files transferred between different printer models may not be compatible.
NOTE: This method retrieves files over a network protocol and hence will only work over a TCP connected printer with FTP enabled. If ftpPassword is not provided, a default will be tried.

Parameters:

destinationStream - output stream to receive the file contents

filePath - absolute file path on the printer ("E:SAMPLE.TXT")

ftpPassword - password used to login to FTP, if null, a default password ("1234") will be used.

Throws:

ConnectionException - if there is an error communicating with the printer, or the ftpPassword is invalid

ZebraIllegalArgumentException - if the filePath is invalid, or if the file does not exist on the printer.

getPrinterDownloadableObjectFromPrinter

byte[] getPrinterDownloadableObjectFromPrinter(String filePath)
                                               throws ConnectionException,
                                                      ZebraIllegalArgumentException

Retrieves a file from the printer's file system and returns the contents of that file as a byte array including all necessary file wrappers for redownloading to a Zebra printer. Will retrieve the following file extensions: ZPL, GRF, DAT, BAS, FMT, PNG, LBL, PCX, BMP, WML, CSV, HTM, TXT
Files transferred between different printer models may not be compatible.

Parameters:

filePath - absolute file path on the printer ("E:SAMPLE.TXT")

Returns:

A Zebra printer downloadable file content.

Throws:

ConnectionException - if there is an issue communicating with the device (e.g. the connection is not open).

ZebraIllegalArgumentException - if the filePath is invalid, or if the file does not exist on the printer.