English version. This CEN Workshop Agreement can in no way be held as being an official standard developed by CEN and its Members.

Transcription

1 CEN WORKSHOP CWA August 2009 AGREEMENT ICS English versin J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Part 9: Depsitry Device Class Interface - Prgrammer's Reference This CEN Wrkshp Agreement has been drafted and apprved by a Wrkshp f representatives f interested parties, the cnstitutin f which is indicated in the frewrd f this Wrkshp Agreement. The frmal prcess fllwed by the Wrkshp in the develpment f this Wrkshp Agreement has been endrsed by the Natinal Members f CEN but neither the Natinal Members f CEN nr the CEN Management Centre can be held accuntable fr the technical cntent f this CEN Wrkshp Agreement r pssible cnflicts with standards r legislatin. This CEN Wrkshp Agreement can in n way be held as being an fficial standard develped by CEN and its Members. This CEN Wrkshp Agreement is publicly available as a reference dcument frm the CEN Members Natinal Standard Bdies. CEN members are the natinal standards bdies f Austria, Belgium, Bulgaria, Cyprus, Czech Republic, Denmark, Estnia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Lithuania, Luxemburg, Malta, Netherlands, Nrway, Pland, Prtugal, Rmania, Slvakia, Slvenia, Spain, Sweden, Switzerland and United Kingdm. EUROPEAN COMMITTEE FOR STANDARDIZATION COMITÉ EUROPÉEN DE NORMALISATION EUROPÄISCHES KOMITEE FÜR NORMUNG Management Centre: Avenue Marnix 17, B-1000 Brussels 2009 CEN All rights f explitatin in any frm and by any means reserved wrldwide fr CEN natinal Members. Ref. N.:CWA :2009 E

2 Cntents FOREWORD HISTORY... 6 SCOPE OVERVIEW DESCRIPTION CLASS HIERARCHY CLASSES AND INTERFACES CLASSES AND INTERFACES ACCESS TO PROPERTIES IJXFSDEPOSITORYCONTROL Summary Prperties Methds SUPPORT CLASSES SUMMARY JXFSDEPENTRYCAPABILITY Summary Prperties Methds JXFSDEPENVSUPPLYCAPABILITY Summary Prperties Methds JXFSDEPIMAGE Summary Prperties JXFSDEPNUMOFDEPOSITS Summary Prperties Methds JXFSDEPPRINTCAPABILITY Summary Prperties Methds JXFSDEPRETRACTCOUNT Summary Prperties Methds JXFSDEPRETRACTCAPABILITY Summary Prperties Methds JXFSDEPREADIMAGECAPABILITY Summary Prperties Methds JXFSDEPTRANSPORTCAPABILITY Summary Prperties Methds JXFSDEPTRANSPORTDIRECTION Summary

3 Prperties Methds ENUM CLASSES JXFSDEPSTATUSSELECTORENUM STATUS EVENT CLASSES JXFSTHRESHOLDSTATUS Summary JXFSDEPRUNITSTATUS Summary Prperties Methds JXFSDEPSHUTTERSTATUS Summary Prperties Methds JXFSDEPUNITSTATUS Summary Prperties Methds JXFSDEPSTATUS Summary Prperties Events CODES ERROR CODES STATUS CODES CONSTANTS OPERATION ID CODES DEVICE SERVICE INTERFACE METHODS CONSTANT DEFINITIONS Status Cdes Operatin ID Cdes Intermediate Cdes Errr Cdes General Cdes Capability Cdes

4 Frewrd This CWA cntains the specificatins that define the J/eXtensins fr Financial Services (J/XFS) fr the Java TM Platfrm, as develped by the J/XFS Frum and endrsed by the CEN J/XFS Wrkshp. J/XFS prvides an API fr Java applicatins which need t access financial devices. It is hardware independent and, by using 100% pure Java, als perating system independent. The CEN J/XFS Wrkshp gathers suppliers (amng thers the J/XFS Frum members), service prviders as well as banks and ther financial service cmpanies. A list f cmpanies participating in this Wrkshp and in supprt f this CWA is available frm the CEN Secretariat, and at The specificatin was agreed upn by the J/XFS Wrkshp Meeting f /9 in Brussels, and the final versin was sent t CEN fr publicatin n The specificatin is cntinuusly reviewed and cmmented in the CEN J/XFS Wrkshp. The infrmatin published in this CWA is furnished fr infrmatinal purpses nly. CEN makes n warranty expressed r implied, with respect t this dcument. Updates f the specificatin will be available frm the CEN J/XFS Wrkshp public web pages pending their integratin in a new versin f the CWA (see The J/XFS specificatins are nw further develped in the CEN J/XFS Wrkshp. CEN Wrkshps are pen t all interested parties ffering t cntribute. Parties interested in participating and parties wanting t submit questins and cmments fr the J/XFS specificatins, please cntact the J/XFS Wrkshp Secretariat hsted in CEN (jxfs-helpdesk@cen.eu). Questins and cmments can als be submitted t the members f the J/XFS Frum thrugh the J/XFS Frum web-site This CWA is cmpsed f the fllwing parts: Part 1: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Base Architecture - Prgrammer's Reference Part 2: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Pin Keypad Device Class Interface - Prgrammer's Reference Part 3: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Magnetic Stripe & Chip Card Device Class Interface - Prgrammer's Reference Part 4: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Text Input/Output Device Class Interface - Prgrammer's Reference Part 5: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Cash Dispenser, Recycler and ATM Device Class Interface - Prgrammer's Reference Part 6: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Printer Device Class Interface - Prgrammer's Reference Part 7: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Alarm Device Class Interface - Prgrammer's Reference Part 8: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Sensrs and Indicatrs Unit Device Class Interface - Prgrammer's Reference Part 9: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Depsitry Device Class Interface - Prgrammer's Reference Part 10: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Check Reader/Scanner Device Class Interface - Prgrammer's Reference (deprecated in favur f Part 13) Part 11: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Camera Device Class Interface - Prgrammer's Reference Part 12: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm - Release Vendr Dependant Mde Specificatin - Prgrammer's Reference Part 13: J/eXtensins fr Financial Services (J/XFS) fr the Java Platfrm Scanner Device Class Interface - Prgrammer s Reference (recmmended replacement fr Part 10) 4

5 Nte: Java and all Java-based trademarks and lgs are trademarks f Sun Micrsystems, Inc. The Java Trademark Guidelines are currently available n the web at All ther trademarks are trademarks f their respective wners. This CEN Wrkshp Agreement is publicly available as a reference dcument frm the Natinal Members f CEN : AENOR, AFNOR, ASRO, BDS, BSI, CSNI, CYS, DIN, DS, ELOT, EVS, IBN, IPQ, IST, LVS, LST, MSA, MSZT, NEN, NSAI, ON, PKN, SEE, SIS, SIST, SFS, SN, SNV, SUTN and UNI. Cmments r suggestins frm the users f the CEN Wrkshp Agreement are welcme and shuld be addressed t the CEN Management Centre. 5

6 1 Histry Main differences t CWA :2004 are: Imprved descriptin hw the pen methd wrks Replaced OperatinCmpleteEvent by JxfsOperatinCmpleteEvent and als fr StatusEvent Main differences t CWA :2000 are: Added methd where JXFS_I_DEP_NO_MEDIA_INSERTED ccurrs in summary f IJxfsDepsitryCntrl. Specifies errr/exceptin cde when null parameter has been passed t entryenvelpe() r retractenvelpe() New cnstants JXFS_DEP_NO_SCAN and JXFS_DEP_NO_TRANSPORT fr value 0. Renamed methds f JxfsDepTransprtDirectin class fr a better understanding. changed data field f OCE f cleartransprt() methd and intrduced JxfsDepTransprtDirectin class. Additinal cmment fr methd dispenseenvelpe(). The peratin is cmpleted when the envelpe has been taken. The details prperty f a JXFS_S_DEP_TRANSPORT event f the dispenseenvelpe() methd is f the type JxfsDepUnitStatus The details prperty f a JXFS_S_DEP_SCANNER event f the readimage() methd is f the type JxfsDepUnitStatus Spelling errr in ismtrized() methd f JxfsDepEnvSupplyCapability class. JXFS_DEP_ENVMOTORIZED instead f JXFS_DEP_MOTORIZED. New methd setnumofdepsits in interface IJxfsDepsitryCntrl because the number may be stred in the hardware and therefre setting this value requires hardware access that shuld be asynchrneus. intrduced resetretractcunt() methd. This methd was mentined in the descriptin f the JxfsDepRetractCunt class. Slved incnsistencies in the class JxfsDepUnitStatus. New cmment fr JxfsDepReadImageCapability and JxfsDepTransprtCapability classes that their prperty may have the value zer, if nne f the specified capabilities is available. Added JXFS_S_DEP_RETRACTCOUNT t the list f the status events in the "Events" chapter. New cment in descriptin f entryenvelpe() methd what has t be dne after a JXFS_I_DEP_ENVTAKEN event. Cmment that a null reference as String is nt allwed fr the entryenvelpe() and retractenvelpe() methds. Renamed all references f JxfsDepImageData t JxfsDepImage. In the methd readimage() the desired image frmat may be ptinally selected. The flag cmbinatin f JxfsDepPrintCapability has been refrmulated and the isprinterwithribbn() methd has been added. The summary f the events f the IJxfsDepsitryCntrl interface was nt cmplete Extended the descriptin f the cleartransprt methd. 6

7 2 Scpe This dcument describes the depsitry device class based n the basic architecture f J/XFS which is similar t the JavaPOS architecture. It is event driven and asynchrnus. Three basic levels are defined in JavaPOS. Fr J/XFS this mdel is extended by a cmmunicatin layer, which prvides device cmmunicatin that allws distributin f applicatins and devices within a netwrk. S we have the fllwing layers in J/XFS: Applicatin Device Cntrl and Manager Device Cmmunicatin Device Service Applicatin develpers prgram against cntrl bjects and the Device Manager which reside in the Device Cntrl Layer. This is the usual interface between applicatins and J/XFS Devices. Device Cntrl Objects access the Device Manager t find an assciated Device Service. Device Service Objects prvide the functinality t access the real device (i.e. like a device driver). During applicatin startup the Device Manager is respnsible fr lcating the desired Device Service Object and attaching this t the requesting Device Cntrl Object. Lcatin and/r ruting infrmatin fr the Device Manager reside in a central repsitry. T supprt depsitry devices the basic Device Cntrl structure is extended with varius prperties and methds specific t this device which are described n the fllwing pages. 7

8 3 Overview 3.1 Descriptin A Depsitry is used fr the acceptance and depsit f media int the device r terminal. There are tw main types f depsitry supprted by the J/XFS Depsitry Device Class: An envelpe depsitry fr the depsit f media in envelpes and a night safe depsitry fr the depsit f bags cntaining bulk media. envelpe depsitry fr the depsit f media in envelpes An envelpe depsitry accepts media, prints n the media and depsits the media int a hlding cntainer r bin. Sme envelpe depsitries ffer the capability t dispense an envelpe t the custmer at the start f a transactin. The custmer takes this envelpe, fills in the depsit media, pssibly inscribes it and puts it int the depsit slt. The envelpe is then accepted, printed and transprted int a depsit cntainer. The envelpe dispense mechanism may be part f the envelpe depsitry device mechanism with the same entry/exit slt r it may be a separate mechanism with separate entry/exit slt. Envelpes dispensed and nt taken by the custmer can be retracted back int the device. When the dispenser is a separate mechanism the envelpe is retracted back int the dispenser cntainer. When the dispenser is a cmmn mechanism the envelpe is retracted int the depsitry cntainer. Sme envelpe depsitries are able t read image data frm inserted media. night safe depsitry A night safe depsitry nrmally nly lgs the depsit f a bag and des nt print n the media. The J/XFS Depsitry Device Supprt uses the event driven mdel. The applicatin will instantiate a J/XFS Depsitry Device Cntrl Object and then calls the defined I/O methds with passing data bjects cntaining the parameters. When an I/O methd is called, the J/XFS Depsitry Device Supprt will attempt t prcess the requested I/O. If the request is invalid r an exceptin is encuntered the applicatin will be ntified by a J/XFS exceptin. Cmpletin f the request will be reprted by an event. Thus the applicatin must register itself with the J/XFS Depsitry Device Cntrl Object fr the varius types f events it wishes t handle. 8