1 /* 2 * Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.net.httpserver; 27 import java.net.*; 28 import java.io.*; 29 import java.util.*; 30 import java.security.Principal; 31 32 /** 33 * Represents a user authenticated by HTTP Basic or Digest 34 * authentication. 35 */ 36 public class HttpPrincipal implements Principal { 37 private String username, realm; 38 39 /** 40 * creates a HttpPrincipal from the given username and realm 41 * @param username The name of the user within the realm 42 * @param realm The realm. 43 * @throws NullPointerException if either username or realm are null 44 */ HttpPrincipal(String username, String realm)45 public HttpPrincipal (String username, String realm) { 46 if (username == null || realm == null) { 47 throw new NullPointerException(); 48 } 49 this.username = username; 50 this.realm = realm; 51 } 52 53 /** 54 * Compares two HttpPrincipal. Returns <code>true</code> 55 * if <i>another</i> is an instance of HttpPrincipal, and its 56 * username and realm are equal to this object's username 57 * and realm. Returns <code>false</code> otherwise. 58 */ equals(Object another)59 public boolean equals (Object another) { 60 if (!(another instanceof HttpPrincipal)) { 61 return false; 62 } 63 HttpPrincipal theother = (HttpPrincipal)another; 64 return (username.equals(theother.username) && 65 realm.equals(theother.realm)); 66 } 67 68 /** 69 * returns the contents of this principal in the form 70 * <i>realm:username</i> 71 */ getName()72 public String getName() { 73 return username; 74 } 75 76 /** 77 * returns the username this object was created with. 78 */ getUsername()79 public String getUsername() { 80 return username; 81 } 82 83 /** 84 * returns the realm this object was created with. 85 */ getRealm()86 public String getRealm() { 87 return realm; 88 } 89 90 /** 91 * returns a hashcode for this HttpPrincipal. This is calculated 92 * as <code>(getUsername()+getRealm().hashCode()</code> 93 */ hashCode()94 public int hashCode() { 95 return (username+realm).hashCode(); 96 } 97 98 /** 99 * returns the same string as getName() 100 */ toString()101 public String toString() { 102 return getName(); 103 } 104 } 105