• file
• revisions
• annotate
• diff
• comparison
• raw

mobile/android/thirdparty/ch/boye/httpclientandroidlib/auth/AuthState.java@6474c204b198 (annotated)

mobile/android/thirdparty/ch/boye/httpclientandroidlib/auth/AuthState.java

Wed, 31 Dec 2014 06:09:35 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Wed, 31 Dec 2014 06:09:35 +0100

changeset 0

6474c204b198

permissions

-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

michael@0	1	/*
michael@0	2	* ====================================================================
michael@0	3	*
michael@0	4	* Licensed to the Apache Software Foundation (ASF) under one or more
michael@0	5	* contributor license agreements. See the NOTICE file distributed with
michael@0	6	* this work for additional information regarding copyright ownership.
michael@0	7	* The ASF licenses this file to You under the Apache License, Version 2.0
michael@0	8	* (the "License"); you may not use this file except in compliance with
michael@0	9	* the License. You may obtain a copy of the License at
michael@0	10	*
michael@0	11	* http://www.apache.org/licenses/LICENSE-2.0
michael@0	12	*
michael@0	13	* Unless required by applicable law or agreed to in writing, software
michael@0	14	* distributed under the License is distributed on an "AS IS" BASIS,
michael@0	15	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0	16	* See the License for the specific language governing permissions and
michael@0	17	* limitations under the License.
michael@0	18	* ====================================================================
michael@0	19	*
michael@0	20	* This software consists of voluntary contributions made by many
michael@0	21	* individuals on behalf of the Apache Software Foundation. For more
michael@0	22	* information on the Apache Software Foundation, please see
michael@0	23	* <http://www.apache.org/>.
michael@0	24	*
michael@0	25	*/
michael@0	26
michael@0	27	package ch.boye.httpclientandroidlib.auth;
michael@0	28
michael@0	29	import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
michael@0	30
michael@0	31
michael@0	32	/**
michael@0	33	* This class provides detailed information about the state of the
michael@0	34	* authentication process.
michael@0	35	*
michael@0	36	*
michael@0	37	* @since 4.0
michael@0	38	*/
michael@0	39	@NotThreadSafe
michael@0	40	public class AuthState {
michael@0	41
michael@0	42	/** Actual authentication scheme */
michael@0	43	private AuthScheme authScheme;
michael@0	44
michael@0	45	/** Actual authentication scope */
michael@0	46	private AuthScope authScope;
michael@0	47
michael@0	48	/** Credentials selected for authentication */
michael@0	49	private Credentials credentials;
michael@0	50
michael@0	51	/**
michael@0	52	* Default constructor.
michael@0	53	*
michael@0	54	*/
michael@0	55	public AuthState() {
michael@0	56	super();
michael@0	57	}
michael@0	58
michael@0	59	/**
michael@0	60	* Invalidates the authentication state by resetting its parameters.
michael@0	61	*/
michael@0	62	public void invalidate() {
michael@0	63	this.authScheme = null;
michael@0	64	this.authScope = null;
michael@0	65	this.credentials = null;
michael@0	66	}
michael@0	67
michael@0	68	public boolean isValid() {
michael@0	69	return this.authScheme != null;
michael@0	70	}
michael@0	71
michael@0	72	/**
michael@0	73	* Assigns the given {@link AuthScheme authentication scheme}.
michael@0	74	*
michael@0	75	* @param authScheme the {@link AuthScheme authentication scheme}
michael@0	76	*/
michael@0	77	public void setAuthScheme(final AuthScheme authScheme) {
michael@0	78	if (authScheme == null) {
michael@0	79	invalidate();
michael@0	80	return;
michael@0	81	}
michael@0	82	this.authScheme = authScheme;
michael@0	83	}
michael@0	84
michael@0	85	/**
michael@0	86	* Returns the {@link AuthScheme authentication scheme}.
michael@0	87	*
michael@0	88	* @return {@link AuthScheme authentication scheme}
michael@0	89	*/
michael@0	90	public AuthScheme getAuthScheme() {
michael@0	91	return this.authScheme;
michael@0	92	}
michael@0	93
michael@0	94
michael@0	95	/**
michael@0	96	* Returns user {@link Credentials} selected for authentication if available
michael@0	97	*
michael@0	98	* @return user credentials if available, <code>null</code otherwise
michael@0	99	*/
michael@0	100	public Credentials getCredentials() {
michael@0	101	return this.credentials;
michael@0	102	}
michael@0	103
michael@0	104
michael@0	105	/**
michael@0	106	* Sets user {@link Credentials} to be used for authentication
michael@0	107	*
michael@0	108	* @param credentials User credentials
michael@0	109	*/
michael@0	110	public void setCredentials(final Credentials credentials) {
michael@0	111	this.credentials = credentials;
michael@0	112	}
michael@0	113
michael@0	114
michael@0	115	/**
michael@0	116	* Returns actual {@link AuthScope} if available
michael@0	117	*
michael@0	118	* @return actual authentication scope if available, <code>null</code otherwise
michael@0	119	*/
michael@0	120	public AuthScope getAuthScope() {
michael@0	121	return this.authScope;
michael@0	122	}
michael@0	123
michael@0	124	/**
michael@0	125	* Sets actual {@link AuthScope}.
michael@0	126	*
michael@0	127	* @param authScope Authentication scope
michael@0	128	*/
michael@0	129	public void setAuthScope(final AuthScope authScope) {
michael@0	130	this.authScope = authScope;
michael@0	131	}
michael@0	132
michael@0	133
michael@0	134	@Override
michael@0	135	public String toString() {
michael@0	136	StringBuilder buffer = new StringBuilder();
michael@0	137	buffer.append("auth scope [");
michael@0	138	buffer.append(this.authScope);
michael@0	139	buffer.append("]; credentials set [");
michael@0	140	buffer.append(this.credentials != null ? "true" : "false");
michael@0	141	buffer.append("]");
michael@0	142	return buffer.toString();
michael@0	143	}
michael@0	144
michael@0	145	}