-
Notifications
You must be signed in to change notification settings - Fork 3
/
VerifaliaRestClient.java
161 lines (145 loc) · 7.61 KB
/
VerifaliaRestClient.java
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
/*
* Verifalia - Email list cleaning and real-time email verification service
* https://verifalia.com/
* support@verifalia.com
*
* Copyright (c) 2005-2020 Cobisi Research
*
* Cobisi Research
* Via Prima Strada, 35
* 35129, Padova
* Italy - European Union
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.verifalia.api;
import com.verifalia.api.baseURIProviders.BaseURIProvider;
import com.verifalia.api.baseURIProviders.ClientCertificateBaseURIProvider;
import com.verifalia.api.baseURIProviders.DefaultBaseURIProvider;
import com.verifalia.api.credits.CreditsRestClient;
import com.verifalia.api.emailvalidations.EmailValidationsRestClient;
import com.verifalia.api.rest.RestClient;
import com.verifalia.api.rest.security.AuthenticationProvider;
import com.verifalia.api.rest.security.UsernamePasswordAuthenticationProvider;
import com.verifalia.api.rest.security.ClientCertificateAuthenticationProvider;
import lombok.NonNull;
import java.io.File;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Collections;
import java.util.List;
/**
* HTTPS-based REST client for Verifalia.
*/
public class VerifaliaRestClient {
/**
* The default API version supported by the SDK.
*/
public static final String DEFAULT_API_VERSION = "v2.2";
/**
* Cached REST client object.
*/
RestClient cachedRestClient;
/**
* Email validation service client object.
*/
EmailValidationsRestClient emailValidations;
/**
* Credits service client object.
*/
CreditsRestClient credits;
/**
* Initializes a new HTTPS-based REST client for Verifalia with the specified username and password. While
* authenticating with your Verifalia main account credentials is possible, it is strongly advised to create one
* or more users (formerly known as sub-accounts) with just the required permissions, for improved security.
* To create a new user or manage existing ones, please visit https://verifalia.com/client-area#/users
* @param username The username to authenticate with.
* @param password The password to authenticate with.
*/
public VerifaliaRestClient(@NonNull final String username, @NonNull final String password) {
this(new UsernamePasswordAuthenticationProvider(username, password), new DefaultBaseURIProvider());
}
/**
* Initializes a new HTTPS-based REST client for Verifalia with the specified client certificate (for enterprise-grade
* mutual TLS authentication). TLS client certificate authentication is available to premium plans only.
* To create a new user or manage existing ones, please visit https://verifalia.com/client-area#/users
* @param certAlias
* @param certPassword
* @param identityStoreJksFile
* @param trustKeyStoreJksFile
*/
public VerifaliaRestClient(String certAlias, String certPassword, File identityStoreJksFile, File trustKeyStoreJksFile) {
this(new ClientCertificateAuthenticationProvider(certAlias, certPassword, identityStoreJksFile, trustKeyStoreJksFile), new ClientCertificateBaseURIProvider());
}
/**
* Initializes a new HTTPS-based REST client for Verifalia with the specified {@link AuthenticationProvider}.
* @param authenticationProvider The {@link AuthenticationProvider} which authenticates to the Verifalia API.
*/
public VerifaliaRestClient(@NonNull final AuthenticationProvider authenticationProvider) {
this(authenticationProvider, new DefaultBaseURIProvider(), DEFAULT_API_VERSION);
}
/**
* Initializes a new HTTPS-based REST client for Verifalia with the specified {@link AuthenticationProvider}, using the
* specified API version. Warning: using an unsupported API version here may affect the stability of the SDK itself.
* @param authenticationProvider The {@link AuthenticationProvider} which authenticates to the Verifalia API.
* @param apiVersion The specific API version to use while connecting to the Verifalia API. Warning: this value may
* affect the stability of the SDK itself. If unsure, please just use {@link #VerifaliaRestClient(AuthenticationProvider)}.
*/
public VerifaliaRestClient(@NonNull final AuthenticationProvider authenticationProvider, @NonNull final String apiVersion) {
this(authenticationProvider, new DefaultBaseURIProvider(), apiVersion);
}
/**
* Initializes a new HTTPS-based REST client for Verifalia with the specified {@link AuthenticationProvider}, using the
* specified {@link BaseURIProvider base URIs provider}.
* @param authenticationProvider The {@link AuthenticationProvider} which authenticates to the Verifalia API.
* @param baseURIProvider A {@link BaseURIProvider} instance which overrides the default values provided by the SDK.
*/
public VerifaliaRestClient(@NonNull final AuthenticationProvider authenticationProvider, @NonNull final BaseURIProvider baseURIProvider) {
this(authenticationProvider, baseURIProvider, DEFAULT_API_VERSION);
}
/**
* Initializes a new HTTPS-based REST client for Verifalia with the specified {@link AuthenticationProvider}, using the
* specified {@link BaseURIProvider base URIs provider} and API version.
* @param authenticationProvider The {@link AuthenticationProvider} which authenticates to the Verifalia API.
* @param baseURIProvider A {@link BaseURIProvider} instance which overrides the default values provided by the SDK.
* @param apiVersion The specific API version to use while connecting to the Verifalia API. Warning: this value may
* affect the stability of the SDK itself. If unsure, please just use {@link #VerifaliaRestClient(AuthenticationProvider)}.
*/
public VerifaliaRestClient(@NonNull final AuthenticationProvider authenticationProvider, @NonNull final BaseURIProvider baseURIProvider, @NonNull final String apiVersion) {
List<URI> baseURIs = baseURIProvider.provideBaseURIs();
Collections.shuffle(baseURIs);
cachedRestClient = new RestClient(authenticationProvider, baseURIs, apiVersion);
}
/**
* Allows to submit and manage email validations using the Verifalia service.
*/
public EmailValidationsRestClient getEmailValidations() {
if (emailValidations == null)
emailValidations = new EmailValidationsRestClient(cachedRestClient);
return emailValidations;
}
/**
* Allows to manage the credits for the Verifalia account.
*/
public CreditsRestClient getCredits() {
if (credits == null)
credits = new CreditsRestClient(cachedRestClient);
return credits;
}
}