Package de.gmxhome.conrad.jpos.jpos_base.pinpad

Class PINPadService

java.lang.Object

de.gmxhome.conrad.jpos.jpos_base.JposBase

de.gmxhome.conrad.jpos.jpos_base.pinpad.PINPadService

All Implemented Interfaces:

jpos.loader.JposServiceInstance, jpos.services.BaseService, jpos.services.PINPadService110, jpos.services.PINPadService111, jpos.services.PINPadService112, jpos.services.PINPadService113, jpos.services.PINPadService114, jpos.services.PINPadService115, jpos.services.PINPadService116, jpos.services.PINPadService13, jpos.services.PINPadService14, jpos.services.PINPadService15, jpos.services.PINPadService16, jpos.services.PINPadService17, jpos.services.PINPadService18, jpos.services.PINPadService19

public class PINPadService
extends JposBase
implements jpos.services.PINPadService116

PINPad service implementation. For more details about getter, setter and method implementations, see JposBase.

Field Summary

Fields

Modifier and Type	Field	Description
PINPadInterface	PINPad	Instance of a class implementing the PINPadInterface for PIN pad specific setter and method calls bound to the property set.

Fields inherited from class de.gmxhome.conrad.jpos.jpos_base.JposBase

Device, DeviceInterface, Props

Constructor Summary

Constructors

Constructor	Description
PINPadService(PINPadProperties props, JposDevice device)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	beginEFTTransaction(String pinPadSystem, int transactionHost)
void	computeMAC(String inMsg, String[] outMsg)
void	enablePINEntry()
void	endEFTTransaction(int completionCode)
String	getAccountNumber()
String	getAdditionalSecurityInformation()
long	getAmount()
String	getAvailableLanguagesList()
String	getAvailablePromptsList()
int	getCapDisplay()
boolean	getCapKeyboard()
int	getCapLanguage()
boolean	getCapMACCalculation()
boolean	getCapTone()
String	getEncryptedPIN()
int	getMaximumPINLength()
String	getMerchantID()
int	getMinimumPINLength()
boolean	getPINEntryEnabled()
int	getPrompt()
String	getPromptLanguage()
String	getTerminalID()
byte[]	getTrack1Data()
byte[]	getTrack2Data()
byte[]	getTrack3Data()
byte[]	getTrack4Data()
int	getTransactionType()
boolean	resetEFTTransaction()	Reset EFT transaction, to be called whenever the PINPad needs to be reset, for example after claim or timeout.
void	setAccountNumber(String accountNumber)
void	setAmount(long amount)
void	setMaximumPINLength(int maximumPINLength)
void	setMerchantID(String merchantID)
void	setMinimumPINLength(int minimumPINLength)
void	setPrompt(int prompt)
void	setPromptLanguage(String promptLanguage)
void	setTerminalID(String terminalID)
void	setTrack1Data(byte[] track1Data)
void	setTrack2Data(byte[] track2Data)
void	setTrack3Data(byte[] track3Data)
void	setTrack4Data(byte[] track4Data)
void	setTransactionType(int transactionType)
void	updateKey(int keyNum, String key)
void	verifyMAC(String message)

Methods inherited from class de.gmxhome.conrad.jpos.jpos_base.JposBase

callNowOrLater, check, check, check, check, checkBusy, checkClaimed, checkEnabled, checkEnabledUnclaimed, checkFirstEnabled, checkHealth, checkNoChangedOrClaimed, checkOpened, claim, clearInput, clearInputProperties, clearOutput, close, compareFirmwareVersion, deepToString, deleteInstance, directIO, getAsyncMode, getAutoDisable, getCapCompareFirmwareVersion, getCapPowerReporting, getCapStatisticsReporting, getCapUpdateFirmware, getCapUpdateStatistics, getCheckHealthText, getClaimed, getDataCount, getDataEventEnabled, getDeviceEnabled, getDeviceServiceDescription, getDeviceServiceVersion, getFreezeEvents, getOutputID, getPhysicalDeviceDescription, getPhysicalDeviceName, getPowerNotify, getPowerState, getPropertyString, getState, logAsyncCall, logCall, logCall, logGet, logGet, logPreCall, logPreCall, logPreSet, logSet, open, release, removeOuterArraySpecifier, resetStatistics, retrieveStatistics, setAsyncMode, setAutoDisable, setDataEventEnabled, setDeviceEnabled, setFreezeEvents, setPowerNotify, signalRelease, startClaiming, updateFirmware, updateStatistics

Methods inherited from class java.lang.Object

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

Methods inherited from interface jpos.services.BaseService

checkHealth, claim, close, directIO, getCheckHealthText, getClaimed, getDeviceEnabled, getDeviceServiceDescription, getDeviceServiceVersion, getFreezeEvents, getPhysicalDeviceDescription, getPhysicalDeviceName, getState, open, release, setDeviceEnabled, setFreezeEvents

Methods inherited from interface jpos.loader.JposServiceInstance

deleteInstance

Methods inherited from interface jpos.services.PINPadService110

clearInputProperties

Methods inherited from interface jpos.services.PINPadService13

clearInput, getCapPowerReporting, getDataCount, getDataEventEnabled, getPowerNotify, getPowerState, setDataEventEnabled, setPowerNotify

Methods inherited from interface jpos.services.PINPadService18

getCapStatisticsReporting, getCapUpdateStatistics, resetStatistics, retrieveStatistics, updateStatistics

Methods inherited from interface jpos.services.PINPadService19

compareFirmwareVersion, getCapCompareFirmwareVersion, getCapUpdateFirmware, updateFirmware

Field Details

PINPad

public PINPadInterface PINPad

Instance of a class implementing the PINPadInterface for PIN pad specific setter and method calls bound to the property set. Almost always the same object as Data.

Constructor Details

PINPadService

public PINPadService(PINPadProperties props,
 JposDevice device)

Constructor. Stores given property set and device implementation object.

Parameters:

props - Property set.

device - Device implementation object.

Method Details

resetEFTTransaction

public boolean resetEFTTransaction()
                            throws jpos.JposException

Reset EFT transaction, to be called whenever the PINPad needs to be reset, for example after claim or timeout. The default implementation resets PINEntryEnabled and the service property EFTTransactionStarted and clears the data event queue.
This method returns true if a pending transaction has been reset, false if no transaction was pending.

Returns:

True if EFT transaction has been reset, false if PINpad was still idle.

Throws:

jpos.JposException - If an error occurred

getCapDisplay

public int getCapDisplay()
                  throws jpos.JposException

Specified by:

getCapDisplay in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getCapLanguage

public int getCapLanguage()
                   throws jpos.JposException

Specified by:

getCapLanguage in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getCapKeyboard

public boolean getCapKeyboard()
                       throws jpos.JposException

Specified by:

getCapKeyboard in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getCapMACCalculation

public boolean getCapMACCalculation()
                             throws jpos.JposException

Specified by:

getCapMACCalculation in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getCapTone

public boolean getCapTone()
                   throws jpos.JposException

Specified by:

getCapTone in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getAccountNumber

public String getAccountNumber()
                        throws jpos.JposException

Specified by:

getAccountNumber in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getAdditionalSecurityInformation

public String getAdditionalSecurityInformation()
                                        throws jpos.JposException

Specified by:

getAdditionalSecurityInformation in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getAmount

public long getAmount()
               throws jpos.JposException

Specified by:

getAmount in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getAvailableLanguagesList

public String getAvailableLanguagesList()
                                 throws jpos.JposException

Specified by:

getAvailableLanguagesList in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getAvailablePromptsList

public String getAvailablePromptsList()
                               throws jpos.JposException

Specified by:

getAvailablePromptsList in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getEncryptedPIN

public String getEncryptedPIN()
                       throws jpos.JposException

Specified by:

getEncryptedPIN in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getMaximumPINLength

public int getMaximumPINLength()
                        throws jpos.JposException

Specified by:

getMaximumPINLength in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getMerchantID

public String getMerchantID()
                     throws jpos.JposException

Specified by:

getMerchantID in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getMinimumPINLength

public int getMinimumPINLength()
                        throws jpos.JposException

Specified by:

getMinimumPINLength in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getPINEntryEnabled

public boolean getPINEntryEnabled()
                           throws jpos.JposException

Specified by:

getPINEntryEnabled in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getPrompt

public int getPrompt()
              throws jpos.JposException

Specified by:

getPrompt in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getPromptLanguage

public String getPromptLanguage()
                         throws jpos.JposException

Specified by:

getPromptLanguage in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getTerminalID

public String getTerminalID()
                     throws jpos.JposException

Specified by:

getTerminalID in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getTrack1Data

public byte[] getTrack1Data()
                     throws jpos.JposException

Specified by:

getTrack1Data in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getTrack2Data

public byte[] getTrack2Data()
                     throws jpos.JposException

Specified by:

getTrack2Data in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getTrack3Data

public byte[] getTrack3Data()
                     throws jpos.JposException

Specified by:

getTrack3Data in interface jpos.services.PINPadService13

Throws:

jpos.JposException

getTrack4Data

public byte[] getTrack4Data()
                     throws jpos.JposException

Specified by:

getTrack4Data in interface jpos.services.PINPadService15

Throws:

jpos.JposException

getTransactionType

public int getTransactionType()
                       throws jpos.JposException

Specified by:

getTransactionType in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setAccountNumber

public void setAccountNumber(String accountNumber)
                      throws jpos.JposException

Specified by:

setAccountNumber in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setAmount

public void setAmount(long amount)
               throws jpos.JposException

Specified by:

setAmount in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setMaximumPINLength

public void setMaximumPINLength(int maximumPINLength)
                         throws jpos.JposException

Specified by:

setMaximumPINLength in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setMerchantID

public void setMerchantID(String merchantID)
                   throws jpos.JposException

Specified by:

setMerchantID in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setMinimumPINLength

public void setMinimumPINLength(int minimumPINLength)
                         throws jpos.JposException

Specified by:

setMinimumPINLength in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setPrompt

public void setPrompt(int prompt)
               throws jpos.JposException

Specified by:

setPrompt in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setPromptLanguage

public void setPromptLanguage(String promptLanguage)
                       throws jpos.JposException

Specified by:

setPromptLanguage in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setTerminalID

public void setTerminalID(String terminalID)
                   throws jpos.JposException

Specified by:

setTerminalID in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setTrack1Data

public void setTrack1Data(byte[] track1Data)
                   throws jpos.JposException

Specified by:

setTrack1Data in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setTrack2Data

public void setTrack2Data(byte[] track2Data)
                   throws jpos.JposException

Specified by:

setTrack2Data in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setTrack3Data

public void setTrack3Data(byte[] track3Data)
                   throws jpos.JposException

Specified by:

setTrack3Data in interface jpos.services.PINPadService13

Throws:

jpos.JposException

setTrack4Data

public void setTrack4Data(byte[] track4Data)
                   throws jpos.JposException

Specified by:

setTrack4Data in interface jpos.services.PINPadService15

Throws:

jpos.JposException

setTransactionType

public void setTransactionType(int transactionType)
                        throws jpos.JposException

Specified by:

setTransactionType in interface jpos.services.PINPadService13

Throws:

jpos.JposException

beginEFTTransaction

public void beginEFTTransaction(String pinPadSystem,
 int transactionHost)
                         throws jpos.JposException

Specified by:

beginEFTTransaction in interface jpos.services.PINPadService13

Throws:

jpos.JposException

computeMAC

public void computeMAC(String inMsg,
 String[] outMsg)
                throws jpos.JposException

Specified by:

computeMAC in interface jpos.services.PINPadService13

Throws:

jpos.JposException

enablePINEntry

public void enablePINEntry()
                    throws jpos.JposException

Specified by:

enablePINEntry in interface jpos.services.PINPadService13

Throws:

jpos.JposException

endEFTTransaction

public void endEFTTransaction(int completionCode)
                       throws jpos.JposException

Specified by:

endEFTTransaction in interface jpos.services.PINPadService13

Throws:

jpos.JposException

updateKey

public void updateKey(int keyNum,
 String key)
               throws jpos.JposException

Specified by:

updateKey in interface jpos.services.PINPadService13

Throws:

jpos.JposException

verifyMAC

public void verifyMAC(String message)
               throws jpos.JposException

Specified by:

verifyMAC in interface jpos.services.PINPadService13

Throws:

jpos.JposException