1 // 2 // --------- 3 // |.##> <##.| CardContact Software & System Consulting 4 // |# #| 32429 Minden, Germany (www.cardcontact.de) 5 // |# #| Copyright (c) 2010. All rights reserved 6 // |'##> <##'| See file COPYING for details on licensing 7 // --------- 8 // 9 // BlackListGenerator Tests and API Documentation 10 // 11 12 /// <?xml version="1.0" encoding="ISO-8859-1"?> 13 /// <?xml-stylesheet type="text/xsl" href="docclass.xsl" ?> 14 /// <class xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 15 /// xsi:noNamespaceSchemaLocation="api_doc.xsd" name="X509"> 16 /// <description><p>Class implementing support for black lists specific by TR-03129, Version 1.0</p> 17 /// <method name=""> 18 /// <signature></signature> 19 /// <description></description> 20 /// <argument name="" type=""></argument> 21 /// <return type=""></return> 22 /// <example> 23 /// </example> 24 /// <exception name="GPError" value="GPError.ARGUMENTS_MISSING">Too few arguments in call</exception> 25 /// <exception name="GPError" value="GPError.INVALID_ARGUMENTS">Too many arguments in call</exception> 26 /// <exception name="GPError" value="GPError.INVALID_TYPE">Type of argument is invalid for call</exception> 27 /// </method> 28 29 load("BlackListGenerator.js"); 30 31 /// <constructor> 32 /// <signature>BlackListGenerator()</signature> 33 /// <description>Create the vlack list generator.</description> 34 /// <example> 35 36 generator = new BlackListGenerator(); 37 38 /// </example> 39 40 /// <method name="setVersion"> 41 /// <signature>void setVersion(ByteString version)</signature> 42 /// <description><p>Set the version number of the black list (must be 0 for Version 1.00 of TR-03129)</p></description> 43 /// <example> 44 45 var version = new ByteString("00", HEX); 46 47 generator.setVersion(version); 48 49 /// </example> 50 /// </method> 51 52 /// <method name="setType"> 53 /// <signature>void setType(ByteString type)</signature> 54 /// <description><p>Set the type of the black list. Use one of the already defined constants: 55 /// BlackListGEnerator.COMPLETE_LIST - for a complete black list 56 /// BlackListGEnerator.ADDED_LIST - for a black list containing added items 57 /// BlackListGEnerator.REMOVED_LIST - for a black list containing removed items 58 /// </p></description> 59 /// <example> 60 61 generator.setType(BlackListGenerator.REMOVED_LIST); 62 63 /// </example> 64 /// </method> 65 66 67 /// <method name="setListID"> 68 /// <signature>void setListID(ByteString listID)</signature> 69 /// <description><p>Set the unique ID of the black list.</p></description> 70 /// <example> 71 72 var listID = new ByteString("201003200001", ASCII); 73 74 generator.setListID(listID); 75 76 /// </example> 77 /// </method> 78 79 80 /// <method name="setDeltaBase"> 81 /// <signature>void setDeltaBase(ByteString deltaBase)</signature> 82 /// <description><p>Set the unique ID of the delta base of the black list.</p></description> 83 /// <example> 84 85 var deltaBase = new ByteString("201003150001", HEX); 86 87 generator.setDeltaBase(deltaBase); 88 89 /// </example> 90 /// </method> 91 92 /// <method name="addBlackListDetails"> 93 /// <signature>ByteString addBlackListDetails(ByteString sectorID, ByteString[] sectorSpecificIDs)</signature> 94 /// <description><p>Add details to the black list.</p></description> 95 /// <example> 96 97 var sector_A = new ByteString("0xFFFFFF", HEX); 98 var sectorSpecificIDs_A = [new ByteString("0x0101", HEX), new ByteString("0x0202", HEX)]; 99 100 generator.addBlackListDetails(sector_A, sectorSpecificIDs_A); 101 102 var sector_B = new ByteString("0xEEEEEE", HEX); 103 var sectorSpecificIDs_B = [new ByteString("0x0303", HEX), new ByteString("0x0404", HEX)]; 104 105 generator.addBlackListDetails(sector_B, sectorSpecificIDs_B); 106 107 /// </example> 108 /// </method> 109 110 /// <method name="generateBlackList"> 111 /// <signature>ByteString generateBlackList()</signature> 112 /// <description><p>Create the black list.</p></description> 113 /// <example> 114 115 var blackList = generator.generateBlackList(); 116 117 var bl = new ASN1(blackList); 118 print(bl); 119 120 /// </example> 121 /// </method> 122 123 /// </class> 124