michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.auth;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.NotThreadSafe;
michael@0: 
michael@0: 
michael@0: /**
michael@0:  * This class provides detailed information about the state of the
michael@0:  * authentication process.
michael@0:  *
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @NotThreadSafe
michael@0: public class AuthState {
michael@0: 
michael@0:     /** Actual authentication scheme */
michael@0:     private AuthScheme authScheme;
michael@0: 
michael@0:     /** Actual authentication scope */
michael@0:     private AuthScope authScope;
michael@0: 
michael@0:     /** Credentials selected for authentication */
michael@0:     private Credentials credentials;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor.
michael@0:      *
michael@0:      */
michael@0:     public AuthState() {
michael@0:         super();
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Invalidates the authentication state by resetting its parameters.
michael@0:      */
michael@0:     public void invalidate() {
michael@0:         this.authScheme = null;
michael@0:         this.authScope = null;
michael@0:         this.credentials = null;
michael@0:     }
michael@0: 
michael@0:     public boolean isValid() {
michael@0:         return this.authScheme != null;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Assigns the given {@link AuthScheme authentication scheme}.
michael@0:      *
michael@0:      * @param authScheme the {@link AuthScheme authentication scheme}
michael@0:      */
michael@0:     public void setAuthScheme(final AuthScheme authScheme) {
michael@0:         if (authScheme == null) {
michael@0:             invalidate();
michael@0:             return;
michael@0:         }
michael@0:         this.authScheme = authScheme;
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * Returns the {@link AuthScheme authentication scheme}.
michael@0:      *
michael@0:      * @return {@link AuthScheme authentication scheme}
michael@0:      */
michael@0:     public AuthScheme getAuthScheme() {
michael@0:         return this.authScheme;
michael@0:     }
michael@0: 
michael@0: 
michael@0:     /**
michael@0:      * Returns user {@link Credentials} selected for authentication if available
michael@0:      *
michael@0:      * @return user credentials if available, <code>null</code otherwise
michael@0:      */
michael@0:     public Credentials getCredentials() {
michael@0:         return this.credentials;
michael@0:     }
michael@0: 
michael@0: 
michael@0:     /**
michael@0:      * Sets user {@link Credentials} to be used for authentication
michael@0:      *
michael@0:      * @param credentials User credentials
michael@0:      */
michael@0:     public void setCredentials(final Credentials credentials) {
michael@0:         this.credentials = credentials;
michael@0:     }
michael@0: 
michael@0: 
michael@0:     /**
michael@0:      * Returns actual {@link AuthScope} if available
michael@0:      *
michael@0:      * @return actual authentication scope if available, <code>null</code otherwise
michael@0:      */
michael@0:      public AuthScope getAuthScope() {
michael@0:         return this.authScope;
michael@0:      }
michael@0: 
michael@0:      /**
michael@0:       * Sets actual {@link AuthScope}.
michael@0:       *
michael@0:       * @param authScope Authentication scope
michael@0:       */
michael@0:      public void setAuthScope(final AuthScope authScope) {
michael@0:         this.authScope = authScope;
michael@0:      }
michael@0: 
michael@0: 
michael@0:     @Override
michael@0:     public String toString() {
michael@0:         StringBuilder buffer = new StringBuilder();
michael@0:         buffer.append("auth scope [");
michael@0:         buffer.append(this.authScope);
michael@0:         buffer.append("]; credentials set [");
michael@0:         buffer.append(this.credentials != null ? "true" : "false");
michael@0:         buffer.append("]");
michael@0:         return buffer.toString();
michael@0:     }
michael@0: 
michael@0: }