This repository was archived by the owner on Feb 26, 2023. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathHttpsClient.java
More file actions
152 lines (142 loc) · 4.33 KB
/
Copy pathHttpsClient.java
File metadata and controls
152 lines (142 loc) · 4.33 KB
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
/**
* Copyright (C) 2010-2016 eBusiness Information, Excilys Group
* Copyright (C) 2016-2020 the AndroidAnnotations project
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed To in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package org.androidannotations.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <p>
* Use this annotation to inject an HttpClient instance with the specified
* KeyStore and TrustStore configured to perform an <b>HTTPS</b> request.
* </p>
* <p>
* All the parameters are optional:
* </p>
* <ul>
* <li><i>trustStore</i>: int, Resource id of your trust store file ex
* <code>R.raw.cacerts.bks</code> Typically your servers trusted certificates
* (public key, Root Chain Authority etc)</li>
*
* <li><i>trustStorePwd</i>: String, Your trust store password (default is
* <code>changeit</code>)</li>
*
* <li><i>keyStore</i>: int, Resource id of your keystore Usually your private
* key (client certificate)</li>
*
* <li><i>keyStorePwd</i>: String, Your KeyStore password (default is
* <code>changeit</code>)</li>
*
* <li><i>allowAllHostnames</i>: boolean, if true, authorizes any TLS/SSL
* hostname (default <code>true</code>) If false, Hostname in certificate (DN)
* must match the URL.</li>
* </ul>
*
* <b>Note</b>:
* <tt>Prior to ICS, Android accepts [Key|Trust]store only in BKS format
* (Bouncycastle Key Store)</tt>
*
* <blockquote>
*
* Example :
*
* <pre>
* @EBean
* public class MyBean {
* @HttpsClient(trustStore = R.raw.cacerts, //
* trustStorePwd = "changeit", //
* keyStore = R.raw.client, //
* keyStorePwd = "secret", //
* allowAllHostnames = false)
* HttpClient httpsClient;
*
* @AfterInject
* @Background
* public void securedRequest() {
* try {
* HttpGet httpget = new HttpGet("https://www.verisign.com/");
* HttpResponse response = httpsClient.execute(httpget);
* doSomethingWithResponse(response);
* } catch (Exception e) {
* e.printStackTrace();
* }
* }
*
* @UiThread
* public void doSomethingWithResponse(HttpResponse resp) {
* Toast.makeText(this, "HTTP status " + resp.getStatusLine().getStatusCode(), Toast.LENGTH_LONG).show();
* }
* }
* </pre>
*
* </blockquote>
*
* @deprecated See
* https://developer.android.com/about/versions/marshmallow/android-6.0-changes.html#behavior-apache-http-client
*/
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
@Deprecated
public @interface HttpsClient {
/**
* The default value of {@link #trustStorePwd()} and {@link #keyStorePwd()}.
*/
String DEFAULT_PASSWD = "changeit";
/**
* The R.id.* field id which refers to the trust store file.
*
* @return the id of the trust store file
*/
int trustStore() default ResId.DEFAULT_VALUE;
/**
* The resource name which refers to the trust store file.
*
* @return the resource name of the trust store file.
*/
String trustStoreResName() default "";
/**
* The trust store password.
*
* @return the trust store password
*/
String trustStorePwd() default DEFAULT_PASSWD;
/**
* The R.id.* field id which refers to the key store file.
*
* @return the id of the key store file
*/
int keyStore() default ResId.DEFAULT_VALUE;
/**
* The resource name which refers to the key store file.
*
* @return the resource name of the key store file
*/
String keyStoreResName() default "";
/**
* The key store password.
*
* @return the key store password
*/
String keyStorePwd() default DEFAULT_PASSWD;
/**
* Whether to authorizes any TLS/SSL hostname.
*
* @return <b>true</b> if authorizes any TLS/SSL hostname, <b>false</b>
* otherwise.
*/
boolean allowAllHostnames() default true;
}