Initial Contribution

1 files changed, 147 insertions, 0 deletions

diff --git a/src/org/apache/http/auth/AuthState.java b/src/org/apache/http/auth/AuthState.java
new file mode 100644
index 0000000..f55bf86
--- /dev/null
+++ b/src/org/apache/http/auth/AuthState.java
@@ -0,0 +1,147 @@
+/*
+ * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/auth/AuthState.java $
+ * $Revision: 659971 $
+ * $Date: 2008-05-25 05:01:22 -0700 (Sun, 25 May 2008) $
+ *
+ * ====================================================================
+ *
+ *  Licensed to the Apache Software Foundation (ASF) under one or more
+ *  contributor license agreements.  See the NOTICE file distributed with
+ *  this work for additional information regarding copyright ownership.
+ *  The ASF licenses this file to You 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.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ *
+ */
+
+package org.apache.http.auth;
+
+
+/**
+ * This class provides detailed information about the state of the
+ * authentication process.
+ * 
+ * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
+ *
+ * @since 4.0
+ */
+public class AuthState {
+
+    /** Actual authentication scheme */
+    private AuthScheme authScheme;
+
+    /** Actual authentication scope */
+    private AuthScope authScope;
+    
+    /** Credentials selected for authentication */
+    private Credentials credentials;
+    
+    /**
+     * Default constructor.
+     * 
+     */
+    public AuthState() {
+        super();
+    }
+
+    /**
+     * Invalidates the authentication state by resetting its parameters.
+     */
+    public void invalidate() {
+        this.authScheme = null;
+        this.authScope = null;
+        this.credentials = null;
+    }
+
+    public boolean isValid() {
+        return this.authScheme != null;
+    }
+    
+    /**
+     * Assigns the given {@link AuthScheme authentication scheme}.
+     * 
+     * @param authScheme the {@link AuthScheme authentication scheme}
+     */
+    public void setAuthScheme(final AuthScheme authScheme) {
+        if (authScheme == null) {
+            invalidate();
+            return;
+        }
+        this.authScheme = authScheme;
+    }
+
+    /**
+     * Returns the {@link AuthScheme authentication scheme}.
+     * 
+     * @return {@link AuthScheme authentication scheme}
+     */
+    public AuthScheme getAuthScheme() {
+        return this.authScheme;
+    }
+    
+    
+    /** 
+     * Returns user {@link Credentials} selected for authentication if available
+     * 
+     * @return user credentials if available, <code>null</code otherwise
+     */
+    public Credentials getCredentials() {
+        return this.credentials;
+    }
+
+    
+    /** 
+     * Sets user {@link Credentials} to be used for authentication
+     * 
+     * @param credentials User credentials
+     */
+    public void setCredentials(final Credentials credentials) {
+        this.credentials = credentials;
+    }
+
+
+    /** 
+     * Returns actual {@link AuthScope} if available
+     * 
+     * @return actual authentication scope if available, <code>null</code otherwise
+     */
+     public AuthScope getAuthScope() {
+        return this.authScope;
+     }
+
+     /** 
+      * Sets actual {@link AuthScope}.
+      * 
+      * @param authScope Authentication scope
+      */
+     public void setAuthScope(final AuthScope authScope) {
+        this.authScope = authScope;
+     }
+
+     
+    @Override
+    public String toString() {
+        StringBuilder buffer = new StringBuilder();
+        buffer.append("auth scope [");
+        buffer.append(this.authScope);
+        buffer.append("]; credentials set [");
+        buffer.append(this.credentials != null ? "true" : "false");
+        buffer.append("]");
+        return buffer.toString();
+    }
+    
+}