1 /*
   2  * Copyright (c) 1999, 2010, 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.security.auth;
  27 
  28 import java.security.Principal;
  29 
  30 /**
  31  * <p> This class implements the <code>Principal</code> interface
  32  * and represents a Windows NT user.
  33  *
  34  * <p> Principals such as this <code>NTUserPrincipal</code>
  35  * may be associated with a particular <code>Subject</code>
  36  * to augment that <code>Subject</code> with an additional
  37  * identity.  Refer to the <code>Subject</code> class for more information
  38  * on how to achieve this.  Authorization decisions can then be based upon
  39  * the Principals associated with a <code>Subject</code>.
  40  *
  41  * @see java.security.Principal
  42  * @see javax.security.auth.Subject
  43  */
  44 public class NTUserPrincipal implements Principal, java.io.Serializable {
  45 
  46     private static final long serialVersionUID = -8737649811939033735L;
  47 
  48     /**
  49      * @serial
  50      */
  51     private String name;
  52 
  53     /**
  54      * Create an <code>NTUserPrincipal</code> with a Windows NT username.
  55      *
  56      * <p>
  57      *
  58      * @param name the Windows NT username for this user. <p>
  59      *
  60      * @exception NullPointerException if the <code>name</code>
  61      *            is <code>null</code>.
  62      */
  63     public NTUserPrincipal(String name) {
  64         if (name == null) {
  65             java.text.MessageFormat form = new java.text.MessageFormat
  66                 (sun.security.util.ResourcesMgr.getString
  67                         ("invalid.null.input.value",
  68                         "sun.security.util.AuthResources"));
  69             Object[] source = {"name"};
  70             throw new NullPointerException(form.format(source));
  71         }
  72         this.name = name;
  73     }
  74 
  75     /**
  76      * Return the Windows NT username for this <code>NTPrincipal</code>.
  77      *
  78      * <p>
  79      *
  80      * @return the Windows NT username for this <code>NTPrincipal</code>
  81      */
  82     public String getName() {
  83         return name;
  84     }
  85 
  86     /**
  87      * Return a string representation of this <code>NTPrincipal</code>.
  88      *
  89      * <p>
  90      *
  91      * @return a string representation of this <code>NTPrincipal</code>.
  92      */
  93     public String toString() {
  94         java.text.MessageFormat form = new java.text.MessageFormat
  95                 (sun.security.util.ResourcesMgr.getString
  96                         ("NTUserPrincipal.name",
  97                         "sun.security.util.AuthResources"));
  98         Object[] source = {name};
  99         return form.format(source);
 100     }
 101 
 102     /**
 103      * Compares the specified Object with this <code>NTUserPrincipal</code>
 104      * for equality.  Returns true if the given object is also a
 105      * <code>NTUserPrincipal</code> and the two NTUserPrincipals
 106      * have the same name.
 107      *
 108      * <p>
 109      *
 110      * @param o Object to be compared for equality with this
 111      *          <code>NTPrincipal</code>.
 112      *
 113      * @return true if the specified Object is equal equal to this
 114      *          <code>NTPrincipal</code>.
 115      */
 116     public boolean equals(Object o) {
 117             if (o == null)
 118                 return false;
 119 
 120         if (this == o)
 121             return true;
 122 
 123         if (!(o instanceof NTUserPrincipal))
 124             return false;
 125         NTUserPrincipal that = (NTUserPrincipal)o;
 126 
 127             if (name.equals(that.getName()))
 128                 return true;
 129             return false;
 130     }
 131 
 132     /**
 133      * Return a hash code for this <code>NTUserPrincipal</code>.
 134      *
 135      * <p>
 136      *
 137      * @return a hash code for this <code>NTUserPrincipal</code>.
 138      */
 139     public int hashCode() {
 140             return this.getName().hashCode();
 141     }
 142 }