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 /**

    29  * This class extends {@code NTSid}

    30  * and represents a Windows NT user's SID.

    31  *

    32  * <p> Principals such as this {@code NTSidUserPrincipal}

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

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

    35  * identity.  Refer to the {@code Subject} class for more information

    36  * on how to achieve this.  Authorization decisions can then be based upon

    37  * the Principals associated with a {@code Subject}.

    38  *

    39  * @see java.security.Principal

    40  * @see javax.security.auth.Subject

    41  */

    42 public class NTSidUserPrincipal extends NTSid {

    43 

    44     private static final long serialVersionUID = -5573239889517749525L;

    45 

    46     /**

    47      * Create an {@code NTSidUserPrincipal} with a Windows NT SID.

    48      *

    49      * @param name a string version of the Windows NT SID for this user.

    50      *

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

    52      *                  is {@code null}.

    53      */

    54     public NTSidUserPrincipal(String name) {

    55         super(name);

    56     }

    57 

    58     /**

    59      * Return a string representation of this {@code NTSidUserPrincipal}.

    60      *

    61      * @return a string representation of this {@code NTSidUserPrincipal}.

    62      */

    63     public String toString() {

    64         java.text.MessageFormat form = new java.text.MessageFormat

    65                 (sun.security.util.ResourcesMgr.getAuthResourceString

    66                         ("NTSidUserPrincipal.name"));

    67         Object[] source = {getName()};

    68         return form.format(source);

    69     }

    70 

    71     /**

    72      * Compares the specified Object with this {@code NTSidUserPrincipal}

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

    74      * {@code NTSidUserPrincipal} and the two NTSidUserPrincipals

    75      * have the same SID.

    76      *

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

    78      *          {@code NTSidUserPrincipal}.

    79      *

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

    81      *          {@code NTSidUserPrincipal}.

    82      */

    83     public boolean equals(Object o) {

    84             if (o == null)

    85                 return false;

    86 

    87         if (this == o)

    88             return true;

    89 

    90         if (!(o instanceof NTSidUserPrincipal))

    91             return false;

    92 

    93         return super.equals(o);

    94     }

    95 }