/*
 * 
 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * The contents of this file are subject to the Sun Community Source
 * License v3.0/Jini Technology Specific Attachment v 1.0 (the
 * "License"). You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 * http://wwws.sun.com/software/jini/licensing/SCSL3_JiniTSA1.html.
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Reference Code is Jini Technology Core Platform code, v2.0. The
 * Developer of the Reference Code is Sun Microsystems, Inc.
 * 
 * Contributor(s): Sun Microsystems, Inc.
 * 
 * The contents of this file comply with the Jini Technology Core
 * Platform Compatibility Kit, v2.0A.
 * 
 * Tester(s): Sun Microsystems, Inc.
 * 
 * Test Platform(s):
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Solaris(TM)SPARC/x86
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Linux (Intel x86)
 * Java 2 SDK, Standard Edition, Version 1.4.2_03 for Windows (Intel Platform)
 * 
 */

package net.jini.security.policy;

import java.security.Permission;

/**
 * Permission that is specially intepreted by {@link PolicyFileProvider} as
 * shorthand for a {@link net.jini.security.GrantPermission}
 * covering all permissions authorized to a given protection domain.  For each
 * protection domain authorized with a set of permissions <code>ps</code> that
 * includes an <code>UmbrellaGrantPermission</code>,
 * <code>PolicyFileProvider</code> adds to <code>ps</code> a
 * <code>GrantPermission</code> for all permissions in <code>ps</code>.  All
 * <code>UmbrellaGrantPermission</code> instances are equivalent, and have
 * target names and action strings that are the empty string.
 *
 * @author Sun Microsystems, Inc.
 * 
 * @since 2.0
 */
public final class UmbrellaGrantPermission extends Permission {

    private static final long serialVersionUID = -969939904144051917L;

    /**
     * Creates a new <code>UmbrellaGrantPermission</code>.
     */
    public UmbrellaGrantPermission() {
	super("");
    }

    // documentation inherited from Permission.getActions
    public String getActions() {
	return "";
    }

    // documentation inherited from Permission.implies
    public boolean implies(Permission permission) {
	return permission instanceof UmbrellaGrantPermission;
    }

    // documentation inherited from Permission.equals
    public boolean equals(Object obj) {
	return obj instanceof UmbrellaGrantPermission;
    }

    // documentation inherited from Permission.hashCode
    public int hashCode() {
	return UmbrellaGrantPermission.class.hashCode();
    }

    // REMIND: include readObject method verifying target name is empty?
}
