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 primary group SID.

    31  *

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

    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 NTSidPrimaryGroupPrincipal extends NTSid {

    43 

    44     private static final long serialVersionUID = 8011978367305190527L;

    45 

    46     /**

    47      * Create an {@code NTSidPrimaryGroupPrincipal} with a Windows NT

    48      * group SID.

    49      *

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

    51      *

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

    53      *            is {@code null}.

    54      */

    55     public NTSidPrimaryGroupPrincipal(String name) {

    56         super(name);

    57     }

    58 

    59     /**

    60      * Return a string representation of this

    61      * {@code NTSidPrimaryGroupPrincipal}.

    62      *

    63      * @return a string representation of this

    64      *          {@code NTSidPrimaryGroupPrincipal}.

    65      */

    66     public String toString() {

    67         java.text.MessageFormat form = new java.text.MessageFormat

    68                 (sun.security.util.ResourcesMgr.getAuthResourceString

    69                         ("NTSidPrimaryGroupPrincipal.name"));

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

    71         return form.format(source);

    72     }

    73 

    74     /**

    75      * Compares the specified Object with this

    76      * {@code NTSidPrimaryGroupPrincipal}

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

    78      * {@code NTSidPrimaryGroupPrincipal} and the two

    79      * NTSidPrimaryGroupPrincipals have the same SID.

    80      *

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

    82      *          {@code NTSidPrimaryGroupPrincipal}.

    83      *

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

    85      *          {@code NTSidPrimaryGroupPrincipal}.

    86      */

    87     public boolean equals(Object o) {

    88             if (o == null)

    89                 return false;

    90 

    91         if (this == o)

    92             return true;

    93 

    94         if (!(o instanceof NTSidPrimaryGroupPrincipal))

    95             return false;

    96 

    97         return super.equals(o);

    98     }

    99 

   100 }