javax.security.auth

Class PrivateCredentialPermission

Implemented Interfaces:
Guard, Serializable

public final class PrivateCredentialPermission
extends Permission
implements Serializable

A permission governing access to a private credential. The action of this permission is always "read" -- meaning that the private credential information can be read from an object.

The target of this permission is formatted as follows:

CredentialClassName ( PrinicpalClassName PrincipalName )*

CredentialClassName is either the name of a private credential class name, or a wildcard character ('*'). PrinicpalClassName is the class name of a principal object, and PrincipalName is a string representing the principal, or the wildcard character.

See Also:
Serialized Form

Constructor Summary

PrivateCredentialPermission(String name, String actions)
Create a new private credential permission.

Method Summary

boolean
equals(Object o)
String
getActions()
Returns the actions this permission encompasses.
String
getCredentialClass()
Returns the credential class name that was embedded in this permission's target name.
String[][]
getPrincipals()
Returns the principal list that was embedded in this permission's target name.
int
hashCode()
boolean
implies(Permission p)
Test if this permission implies another.
PermissionCollection
newPermissionCollection()
This method is not necessary for this class, thus it always returns null.

Methods inherited from class java.security.Permission

checkGuard, equals, getActions, getName, hashCode, implies, newPermissionCollection, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrivateCredentialPermission

public PrivateCredentialPermission(String name,
                                   String actions)
Create a new private credential permission.
Parameters:
name - The permission target name.
actions - The list of actions, which, for this class, must be "read".

Method Details

equals

public boolean equals(Object o)
Overrides:
equals in interface Permission

getActions

public String getActions()
Returns the actions this permission encompasses. For private credential permissions, this is always the string "read".
Overrides:
getActions in interface Permission
Returns:
The list of actions.

getCredentialClass

public String getCredentialClass()
Returns the credential class name that was embedded in this permission's target name.
Returns:
The credential class name.

getPrincipals

public String[][] getPrincipals()
Returns the principal list that was embedded in this permission's target name.

Each element of the returned array is a pair; the first element is the principal class name, and the second is the principal name.

Returns:
The principal list.

hashCode

public int hashCode()
Overrides:
hashCode in interface Permission

implies

public boolean implies(Permission p)
Test if this permission implies another. This method returns true if:
  1. p is an instance of PrivateCredentialPermission
  2. The credential class name of this instance matches that of p, and one of the principals of p is contained in the principals of this class. Thus,
    • [ * P "foo" ] implies [ C P "foo" ]
    • [ C P1 "foo" ] implies [ C P1 "foo" P2 "bar" ]
    • [ C P1 "*" ] implies [ C P1 "foo" ]
    Overrides:
    implies in interface Permission
    Parameters:
    p - The permission to check.
    Returns:
    True if this permission implies p.

    newPermissionCollection

    public PermissionCollection newPermissionCollection()
    This method is not necessary for this class, thus it always returns null.
    Overrides:
    newPermissionCollection in interface Permission
    Returns:
    null.

    PrivateCredentialPermission.java -- permissions governing private credentials. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath 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 for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.