1 /*

     2  * Copyright (c) 1999, 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.security.auth;

    27 

    28 import java.security.Principal;

    29 

    30 /**

    31  * This class implements the {@code Principal} interface

    32  * and represents a Windows NT user.

    33  *

    34  * <p> Principals such as this {@code NTUserPrincipal}

    35  * may be associated with a particular {@code Subject}

    36  * to augment that {@code Subject} with an additional

    37  * identity.  Refer to the {@code Subject} 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}.

    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} with a Windows NT username.

    55      *

    56      * @param name the Windows NT username for this user.

    57      *

    58      * @exception NullPointerException if the {@code name}

    59      *            is {@code null}.

    60      */

    61     public NTUserPrincipal(String name) {

    62         if (name == null) {

    63             java.text.MessageFormat form = new java.text.MessageFormat

    64                 (sun.security.util.ResourcesMgr.getAuthResourceString

    65                         ("invalid.null.input.value"));

    66             Object[] source = {"name"};

    67             throw new NullPointerException(form.format(source));

    68         }

    69         this.name = name;

    70     }

    71 

    72     /**

    73      * Return the Windows NT username for this {@code NTPrincipal}.

    74      *

    75      * @return the Windows NT username for this {@code NTPrincipal}

    76      */

    77     public String getName() {

    78         return name;

    79     }

    80 

    81     /**

    82      * Return a string representation of this {@code NTPrincipal}.

    83      *

    84      * @return a string representation of this {@code NTPrincipal}.

    85      */

    86     public String toString() {

    87         java.text.MessageFormat form = new java.text.MessageFormat

    88                 (sun.security.util.ResourcesMgr.getAuthResourceString

    89                         ("NTUserPrincipal.name"));

    90         Object[] source = {name};

    91         return form.format(source);

    92     }

    93 

    94     /**

    95      * Compares the specified Object with this {@code NTUserPrincipal}

    96      * for equality.  Returns true if the given object is also a

    97      * {@code NTUserPrincipal} and the two NTUserPrincipals

    98      * have the same name.

    99      *

   100      * @param o Object to be compared for equality with this

   101      *          {@code NTPrincipal}.

   102      *

   103      * @return true if the specified Object is equal to this

   104      *          {@code NTPrincipal}.

   105      */

   106     public boolean equals(Object o) {

   107             if (o == null)

   108                 return false;

   109 

   110         if (this == o)

   111             return true;

   112 

   113         if (!(o instanceof NTUserPrincipal))

   114             return false;

   115         NTUserPrincipal that = (NTUserPrincipal)o;

   116 

   117             if (name.equals(that.getName()))

   118                 return true;

   119             return false;

   120     }

   121 

   122     /**

   123      * Return a hash code for this {@code NTUserPrincipal}.

   124      *

   125      * @return a hash code for this {@code NTUserPrincipal}.

   126      */

   127     public int hashCode() {

   128             return this.getName().hashCode();

   129     }

   130 }