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 /**
  29  * <p> This class extends <code>NTSid</code>
  30  * and represents one of the groups to which a Windows NT user belongs.
  31  *
  32  * <p> Principals such as this <code>NTSidGroupPrincipal</code>
  33  * may be associated with a particular <code>Subject</code>
  34  * to augment that <code>Subject</code> with an additional
  35  * identity.  Refer to the <code>Subject</code> 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</code>.
  38  *
  39  * @see java.security.Principal
  40  * @see javax.security.auth.Subject
  41  * @see com.sun.security.auth.NTSid
  42  */
  43 @jdk.Supported
  44 public class NTSidGroupPrincipal extends NTSid {
  45 
  46     private static final long serialVersionUID = -1373347438636198229L;
  47 
  48     /**
  49      * Create an <code>NTSidGroupPrincipal</code> with a Windows NT group name.
  50      *
  51      * <p>
  52      *
  53      * @param name the Windows NT group SID for this user. <p>
  54      *
  55      * @exception NullPointerException if the <code>name</code>
  56      *                  is <code>null</code>.
  57      */
  58     public NTSidGroupPrincipal(String name) {
  59         super(name);
  60     }
  61 
  62     /**
  63      * Return a string representation of this <code>NTSidGroupPrincipal</code>.
  64      *
  65      * <p>
  66      *
  67      * @return a string representation of this <code>NTSidGroupPrincipal</code>.
  68      */
  69     public String toString() {
  70         java.text.MessageFormat form = new java.text.MessageFormat
  71                 (sun.security.util.ResourcesMgr.getString
  72                         ("NTSidGroupPrincipal.name",
  73                         "sun.security.util.AuthResources"));
  74         Object[] source = {getName()};
  75         return form.format(source);
  76     }
  77 
  78     /**
  79      * Compares the specified Object with this <code>NTSidGroupPrincipal</code>
  80      * for equality.  Returns true if the given object is also a
  81      * <code>NTSidGroupPrincipal</code> and the two NTSidGroupPrincipals
  82      * have the same SID.
  83      *
  84      * <p>
  85      *
  86      * @param o Object to be compared for equality with this
  87      *          <code>NTSidGroupPrincipal</code>.
  88      *
  89      * @return true if the specified Object is equal equal to this
  90      *          <code>NTSidGroupPrincipal</code>.
  91      */
  92     public boolean equals(Object o) {
  93             if (o == null)
  94                 return false;
  95 
  96         if (this == o)
  97             return true;
  98 
  99         if (!(o instanceof NTSidGroupPrincipal))
 100             return false;
 101 
 102         return super.equals(o);
 103     }
 104 
 105 }