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