summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/uic/barcode/dynamicFrame/api/ILevel1Data.java
blob: e23fc8865d01c5e6b2d8b702890ddc3c1400a92b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
package org.uic.barcode.dynamicFrame.api;

import java.util.Collection;
import java.util.Date;

/**
 * The Class SignedDataType.
 */
public interface ILevel1Data {
	


	/**
	 * Sets the security provider .
	 *
	 * @param securityProvider the new security provider
	 */
	public void setSecurityProvider(String securityProvider);
	

	/**
	 * Gets the security provider.
	 *
	 * @return the security provider
	 */
	public String getSecurityProvider();
	
	

	

	
	/**
	 * Gets the key id.
	 *
	 * @return the key id
	 */
	public Long getKeyId();
	

	/**
	 * Sets the key id.
	 *
	 * @param keyId the new key id
	 */
	public void setKeyId(Long keyId);

	/**
	 * Gets the data.
	 *
	 * @return the data
	 */
	public Collection<IData> getData();
	

	/**
	 * Sets the data.
	 *
	 * @param data the new data
	 */
	public void setData(Collection<IData> data);
	
	/**
	 * Adds data.
	 *
	 * @param data the new data
	 */
	public void addData(IData data);

	/**
	 * Gets the level 2 key algorithm OID.
	 *
	 * @return the level 2 key alg
	 */
	public String getLevel2KeyAlg();
	

	/**
	 * Sets the level 2 key algorithm OID.
	 *
	 * @param level2KeyAlg the new level 2 key alg
	 */
	public void setLevel2KeyAlg(String level2KeyAlg);
	

	/**
	 * Gets the level 1 signing alg.
	 *
	 * @return the level 1 signing alg
	 */
	public String getLevel1SigningAlg();
	

	/**
	 * Sets the level 1 signing algorithm OID.
	 *
	 * @param level1SigningAlg the new level 1 signing alg
	 */
	public void setLevel1SigningAlg(String level1SigningAlg);
	

	/**
	 * Gets the level 2 signing algorithm OID.
	 *
	 * @return the level 2 signing alg
	 */
	public String getLevel2SigningAlg();
	

	/**
	 * Sets the level 2 signing algorithm OID.
	 *
	 * @param level2SigningAlg the new level 2 signing alg
	 */
	public void setLevel2SigningAlg(String level2SigningAlg);
	

	/**
	 * Gets the level 2 public key.
	 *
	 * @return the level 2 public key
	 */
	public byte[] getLevel2publicKey();
	

	/**
	 * Sets the level 2 public key.
	 *
	 * @param level2publicKey the new level 2 public key
	 */
	public void setLevel2publicKey(byte[] level2publicKey);

	
	
	/**
	 * Gets the level 1 key algorithm OID.
	 *
	 * @return the level 1 key alg
	 */
	public String getLevel1KeyAlg();
	
	/**
	 * Sets the level 1 key algorithm OID.
	 *
	 * @param level1KeyAlg the new level 1 key alg
	 */
	public void setLevel1KeyAlg(String level1KeyAlg);
	
	
	/**
	 * Sets the end of validity date. The validity date has to be provided in UTC.
	 * 
	 * 	 -- end of the validity of the bar code, after this date and time the bar code needs to be regenerated 
     *   -- by the provider of the ticket
     *   -- if end of validity is provided year day and time must be provided.
     *   -- year, day, time are in UTC
     *   -- the provider of the bar code should ensure that the endOfValidity given here does not exceed 
     *   --     the validity of the key pair used on level 2.
	 *
	 * @param date the new end of validity date
	 */
	public void setEndOfBarcodeValidity(Date date);
	
	
	/**
	 * Gets the end of validity date and time.
	 * 
	 *  -- end of the validity of the bar code, after this date and time the bar code needs to be regenerated 
     *   -- by the provider of the ticket
     *   -- if end of validity is provided year day and time must be provided.
     *   -- year, day, time are in UTC
     *   -- the provider of the bar code should ensure that the endOfValidity given here does not exceed 
     *   --     the validity of the key pair used on level 2.
	 *
	 * @return the end of validity date
	 */
	public Date getEndOfBarcodeValidity();
	
	
	/**
	 * Gets the validity duration of the bar code in seconds.
	 * 
	 *  -- validity duration in seconds of the bar code shown with reference to the time stamp  dynamicContentTimeStamp 
   	 *  --          in the dynamic data included in the level2Data
	 *
	 * @return the validity duration
	 */
	public Long getValidityDuration();

	
	/**
	 * Sets the validity validity duration of the bar code in seconds.
	 * 
	 *  -- validity duration in seconds of the bar code shown with reference to the time stamp  dynamicContentTimeStamp 
   	 *  --          in the dynamic data included in the level2Data
	 *
	 * @param validityDuration the new validity duration
	 */
	public void setValidityDuration(Long validityDuration);
	
	
}