com.zebra.sdk.common.card.printer.discovery

Class NetworkCardDiscoverer

Object

com.zebra.sdk.common.card.printer.discovery.NetworkCardDiscoverer

public class NetworkCardDiscoverer
extends Object

A class used to discover printers on an IP Network.

  
 package test.zebra.sdk.discovery.examples;
  
 import java.util.*;
  
 import com.zebra.sdk.common.card.printer.discovery.NetworkCardDiscoverer;
 import com.zebra.sdk.printer.discovery.*;
  
 public class NetworkCardDiscovererExample {
 
     public static void main(String[] args) {
         DiscoveryHandler discoveryHandler = new DiscoveryHandler() {
             List<DiscoveredPrinter> printers = new ArrayList<DiscoveredPrinter>();
 
             public void foundPrinter(DiscoveredPrinter printer) {
                 printers.add(printer);
             }
 
             public void discoveryFinished() {
                 for (DiscoveredPrinter printer : printers) {
                     System.out.println(printer);
                 }
                 System.out.println("Discovered " + printers.size() + " printers.");
             }
 
             public void discoveryError(String message) {
                 System.out.println("An error occurred during discovery : " + message);
             }
         };
         
         try {
             System.out.println("Starting printer discovery.");
             NetworkCardDiscoverer.findPrinters(discoveryHandler);
         } catch (DiscoveryException e) {
             e.printStackTrace();
         }
     }
 }
        
 

Method Summary

Methods

Modifier and Type	Method and Description
static void	directedBroadcast(DiscoveryHandler discoveryHandler, String ipAddress) Sends a directed broadcast discovery packet to the subnet specified by ipAddress.
static void	findPrinters(DiscoveryHandler discoveryHandler) This method will search the network using a combination of discovery methods to find printers on the network.
static void	findPrinters(DiscoveryHandler discoveryHandler, java.util.List<String> printersToFind) Sends a discovery request to the list of printer DNS names or IPs in printersToFind.
static void	localBroadcast(DiscoveryHandler discoveryHandler) Sends a local broadcast packet.
static void	setDiscoveryConfiguration(DiscoveryConfiguration discoveryConfiguration) Sets the network discovery configuration parameters.
static void	subnetSearch(DiscoveryHandler discoveryHandler, String subnetRange) Sends a discovery packet to the IPs specified in the subnetRange.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setDiscoveryConfiguration

public static void setDiscoveryConfiguration(DiscoveryConfiguration discoveryConfiguration)

Sets the network discovery configuration parameters.

Parameters:

discoveryConfiguration - the network discovery configuration.

subnetSearch

public static void subnetSearch(DiscoveryHandler discoveryHandler,
                String subnetRange)
                         throws DiscoveryException

Sends a discovery packet to the IPs specified in the subnetRange. Subnet searches are defined by the first three subnet octets, followed by a range, such as 192.168.2. This method accepts IP addresses of the form, assuming a subnet of 192.168.2:

• 192.168.2.254 (will send a discovery packet to 192.168.2.254)
• 192.168.2.* (will send a discovery packet for the range 192.168.2.1 - 192.168.2.254)
• 192.168.2.8-* (will send a discovery packet for the range 192.168.2.8 - 192.168.2.254)
• 192.168.2.37-42 (will send a discovery packet for the range 192.168.2.37 - 192.168.2.42)

This method will invoke the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method for each printer that is found during discovery. DiscoveryHandler.discoveryFinished() will be invoked when the discovery is finished and DiscoveryHandler.discoveryError(String) will be invoked when any errors are encountered during discovery. When DiscoveryHandler.discoveryError(String) is invoked, the discovery will be canceled and DiscoveryHandler.discoveryFinished() will not be invoked.

If a printer responds to the discovery request more than once, the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method will only be invoked on the first occurrence.

Parameters:

discoveryHandler - a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).

subnetRange - the subnet search range.

Throws:

DiscoveryException - if an error occurs while starting the discovery (errors during discovery will be sent via DiscoveryHandler.discoveryError(String)).

directedBroadcast

public static void directedBroadcast(DiscoveryHandler discoveryHandler,
                     String ipAddress)
                              throws DiscoveryException

Sends a directed broadcast discovery packet to the subnet specified by ipAddress. Directed broadcasts are defined by the first three subnet octets, followed by 255, such as 192.168.2.255. This method accepts IP addresses of the form, assuming a subnet of 192.168.2:

• 192.168.2.255
• 192.168.2.1 (last octet will be replaced with 255)
• 192.168.2 (will append 255 for the last octet)
• 192.168.2. (will append 255 for the last octet)

This method will invoke the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method for each printer that is found during discovery. DiscoveryHandler.discoveryFinished() will be invoked when the discovery is finished and DiscoveryHandler.discoveryError(String) will be invoked when any errors are encountered during discovery. When DiscoveryHandler.discoveryError(String) is invoked, the discovery will be canceled and DiscoveryHandler.discoveryFinished() will not be invoked.

If a printer responds to the discovery request more than once, the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method will only be invoked on the first occurrence.

Parameters:

discoveryHandler - a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).

ipAddress - the IP address of the subnet.

Throws:

DiscoveryException - if an error occurs while starting the discovery (errors during discovery will be sent via DiscoveryHandler.discoveryError(String)).

localBroadcast

public static void localBroadcast(DiscoveryHandler discoveryHandler)
                           throws DiscoveryException

Sends a local broadcast packet. This method will invoke the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method for each printer that is found during discovery. DiscoveryHandler.discoveryFinished() will be invoked when the discovery is finished and DiscoveryHandler.discoveryError(String) will be invoked when any errors are encountered during discovery. When DiscoveryHandler.discoveryError(String) is invoked, the discovery will be canceled and DiscoveryHandler.discoveryFinished() will not be invoked.

If a printer responds to the discovery request more than once, the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method will only be invoked on the first occurrence.

Parameters:

discoveryHandler - a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).

Throws:

DiscoveryException - if an error occurs while starting the discovery

findPrinters

public static void findPrinters(DiscoveryHandler discoveryHandler)
                         throws DiscoveryException

This method will search the network using a combination of discovery methods to find printers on the network. This is a convenience method that can be used as an alternative to the other discovery methods

This method will invoke the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method for each printer that is found during discovery. DiscoveryHandler.discoveryFinished() will be invoked when the discovery is finished and DiscoveryHandler.discoveryError(String) will be invoked when any errors are encountered during discovery. When DiscoveryHandler.discoveryError(String) is invoked, the discovery will be canceled and DiscoveryHandler.discoveryFinished() will not be invoked.

If a printer responds to the discovery request more than once, the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method will only be invoked on the first occurrence.

Parameters:

discoveryHandler - a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).

Throws:

DiscoveryException - if an error occurs while starting the discovery (errors during discovery will be sent via DiscoveryHandler.discoveryError(String)).

findPrinters

public static void findPrinters(DiscoveryHandler discoveryHandler,
                java.util.List<String> printersToFind)
                         throws DiscoveryException

Sends a discovery request to the list of printer DNS names or IPs in printersToFind. This method will invoke the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method for each printer that is found during discovery. DiscoveryHandler.discoveryFinished() will be invoked when the discovery is finished and DiscoveryHandler.discoveryError(String) will be invoked when any errors are encountered during discovery.
If a printer responds to the discovery request more than once, the DiscoveryHandler.foundPrinter(DiscoveredPrinter) method will only be invoked on the first occurrence.

Parameters:

discoveryHandler - a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).

printersToFind - a list of IP addresses or DNS names for the printers to be discovered.

Throws:

DiscoveryException - if an error occurs while starting the discovery (errors during discovery will be sent via DiscoveryHandler.discoveryError(String)).