Skip to content

Commit dd87b0d

Browse files
added javadoc for merchantconfig
1 parent 10f81c6 commit dd87b0d

1 file changed

Lines changed: 201 additions & 31 deletions

File tree

java/src/main/java/com/cybersource/ws/client/MerchantConfig.java

Lines changed: 201 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -98,148 +98,284 @@ public boolean isCustomHttpClassEnabled() {
9898
private long retryInterval = 0;
9999
private boolean allowRetry=true;
100100

101+
/**
102+
* Getter method for useSignAndEncrypted
103+
* @return boolean
104+
*/
101105
// getter methods
102106
public boolean getUseSignAndEncrypted() { return useSignAndEncrypted; }
103-
104107

108+
/**
109+
* Getter method for merchantID
110+
* @return String
111+
*/
105112
public String getMerchantID() {
106113
return merchantID;
107114
}
108-
115+
/**
116+
* Getter method for keysDirectory
117+
* @return String
118+
*/
109119
public String getKeysDirectory() {
110120
return keysDirectory;
111121
}
112-
122+
/**
123+
* If keyAlias not null, return keyAlias, else return merchantId
124+
* @return String
125+
*/
113126
public String getKeyAlias() {
114127
if ( keyAlias != null )
115128
return keyAlias;
116129
else
117130
return getMerchantID();
118131
}
119-
132+
/**
133+
* If keyPassword not null, return keyPassword, else return merchantId
134+
* @return String
135+
*/
120136
public String getKeyPassword() {
121137
if ( keyPassword != null )
122138
return keyPassword;
123139
else
124140
return getMerchantID();
125141
}
126-
142+
143+
/**
144+
* Getter method for sendToProduction
145+
* @return boolean
146+
*/
127147
public boolean getSendToProduction() {
128148
return sendToProduction;
129149
}
130-
150+
151+
/**
152+
* Getter method for sendToAkamai
153+
* @return boolean
154+
*/
131155
public boolean getSendToAkamai() {
132156
return sendToAkamai;
133157
}
134-
158+
159+
/**
160+
* Getter method for targetAPIVersion
161+
* @return String
162+
*/
135163
public String getTargetAPIVersion() {
136164
return targetAPIVersion;
137165
}
138-
166+
167+
/**
168+
* Getter method for keyFilename
169+
* @return String
170+
*/
139171
public String getKeyFilename() {
140172
return keyFilename;
141173
}
142-
174+
175+
/**
176+
* Getter method for serverURL
177+
* @return String
178+
*/
143179
public String getServerURL() {
144180
return serverURL;
145181
}
146-
182+
183+
/**
184+
* Getter method for namespaceURI
185+
* @return String
186+
*/
147187
public String getNamespaceURI() {
148188
return namespaceURI;
149189
}
150-
190+
191+
/**
192+
* Getter method for password
193+
* @return String
194+
*/
151195
public String getPassword() {
152196
return password;
153197
}
154-
198+
199+
/**
200+
* Getter method for enableLog
201+
* @return boolean
202+
*/
155203
public boolean getEnableLog() {
156204
return enableLog;
157205
}
158-
206+
207+
/**
208+
* Getter method for logSignedData
209+
* @return boolean
210+
*/
159211
public boolean getLogSignedData() {
160212
return logSignedData;
161213
}
162-
214+
215+
/**
216+
* Getter method for logDirectory
217+
* @return String
218+
*/
163219
public String getLogDirectory() {
164220
return logDirectory;
165221
}
166-
222+
223+
/**
224+
* Getter method for logFilename
225+
* @return String
226+
*/
167227
public String getLogFilename() {
168228
return logFilename;
169229
}
170-
230+
231+
/**
232+
* Getter method for logMaximumSize
233+
* @return int
234+
*/
171235
public int getLogMaximumSize() {
172236
return logMaximumSize;
173237
}
174-
238+
239+
/**
240+
* Getter method for useHttpClient
241+
* @return boolean
242+
*/
175243
public boolean getUseHttpClient() {
176244
return useHttpClient;
177245
}
178246

247+
/**
248+
* Getter method for useHttpClientWithConnectionPool
249+
* @return boolean
250+
*/
179251
public boolean getUseHttpClientWithConnectionPool() {
180252
return useHttpClientWithConnectionPool;
181253
}
182254

255+
/**
256+
* Getter method for timeout
257+
* @return int
258+
*/
183259
public int getTimeout() {
184260
return timeout;
185261
}
186262

263+
/**
264+
* Getter method for maxConnections
265+
* @return int
266+
*/
187267
public int getMaxConnections() {
188268
return maxConnections;
189269
}
190270

271+
/**
272+
* Getter method for defaultMaxConnectionsPerRoute
273+
* @return int
274+
*/
191275
public int getDefaultMaxConnectionsPerRoute() {
192276
return defaultMaxConnectionsPerRoute;
193277
}
194278

279+
/**
280+
* Getter method for maxConnectionsPerRoute
281+
* @return int
282+
*/
195283
public int getMaxConnectionsPerRoute() {
196284
return maxConnectionsPerRoute;
197285
}
198286

287+
/**
288+
* Getter method for connectionRequestTimeoutMs
289+
* @return int
290+
*/
199291
public int getConnectionRequestTimeoutMs() {
200292
return connectionRequestTimeoutMs;
201293
}
202294

295+
/**
296+
* Getter method for connectionTimeoutMs
297+
* @return int
298+
*/
203299
public int getConnectionTimeoutMs() {
204300
return connectionTimeoutMs;
205301
}
206302

303+
/**
304+
* Getter method for socketTimeoutMs
305+
* @return int
306+
*/
207307
public int getSocketTimeoutMs() {
208308
return socketTimeoutMs;
209309
}
210310

311+
/**
312+
* Getter method for evictThreadSleepTimeMs
313+
* @return int
314+
*/
211315
public int getEvictThreadSleepTimeMs() {
212316
return evictThreadSleepTimeMs;
213317
}
214318

319+
/**
320+
* Getter method for maxKeepAliveTimeMs
321+
* @return int
322+
*/
215323
public int getMaxKeepAliveTimeMs() {
216324
return maxKeepAliveTimeMs;
217325
}
218326

327+
/**
328+
* Getter method for proxyHost
329+
* @return String
330+
*/
219331
public String getProxyHost() {
220332
return proxyHost;
221333
}
222-
334+
335+
/**
336+
* Getter method for proxyPort
337+
* @return int
338+
*/
223339
public int getProxyPort() {
224340
return proxyPort;
225341
}
226-
342+
343+
/**
344+
* Getter method for proxyUser
345+
* @return String
346+
*/
227347
public String getProxyUser() {
228348
return proxyUser;
229349
}
230-
350+
351+
/**
352+
* Getter method for proxyPassword
353+
* @return String
354+
*/
231355
public String getProxyPassword() {
232356
return proxyPassword != null ? proxyPassword : "";
233357
}
234-
235-
public boolean isCertificateCacheEnabled() {
358+
359+
/**
360+
* Getter method for certificateCacheEnabled
361+
* @return boolean
362+
*/
363+
public boolean isCertificateCacheEnabled() {
236364
return certificateCacheEnabled;
237-
}
238-
365+
}
366+
367+
/**
368+
* Getter method for merchantConfigCacheEnabled
369+
* @return boolean
370+
*/
239371
public boolean isMerchantConfigCacheEnabled() {
240372
return merchantConfigCacheEnabled;
241373
}
242374

375+
/**
376+
* Getter method for shutdownHookEnabled
377+
* @return boolean
378+
*/
243379
public boolean isShutdownHookEnabled() {
244380
return shutdownHookEnabled;
245381
}
@@ -586,6 +722,7 @@ public String getProperty(
586722

587723
/**
588724
* Returns a string representation of the properties for logging purposes.
725+
* @return String
589726
*/
590727
public String getLogString() {
591728

@@ -705,34 +842,67 @@ private int getIntegerProperty(
705842
throw new ConfigException(prop + " has an invalid value.");
706843
}
707844
}
708-
845+
846+
/**
847+
* Getter method for uniqueKey
848+
* @return UUID
849+
*/
709850
public UUID getUniqueKey() {
710851
return uniqueKey;
711852
}
712-
853+
854+
/**
855+
* Getter method for numberOfRetries
856+
* @return int
857+
*/
713858
public int getNumberOfRetries() {
714859
return numberOfRetries;
715860
}
716-
861+
862+
/**
863+
* Getter method for retryInterval
864+
* @return long
865+
*/
717866
public long getRetryInterval() {
718867
return retryInterval;
719868
}
720-
869+
870+
/**
871+
* Getter method for allowRetry
872+
* @return boolean
873+
*/
721874
public boolean isAllowRetry() {
722875
return allowRetry;
723876
}
724-
877+
878+
/**
879+
* Setter method for allowRetry
880+
* @param allowRetry
881+
*/
725882
public void setAllowRetry(boolean allowRetry) {
726883
this.allowRetry = allowRetry;
727884
}
728-
885+
886+
/**
887+
* Getter method for enableCacert
888+
* @return boolean
889+
*/
729890
public boolean isCacertEnabled() {
730891
return enableCacert;
731892
}
732-
893+
894+
/**
895+
* Getter method for enableJdkCert
896+
* @return boolean
897+
*/
733898
public boolean isJdkCertEnabled() {
734899
return enableJdkCert;
735900
}
901+
902+
/**
903+
* Getter method for cacertPassword
904+
* @return String
905+
*/
736906
public String getCacertPassword(){
737907
return cacertPassword;
738908
}

0 commit comments

Comments
 (0)