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 java.io.Serializable;
michael@0: import java.security.Principal;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.annotation.Immutable;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.util.LangUtils;
michael@0: 
michael@0: /**
michael@0:  * Basic user principal used for HTTP authentication
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: @Immutable
michael@0: public final class BasicUserPrincipal implements Principal, Serializable {
michael@0: 
michael@0:     private static final long serialVersionUID = -2266305184969850467L;
michael@0: 
michael@0:     private final String username;
michael@0: 
michael@0:     public BasicUserPrincipal(final String username) {
michael@0:         super();
michael@0:         if (username == null) {
michael@0:             throw new IllegalArgumentException("User name may not be null");
michael@0:         }
michael@0:         this.username = username;
michael@0:     }
michael@0: 
michael@0:     public String getName() {
michael@0:         return this.username;
michael@0:     }
michael@0: 
michael@0:     @Override
michael@0:     public int hashCode() {
michael@0:         int hash = LangUtils.HASH_SEED;
michael@0:         hash = LangUtils.hashCode(hash, this.username);
michael@0:         return hash;
michael@0:     }
michael@0: 
michael@0:     @Override
michael@0:     public boolean equals(Object o) {
michael@0:         if (this == o) return true;
michael@0:         if (o instanceof BasicUserPrincipal) {
michael@0:             BasicUserPrincipal that = (BasicUserPrincipal) o;
michael@0:             if (LangUtils.equals(this.username, that.username)) {
michael@0:                 return true;
michael@0:             }
michael@0:         }
michael@0:         return false;
michael@0:     }
michael@0: 
michael@0:     @Override
michael@0:     public String toString() {
michael@0:         StringBuilder buffer = new StringBuilder();
michael@0:         buffer.append("[principal: ");
michael@0:         buffer.append(this.username);
michael@0:         buffer.append("]");
michael@0:         return buffer.toString();
michael@0:     }
michael@0: 
michael@0: }
michael@0: