jpos.Scanner Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javapos-controls Show documentation
Show all versions of javapos-controls Show documentation
JavaPOS Device Controls Library
//////////////////////////////////////////////////////////////////////
//
// The JavaPOS library source code is now under the CPL license, which
// is an OSS Apache-like license. The complete license is located at:
// http://www.ibm.com/developerworks/library/os-cpl.html
//
//////////////////////////////////////////////////////////////////////
//------------------------------------------------------------------------------
//
// This software is provided "AS IS". The JavaPOS working group (including
// each of the Corporate members, contributors and individuals) MAKES NO
// REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE SOFTWARE,
// EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NON-INFRINGEMENT. The JavaPOS working group shall not be liable for
// any damages suffered as a result of using, modifying or distributing this
// software or its derivatives.Permission to use, copy, modify, and distribute
// the software and its documentation for any purpose is hereby granted.
//
// Scanner.java - A JavaPOS 1.6.0 device control
//
//------------------------------------------------------------------------------
package jpos;
import jpos.events.*;
import jpos.services.*;
import java.util.Vector;
import jpos.loader.*;
public class Scanner
implements ScannerControl16, JposConst
{
//--------------------------------------------------------------------------
// Variables
//--------------------------------------------------------------------------
// Static Data
protected static final String deviceControlDescription =
"JavaPOS Scanner Device Control";
protected static final int deviceControlVersion = 1006000; // 1.6.0
protected static final int deviceVersion12 = 1002000; // 1.2.0
protected static final int deviceVersion13 = 1003000; // 1.3.0
protected static final int deviceVersion14 = 1004000; // 1.4.0
protected static final int deviceVersion15 = 1005000; // 1.5.0
protected static final int deviceVersion16 = 1006000; // 1.6.0
// Instance Data
protected JposServiceConnection serviceConnection;
protected int serviceVersion;
protected ScannerService12 service12;
protected ScannerService13 service13;
protected ScannerService14 service14;
protected ScannerService15 service15;
protected ScannerService16 service16;
protected Vector dataListeners;
protected Vector directIOListeners;
protected Vector errorListeners;
protected Vector statusUpdateListeners;
//--------------------------------------------------------------------------
// Constructor
//--------------------------------------------------------------------------
public Scanner()
{
serviceConnection = null;
service12 = null;
service13 = null;
service14 = null;
service15 = null;
service16 = null;
dataListeners = new Vector();
directIOListeners = new Vector();
errorListeners = new Vector();
statusUpdateListeners = new Vector();
}
//--------------------------------------------------------------------------
// Capabilities
//--------------------------------------------------------------------------
public int getCapPowerReporting()
throws JposException
{
// Attempt call to service if:
// 1. The service supports the necessary service interface version
// 2. The service is not open (this insures we fire the correct exception)
if((service12 == null) || (serviceVersion >= deviceVersion13))
{
try
{
return service13.getCapPowerReporting();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
else
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not support the ScannerControl13 interface");
}
}
//--------------------------------------------------------------------------
// Properties
//--------------------------------------------------------------------------
public String getCheckHealthText()
throws JposException
{
try
{
return service12.getCheckHealthText();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public boolean getClaimed()
throws JposException
{
try
{
return service12.getClaimed();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public String getDeviceControlDescription()
{
return deviceControlDescription;
}
public int getDeviceControlVersion()
{
return deviceControlVersion;
}
public boolean getDeviceEnabled()
throws JposException
{
try
{
return service12.getDeviceEnabled();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public void setDeviceEnabled(boolean deviceEnabled)
throws JposException
{
try
{
service12.setDeviceEnabled(deviceEnabled);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public String getDeviceServiceDescription()
throws JposException
{
try
{
return service12.getDeviceServiceDescription();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public int getDeviceServiceVersion()
throws JposException
{
try
{
return service12.getDeviceServiceVersion();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public boolean getFreezeEvents()
throws JposException
{
try
{
return service12.getFreezeEvents();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public void setFreezeEvents(boolean freezeEvents)
throws JposException
{
try
{
service12.setFreezeEvents(freezeEvents);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public String getPhysicalDeviceDescription()
throws JposException
{
try
{
return service12.getPhysicalDeviceDescription();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public String getPhysicalDeviceName()
throws JposException
{
try
{
return service12.getPhysicalDeviceName();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public int getState()
{
try
{
return service12.getState();
}
catch(Exception e)
{
return JPOS_S_CLOSED;
}
}
public boolean getAutoDisable()
throws JposException
{
try
{
return service12.getAutoDisable();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public void setAutoDisable(boolean autoDisable)
throws JposException
{
try
{
service12.setAutoDisable(autoDisable);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public int getDataCount()
throws JposException
{
try
{
return service12.getDataCount();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public boolean getDataEventEnabled()
throws JposException
{
try
{
return service12.getDataEventEnabled();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public void setDataEventEnabled(boolean dataEventEnabled)
throws JposException
{
try
{
service12.setDataEventEnabled(dataEventEnabled);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public boolean getDecodeData()
throws JposException
{
try
{
return service12.getDecodeData();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public void setDecodeData(boolean decodeData)
throws JposException
{
try
{
service12.setDecodeData(decodeData);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public byte[] getScanData()
throws JposException
{
try
{
return service12.getScanData();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public byte[] getScanDataLabel()
throws JposException
{
try
{
return service12.getScanDataLabel();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public int getScanDataType()
throws JposException
{
try
{
return service12.getScanDataType();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public int getPowerNotify()
throws JposException
{
// Attempt call to service if:
// 1. The service supports the necessary service interface version
// 2. The service is not open (this insures we fire the correct exception)
if((service12 == null) || (serviceVersion >= deviceVersion13))
{
try
{
return service13.getPowerNotify();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
else
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not support the ScannerControl13 interface");
}
}
public void setPowerNotify(int powerNotify)
throws JposException
{
// Attempt call to service if:
// 1. The service supports the necessary service interface version
// 2. The service is not open (this insures we fire the correct exception)
if((service12 == null) || (serviceVersion >= deviceVersion13))
{
try
{
service13.setPowerNotify(powerNotify);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
else
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not support the ScannerControl13 interface");
}
}
public int getPowerState()
throws JposException
{
// Attempt call to service if:
// 1. The service supports the necessary service interface version
// 2. The service is not open (this insures we fire the correct exception)
if((service12 == null) || (serviceVersion >= deviceVersion13))
{
try
{
return service13.getPowerState();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
else
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not support the ScannerControl13 interface");
}
}
//--------------------------------------------------------------------------
// Methods
//--------------------------------------------------------------------------
public void claim(int timeout)
throws JposException
{
try
{
service12.claim(timeout);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public synchronized void close()
throws JposException
{
try
{
service12.close();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED,
"Service not open",
e);
}
try
{
serviceConnection.disconnect();
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Unable to free service connection",
e);
}
finally
{
service12 = null;
service13 = null;
service14 = null;
service15 = null;
service16 = null;
}
}
public void checkHealth(int level)
throws JposException
{
try
{
service12.checkHealth(level);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public void directIO(int command, int[] data, Object object)
throws JposException
{
try
{
service12.directIO(command, data, object);
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public synchronized void open(String logicalDeviceName)
throws JposException
{
// Make sure the control is not already open
if(service12 != null)
{
throw new JposException(JPOS_E_ILLEGAL,
"Device control already open");
}
// Use JCL to get a connection to the device service
try
{
serviceConnection = JposServiceLoader.findService(logicalDeviceName);
serviceConnection.connect();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Could not connect to service",
e);
}
// Get an instance of the minimum service level supported
try
{
service12 = (ScannerService12)serviceConnection.getService();
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Could not get service instance",
e);
}
// Get service version
try
{
serviceVersion = service12.getDeviceServiceVersion();
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Could not get service version information",
e);
}
// Make sure that the service actually conforms to the interfaces it
// claims to.
if(serviceVersion >= deviceVersion13)
{
try
{
service13 = (ScannerService13)service12;
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not fully implement ScannerDevice13 interface",
e);
}
}
if(serviceVersion >= deviceVersion14)
{
try
{
service14 = (ScannerService14)service12;
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not fully implement ScannerDevice14 interface",
e);
}
}
if(serviceVersion >= deviceVersion15)
{
try
{
service15 = (ScannerService15)service12;
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not fully implement ScannerDevice15 interface",
e);
}
}
if(serviceVersion >= deviceVersion16)
{
try
{
service16 = (ScannerService16)service12;
}
catch(Exception e)
{
throw new JposException(JPOS_E_NOSERVICE,
"Service does not fully implement ScannerDevice16 interface",
e);
}
}
// Create callback subclass and attach it to the device service
ScannerCallbacks callbacks = this.new ScannerCallbacks();
service12.open(logicalDeviceName, callbacks);
}
public void release()
throws JposException
{
try
{
service12.release();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
public void clearInput()
throws JposException
{
try
{
service12.clearInput();
}
catch(JposException je)
{
throw je;
}
catch(Exception e)
{
throw new JposException(JPOS_E_CLOSED, "Control not opened", e);
}
}
//--------------------------------------------------------------------------
// Event Listener Methods
//--------------------------------------------------------------------------
public void addDataListener(DataListener l)
{
synchronized(dataListeners)
{
dataListeners.addElement(l);
}
}
public void removeDataListener(DataListener l)
{
synchronized(dataListeners)
{
dataListeners.removeElement(l);
}
}
public void addDirectIOListener(DirectIOListener l)
{
synchronized(directIOListeners)
{
directIOListeners.addElement(l);
}
}
public void removeDirectIOListener(DirectIOListener l)
{
synchronized(directIOListeners)
{
directIOListeners.removeElement(l);
}
}
public void addErrorListener(ErrorListener l)
{
synchronized(errorListeners)
{
errorListeners.addElement(l);
}
}
public void removeErrorListener(ErrorListener l)
{
synchronized(errorListeners)
{
errorListeners.removeElement(l);
}
}
public void addStatusUpdateListener(StatusUpdateListener l)
{
synchronized(statusUpdateListeners)
{
statusUpdateListeners.addElement(l);
}
}
public void removeStatusUpdateListener(StatusUpdateListener l)
{
synchronized(statusUpdateListeners)
{
statusUpdateListeners.removeElement(l);
}
}
//--------------------------------------------------------------------------
// EventCallbacks inner class
//--------------------------------------------------------------------------
protected class ScannerCallbacks implements EventCallbacks
{
public BaseControl getEventSource()
{
return (BaseControl)Scanner.this;
}
public void fireDataEvent(DataEvent e)
{
synchronized(Scanner.this.dataListeners)
{
// deliver the event to all registered listeners
for(int x = 0; x < dataListeners.size(); x++)
{
((DataListener)dataListeners.elementAt(x)).dataOccurred(e);
}
}
}
public void fireDirectIOEvent(DirectIOEvent e)
{
synchronized(Scanner.this.directIOListeners)
{
// deliver the event to all registered listeners
for(int x = 0; x < directIOListeners.size(); x++)
{
((DirectIOListener)directIOListeners.elementAt(x)).directIOOccurred(e);
}
}
}
public void fireErrorEvent(ErrorEvent e)
{
synchronized(Scanner.this.errorListeners)
{
// deliver the event to all registered listeners
for(int x = 0; x < errorListeners.size(); x++)
{
((ErrorListener)errorListeners.elementAt(x)).errorOccurred(e);
}
}
}
public void fireOutputCompleteEvent(OutputCompleteEvent e)
{
}
public void fireStatusUpdateEvent(StatusUpdateEvent e)
{
synchronized(Scanner.this.statusUpdateListeners)
{
// deliver the event to all registered listeners
for(int x = 0; x < statusUpdateListeners.size(); x++)
{
((StatusUpdateListener)statusUpdateListeners.elementAt(x)).statusUpdateOccurred(e);
}
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy