001/* 002 * ==================================================================== 003 * Licensed to the Apache Software Foundation (ASF) under one 004 * or more contributor license agreements. See the NOTICE file 005 * distributed with this work for additional information 006 * regarding copyright ownership. The ASF licenses this file 007 * to you under the Apache License, Version 2.0 (the 008 * "License"); you may not use this file except in compliance 009 * with the License. You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, 014 * software distributed under the License is distributed on an 015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 016 * KIND, either express or implied. See the License for the 017 * specific language governing permissions and limitations 018 * under the License. 019 * ==================================================================== 020 * 021 * This software consists of voluntary contributions made by many 022 * individuals on behalf of the Apache Software Foundation. For more 023 * information on the Apache Software Foundation, please see 024 * <http://www.apache.org/>. 025 * 026 */ 027package org.apache.http.auth; 028 029import java.io.Serializable; 030import java.security.Principal; 031 032import org.apache.http.annotation.Contract; 033import org.apache.http.annotation.ThreadingBehavior; 034import org.apache.http.util.Args; 035import org.apache.http.util.LangUtils; 036 037/** 038 * Basic user principal used for HTTP authentication 039 * 040 * @since 4.0 041 */ 042@Contract(threading = ThreadingBehavior.IMMUTABLE) 043public final class BasicUserPrincipal implements Principal, Serializable { 044 045 private static final long serialVersionUID = -2266305184969850467L; 046 047 private final String username; 048 049 public BasicUserPrincipal(final String username) { 050 super(); 051 Args.notNull(username, "User name"); 052 this.username = username; 053 } 054 055 @Override 056 public String getName() { 057 return this.username; 058 } 059 060 @Override 061 public int hashCode() { 062 int hash = LangUtils.HASH_SEED; 063 hash = LangUtils.hashCode(hash, this.username); 064 return hash; 065 } 066 067 @Override 068 public boolean equals(final Object o) { 069 if (this == o) { 070 return true; 071 } 072 if (o instanceof BasicUserPrincipal) { 073 final BasicUserPrincipal that = (BasicUserPrincipal) o; 074 if (LangUtils.equals(this.username, that.username)) { 075 return true; 076 } 077 } 078 return false; 079 } 080 081 @Override 082 public String toString() { 083 final StringBuilder buffer = new StringBuilder(); 084 buffer.append("[principal: "); 085 buffer.append(this.username); 086 buffer.append("]"); 087 return buffer.toString(); 088 } 089 090} 091