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 one of the groups to which a Windows NT user belongs.

    31  *

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

    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  * @see com.sun.security.auth.NTSid

    42  */

    43 public class NTSidGroupPrincipal extends NTSid {

    44 

    45     private static final long serialVersionUID = -1373347438636198229L;

    46 

    47     /**

    48      * Create an {@code NTSidGroupPrincipal} with a Windows NT group name.

    49      *

    50      * @param name the Windows NT group SID for this user.

    51      *

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

    53      *                  is {@code null}.

    54      */

    55     public NTSidGroupPrincipal(String name) {

    56         super(name);

    57     }

    58 

    59     /**

    60      * Return a string representation of this {@code NTSidGroupPrincipal}.

    61      *

    62      * @return a string representation of this {@code NTSidGroupPrincipal}.

    63      */

    64     public String toString() {

    65         java.text.MessageFormat form = new java.text.MessageFormat

    66                 (sun.security.util.ResourcesMgr.getAuthResourceString

    67                         ("NTSidGroupPrincipal.name"));

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

    69         return form.format(source);

    70     }

    71 

    72     /**

    73      * Compares the specified Object with this {@code NTSidGroupPrincipal}

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

    75      * {@code NTSidGroupPrincipal} and the two NTSidGroupPrincipals

    76      * have the same SID.

    77      *

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

    79      *          {@code NTSidGroupPrincipal}.

    80      *

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

    82      *          {@code NTSidGroupPrincipal}.

    83      */

    84     public boolean equals(Object o) {

    85             if (o == null)

    86                 return false;

    87 

    88         if (this == o)

    89             return true;

    90 

    91         if (!(o instanceof NTSidGroupPrincipal))

    92             return false;

    93 

    94         return super.equals(o);

    95     }

    96 

    97 }