org.androidannotations.annotations.HttpsClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of androidannotations-api Show documentation
The API jar containing the annotations and the runtime helpers
The newest version!
/**
 * 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;

/**
 * 
 * Use this annotation to inject an HttpClient instance with the specified
 * KeyStore and TrustStore configured to perform an HTTPS request.
 * 
 * 
 * All the parameters are optional:
 * 
 * 
 * trustStore: int, Resource id of your trust store file ex
 * R.raw.cacerts.bks Typically your servers trusted certificates
 * (public key, Root Chain Authority etc)
 * 
 * trustStorePwd: String, Your trust store password (default is
 * changeit)
 * 
 * keyStore: int, Resource id of your keystore Usually your private
 * key (client certificate)
 * 
 * keyStorePwd: String, Your KeyStore password (default is
 * changeit)
 * 
 * allowAllHostnames: boolean, if true, authorizes any TLS/SSL
 * hostname (default true) If false, Hostname in certificate (DN)
 * must match the URL.
 * 
 * 
 * Note:
 * Prior to ICS, Android accepts [Key|Trust]store only in BKS format
 * (Bouncycastle Key Store)
 * 
 * 
 * 
 * Example :
 * 
 *  * @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();
 * 	}
 * }
 * 
 * 
 * 
 *
 * @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 true if authorizes any TLS/SSL hostname, false
	 *         otherwise.
	 */
	boolean allowAllHostnames() default true;
}