Glassfish example source code file (WebRoleRefPermission.java)

This example Glassfish source code file (WebRoleRefPermission.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

io, ioexception, ioexception, ioexception,classnotfoundexception, objectstreamfield, objectstreamfield, permission, security, string, string, webrolerefpermission, webrolerefpermission

The Glassfish WebRoleRefPermission.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.security.jacc;

import java.security.*;
import java.io.IOException;
import java.io.ObjectStreamField;

/**
 * Class for Servlet <i>isUserInRole (String reference)
 * permissions. A WebRoleRefPermission is a named permission and has actions.
 * <P>
 * The name of an WebRoleRefPermission (also referred to as the target name)
 * identifies a Web resource by the servlet name (in the deployment 
 * descriptor corresponding to the component from which the call to
 * <i>isUserInRole (String reference) is being made.
 * <P>
 * The actions of an WebRoleRefPermission identifies the role reference to
 * which the permission applies. A WebRoleRefPermission is checked to
 * determine if the subject is a member of the role identified by the
 * reference.
 * <P>
 * Implementations of this class MAY implement newPermissionCollection or
 * inherit its implementation from the super class.
 *
 * @see java.security.Permission
 *
 * @author Ron Monzillo
 * @author Gary Ellison
 */
public final class WebRoleRefPermission extends Permission
implements java.io.Serializable
{

     private final String actions;

     private transient int hashCodeValue = 0;

     private static final long serialVersionUID = 1L;

   /**
    * The serialized fields of this permission are defined below. Whether
    * or not the serialized fields correspond to actual (private) fields 
    * is an implementation decision.
    * @serialField actions String
    * the canonicalized actions string (as returned by getActions).
    */
    private static final ObjectStreamField[] serialPersistentFields = { 
        new ObjectStreamField("actions", java.lang.String.class)
    };

    /**
     * Creates a new WebRoleRefPermission with the specified name and actions.
     * <P>
     * @param name the servlet-name that identifies the application
     * specific web resource in whose context the role references are
     * to be evaluated.
     * <P>
     * @param actions identifies the role reference to which the permission
     * pertains. The role reference is scoped to the Web resource identified
     * in the name parameter. The value of the role reference must not be
     * <code>null or the empty string.
     */

     public WebRoleRefPermission(String name, String actions)
     {	
	 super(name);
	 this.actions = actions;
     }

    /**
     * Checks two WebRoleRefPermission objects for equality.
     * WebRoleRefPermission objects are equivalent if they have case
     * equivalent name and actions values.
     * <P>
     * Two Permission objects, P1 and P2, are equivalent if and only if
     * P1.implies(P2) && P2.implies(P1).
     * <P>
     * The name and actions comparisons described above are case sensitive.
     * <P>
     * @param o the WebRoleRefPermission object being tested for equality
     * with this WebRoleRefPermission.
     * @return true if the argument WebRoleRefPermission object is equivalent
     * to this WebRoleRefPermission.
     */

    public boolean equals(Object o)
    {
	if (o == null ||
	    ! (o instanceof WebRoleRefPermission)) return false;

	WebRoleRefPermission that = (WebRoleRefPermission) o;

	if (!this.getName().equals(that.getName())) return false;
	    
	return this.actions.equals(that.actions);
    }

    /**
     * Returns a canonical String representation of the actions of this
     * WebRoleRefPermission.
     * <P>
     * @return a String containing the canonicalized actions of this
     * WebRoleRefPermission.
     */

    public String getActions()
    {
	return this.actions;
    }

    /**
     * Returns the hash code value for this WebRoleRefPermission. The
     * properties of the returned hash code must be as follows: <p>
     * <ul>
     * <li> During the lifetime of a Java application, the hashCode method
     *      must return the same integer value, every time it is called on a
     *      WebRoleRefPermission object. The value returned by hashCode for a
     *      particular WebRoleRefPermission need not remain consistent from
     *      one execution of an application to another.
     * <li> If two WebRoleRefPermission objects are equal according to the
     *      equals method, then calling the hashCode method on each of the two
     *      Permission objects must produce the same integer result (within an
     *      application).
     * </ul>
     * <P>
     * @return the integer hash code value for this object.
     */
    public int hashCode()
    {

	if (this.hashCodeValue == 0) {
	    
	    String hashInput = this.getName() + " " + this.actions;
	
	    this.hashCodeValue = hashInput.hashCode();
	}

	return this.hashCodeValue;
    }

    /**
     * Determines if the argument Permission is "implied by" this
     * WebRoleRefPermission. For this to be the case, <p>
     * <ul>
     * <li> The argument must be an instanceof WebRoleRefPermission
     * <li> with name equivalent to this WebRoleRefPermission, and
     * <li> with role reference equivalent to this WebRoleRefPermission
     * (as defined in their  actions).
     * </ul>
     * <P>
     * The comparisons described above are case sensitive.
     * <P>
     * @param permission "this" WebRoleRefPermission is checked to see if
     * it implies the argument permission.
     * <P>
     * @return true if the specified permission is implied by this object,
     * false if not.
     */

    public boolean implies(Permission permission)
    {
	return this.equals(permission);
    }

    // ----------------- Private Methods ---------------------

   /**
     * readObject reads the serialized fields from the
     * input stream and uses them to restore the permission. 
     * This method need not be implemented if establishing the 
     * values of the serialized fields (as is done by defaultReadObject) 
     * is sufficient to initialize the permission.
     */
    private synchronized void readObject(java.io.ObjectInputStream s)
         throws IOException,ClassNotFoundException
    {
	s.defaultReadObject();
    }

    /**
     * writeObject is used to establish the values of the serialized fields
     * before they are written to the output stream and need not be
     * implemented if the values of the serialized fields are always 
     * available and up to date. The serialized fields are written to
     * the output stream in the same form as they would be written
     * by defaultWriteObject.
     */
    private synchronized void writeObject(java.io.ObjectOutputStream s)
         throws IOException
    {
	s.defaultWriteObject();
    }

}