/*
 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.security.auth;

This class extends NTSid and represents a Windows NT user's primary group SID. 
 Principals such as this NTSidPrimaryGroupPrincipal may be associated with a particular Subject to augment that Subject with an additional identity. Refer to the Subject class for more information on how to achieve this. Authorization decisions can then be based upon the Principals associated with a Subject. 
See Also:
Principal
Subject/**
 * This class extends {@code NTSid}
 * and represents a Windows NT user's primary group SID.
 *
 * <p> Principals such as this {@code NTSidPrimaryGroupPrincipal}
 * may be associated with a particular {@code Subject}
 * to augment that {@code Subject} with an additional
 * identity.  Refer to the {@code Subject} class for more information
 * on how to achieve this.  Authorization decisions can then be based upon
 * the Principals associated with a {@code Subject}.
 *
 * @see java.security.Principal
 * @see javax.security.auth.Subject
 */
public class NTSidPrimaryGroupPrincipal extends NTSid {

    private static final long serialVersionUID = 8011978367305190527L;

    
Create an NTSidPrimaryGroupPrincipal with a Windows NT group SID. 
Params:
name – the primary Windows NT group SID for this user.
Throws:
NullPointerException – if the name is null./**
     * Create an {@code NTSidPrimaryGroupPrincipal} with a Windows NT
     * group SID.
     *
     * @param name the primary Windows NT group SID for this user.
     *
     * @exception NullPointerException if the {@code name}
     *            is {@code null}.
     */
    public NTSidPrimaryGroupPrincipal(String name) {
        super(name);
    }

    
Return a string representation of this NTSidPrimaryGroupPrincipal. 
Returns:
a string representation of this NTSidPrimaryGroupPrincipal./**
     * Return a string representation of this
     * {@code NTSidPrimaryGroupPrincipal}.
     *
     * @return a string representation of this
     *          {@code NTSidPrimaryGroupPrincipal}.
     */
    public String toString() {
        java.text.MessageFormat form = new java.text.MessageFormat
                (sun.security.util.ResourcesMgr.getAuthResourceString
                        ("NTSidPrimaryGroupPrincipal.name"));
        Object[] source = {getName()};
        return form.format(source);
    }

    
Compares the specified Object with this NTSidPrimaryGroupPrincipal for equality. Returns true if the given object is also a NTSidPrimaryGroupPrincipal and the two NTSidPrimaryGroupPrincipals have the same SID. 
Params:
o – Object to be compared for equality with this NTSidPrimaryGroupPrincipal.
Returns:
true if the specified Object is equal to this NTSidPrimaryGroupPrincipal./**
     * Compares the specified Object with this
     * {@code NTSidPrimaryGroupPrincipal}
     * for equality.  Returns true if the given object is also a
     * {@code NTSidPrimaryGroupPrincipal} and the two
     * NTSidPrimaryGroupPrincipals have the same SID.
     *
     * @param o Object to be compared for equality with this
     *          {@code NTSidPrimaryGroupPrincipal}.
     *
     * @return true if the specified Object is equal to this
     *          {@code NTSidPrimaryGroupPrincipal}.
     */
    public boolean equals(Object o) {
            if (o == null)
                return false;

        if (this == o)
            return true;

        if (!(o instanceof NTSidPrimaryGroupPrincipal))
            return false;

        return super.equals(o);
    }

}