This class is used to protect access to private Credentials belonging to a particular Subject. The Subject is represented by a Set of Principals.

The target name of this Permission specifies a Credential class name, and a Set of Principals. The only valid value for this Permission's actions is, "read". The target name must abide by the following syntax:

     CredentialClass {PrincipalClass "PrincipalName"}*

For example, the following permission grants access to the com.sun.PrivateCredential owned by Subjects which have a com.sun.Principal with the name, "duke". Note that although this example, as well as all the examples below, do not contain Codebase, SignedBy, or Principal information in the grant statement (for simplicity reasons), actual policy configurations should specify that information when appropriate.


   grant {
     permission javax.security.auth.PrivateCredentialPermission
             "com.sun.PrivateCredential com.sun.Principal \"duke\"",
             "read";
   };

If CredentialClass is "*", then access is granted to all private Credentials belonging to the specified Subject. If "PrincipalName" is "*", then access is granted to the specified Credential owned by any Subject that has the specified Principal (the actual PrincipalName doesn't matter). For example, the following grants access to the a.b.Credential owned by any Subject that has an a.b.Principal.

   grant {
     permission javax.security.auth.PrivateCredentialPermission
             "a.b.Credential a.b.Principal "*"",
             "read";
   };

If both the PrincipalClass and "PrincipalName" are "*", then access is granted to the specified Credential owned by any Subject.

In addition, the PrincipalClass/PrincipalName pairing may be repeated:

   grant {
     permission javax.security.auth.PrivateCredentialPermission
             "a.b.Credential a.b.Principal "duke" c.d.Principal "dukette"",
             "read";
   };

The above grants access to the private Credential, "a.b.Credential", belonging to a Subject with at least two associated Principals: "a.b.Principal" with the name, "duke", and "c.d.Principal", with the name, "dukette".

Modifier and Type	Class and Description
pack-priv static class	PrivateCredentialPermission.CredOwner

Field Summary

Modifier and Type	Field and Description
private String	credentialClass
private transient PrivateCredentialPermission.CredOwner[]	credOwners
private static final PrivateCredentialPermission.CredOwner[]	EMPTY_PRINCIPALS
private Set<Principal>	principals
private static final long	serialVersionUID Hides java.security.Permission.serialVersionUID.

Constructor Summary

Access	Constructor and Description
pack-priv	PrivateCredentialPermission(String credentialClass, Set<Principal> principals) Create a new `PrivateCredentialPermission` with the specified `credentialClass` and Principals.
public	PrivateCredentialPermission(String the name specifying the Credential class and `Principal` Set. name, String the actions specifying that the Credential can be read. actions) Creates a new `PrivateCredentialPermission` with the specified `name`.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if obj is a `PrivateCredentialPermission`, has the same credential class as this object, and has the same Principals as this object. equals(Object the object we are testing for equality with this object. obj) Implements abstract java.security.Permission.equals. Checks two `PrivateCredentialPermission` objects for equality.
public String	Returns: the actions (always returns "read"). getActions() Implements abstract java.security.Permission.getActions. Returns the "canonical string representation" of the actions.
public String	Returns: the Class name of the Credential associated with this `PrivateCredentialPermission`. getCredentialClass() Returns the Class name of the Credential associated with this `PrivateCredentialPermission`.
public String[][]	Returns: the `Principal` class and names associated with this `PrivateCredentialPermission`. getPrincipals() Returns the `Principal` classes and names associated with this `PrivateCredentialPermission`.
public int	Returns: the hash code value for this object hashCode() Implements abstract java.security.Permission.hashCode. Returns the hash code value for this object.
public boolean	Returns: true if this `PrivateCredentialPermission` implies the specified `Permission`, false if not. implies(Permission the `Permission` to check against. p) Implements abstract java.security.Permission.implies. Checks if this `PrivateCredentialPermission` implies the specified `Permission`.
private boolean	impliesCredentialClass(String thisC, String thatC)
private boolean	impliesPrincipalSet(PrivateCredentialPermission.CredOwner[] thisP, PrivateCredentialPermission.CredOwner[] thatP)
private void	init(String name)
public PermissionCollection	Returns: null in all cases. newPermissionCollection() Overrides java.security.Permission.newPermissionCollection. Return a homogeneous collection of PrivateCredentialPermissions in a `PermissionCollection`.
private void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read s) Reads this object from a stream (i.e., deserializes it)

Inherited from java.security.Permission:: checkGuard getName toString

Field Detail

credentialClass	back to summary
private String credentialClass

credOwners	back to summary
private transient PrivateCredentialPermission.CredOwner[] credOwners

EMPTY_PRINCIPALS	back to summary
private static final PrivateCredentialPermission.CredOwner[] EMPTY_PRINCIPALS

principals	back to summary
private Set<Principal> principals Annotations @SuppressWarnings:serial

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.Permission.serialVersionUID. Annotations @Serial

Constructor Detail

PrivateCredentialPermission	back to summary
pack-priv PrivateCredentialPermission(String credentialClass, Set<Principal> principals) Create a new `PrivateCredentialPermission` with the specified `credentialClass` and Principals.

PrivateCredentialPermission back to summary

PrivateCredentialPermission	back to summary
public PrivateCredentialPermission(String name, String actions) Creates a new `PrivateCredentialPermission` with the specified `name`. The `name` specifies both a Credential class and a `Principal` Set. Parameters name:String the name specifying the Credential class and `Principal` Set. actions:String the actions specifying that the Credential can be read. Exceptions IllegalArgumentException: if `name` does not conform to the correct syntax or if `actions` is not "read".

public PrivateCredentialPermission(String name, String actions)

Creates a new PrivateCredentialPermission with the specified name. The name specifies both a Credential class and a Principal Set.

Parameters

name:String: the name specifying the Credential class and Principal Set.
actions:String: the actions specifying that the Credential can be read.

Exceptions

IllegalArgumentException:: if name does not conform to the correct syntax or if actions is not "read".

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Implements abstract java.security.Permission.equals. Checks two `PrivateCredentialPermission` objects for equality. Checks that `obj` is a `PrivateCredentialPermission`, and has the same credential class as this object, as well as the same Principals as this object. The order of the Principals in the respective Permission's target names is not relevant. Parameters obj:Object the object we are testing for equality with this object. Returns:boolean true if obj is a `PrivateCredentialPermission`, has the same credential class as this object, and has the same Principals as this object. Annotations @Override

public boolean equals(Object obj)

Implements abstract java.security.Permission.equals.

Checks two PrivateCredentialPermission objects for equality. Checks that obj is a PrivateCredentialPermission, and has the same credential class as this object, as well as the same Principals as this object. The order of the Principals in the respective Permission's target names is not relevant.

Parameters

obj:Object: the object we are testing for equality with this object.

Returns:boolean

true if obj is a PrivateCredentialPermission, has the same credential class as this object, and has the same Principals as this object.

Annotations

@Override

getActions	back to summary
public String getActions() Implements abstract java.security.Permission.getActions. Returns the "canonical string representation" of the actions. This method always returns the String, "read". Returns:String the actions (always returns "read").

getActions

back to summary

public String getActions()

Implements abstract java.security.Permission.getActions.

Returns the "canonical string representation" of the actions. This method always returns the String, "read".

Returns:String: the actions (always returns "read").

getCredentialClass back to summary

getCredentialClass	back to summary
public String getCredentialClass() Returns the Class name of the Credential associated with this `PrivateCredentialPermission`. Returns:String the Class name of the Credential associated with this `PrivateCredentialPermission`.

public String getCredentialClass()

Returns the Class name of the Credential associated with this PrivateCredentialPermission.

Returns:String: the Class name of the Credential associated with this PrivateCredentialPermission.

getPrincipals back to summary

getPrincipals	back to summary
public String[][] getPrincipals() Returns the `Principal` classes and names associated with this `PrivateCredentialPermission`. The information is returned as a two-dimensional array (array[x][y]). The 'x' value corresponds to the number of `Principal` class and name pairs. When (y==0), it corresponds to the `Principal` class value, and when (y==1), it corresponds to the `Principal` name value. For example, array[0][0] corresponds to the class name of the first `Principal` in the array. array[0][1] corresponds to the `Principal` name of the first `Principal` in the array. Returns:String[][] the `Principal` class and names associated with this `PrivateCredentialPermission`.

public String[][] getPrincipals()

Returns the Principal classes and names associated with this PrivateCredentialPermission. The information is returned as a two-dimensional array (array[x][y]). The 'x' value corresponds to the number of Principal class and name pairs. When (y==0), it corresponds to the Principal class value, and when (y==1), it corresponds to the Principal name value. For example, array[0][0] corresponds to the class name of the first Principal in the array. array[0][1] corresponds to the Principal name of the first Principal in the array.

Returns:String[][]: the Principal class and names associated with this PrivateCredentialPermission.

hashCode	back to summary
public int hashCode() Implements abstract java.security.Permission.hashCode. Returns the hash code value for this object. Returns:int the hash code value for this object Annotations @Override

hashCode

back to summary

public int hashCode()

Implements abstract java.security.Permission.hashCode.

Returns the hash code value for this object.

Returns:int

the hash code value for this object

Annotations

@Override

implies back to summary

implies	back to summary
public boolean implies(Permission p) Implements abstract java.security.Permission.implies. Checks if this `PrivateCredentialPermission` implies the specified `Permission`. This method returns true if: `p` is an instanceof PrivateCredentialPermission and the target name for `p` is implied by this object's target name. For example: [* P1 "duke"] implies [a.b.Credential P1 "duke"]. [C1 P1 "duke"] implies [C1 P1 "duke" P2 "dukette"]. [C1 P2 "dukette"] implies [C1 P1 "duke" P2 "dukette"]. Parameters p:Permission the `Permission` to check against. Returns:boolean true if this `PrivateCredentialPermission` implies the specified `Permission`, false if not.

public boolean implies(Permission p)

Implements abstract java.security.Permission.implies.

Checks if this PrivateCredentialPermission implies the specified Permission.

This method returns true if:

p is an instanceof PrivateCredentialPermission and

the target name for p is implied by this object's target name. For example:

 [* P1 "duke"] implies [a.b.Credential P1 "duke"].
 [C1 P1 "duke"] implies [C1 P1 "duke" P2 "dukette"].
 [C1 P2 "dukette"] implies [C1 P1 "duke" P2 "dukette"].

Parameters

p:Permission: the Permission to check against.

Returns:boolean

true if this PrivateCredentialPermission implies the specified Permission, false if not.

impliesCredentialClass	back to summary
private boolean impliesCredentialClass(String thisC, String thatC)

impliesPrincipalSet	back to summary
private boolean impliesPrincipalSet(PrivateCredentialPermission.CredOwner[] thisP, PrivateCredentialPermission.CredOwner[] thatP)

init	back to summary
private void init(String name)

newPermissionCollection back to summary

newPermissionCollection	back to summary
public PermissionCollection newPermissionCollection() Overrides java.security.Permission.newPermissionCollection. Return a homogeneous collection of PrivateCredentialPermissions in a `PermissionCollection`. No such `PermissionCollection` is defined, so this method always returns `null`. Returns:PermissionCollection null in all cases.

public PermissionCollection newPermissionCollection()

Overrides java.security.Permission.newPermissionCollection.

Return a homogeneous collection of PrivateCredentialPermissions in a PermissionCollection. No such PermissionCollection is defined, so this method always returns null.

Returns:PermissionCollection: null in all cases.

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException Reads this object from a stream (i.e., deserializes it) Parameters s:ObjectInputStream the `ObjectInputStream` from which data is read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

Reads this object from a stream (i.e., deserializes it)

Parameters

s:ObjectInputStream: the ObjectInputStream from which data is read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

javax.security.auth back to summary

pack-priv Class PrivateCredentialPermission.CredOwner

Class Inheritance

extends Object
implements Serializable

java.lang.Object
javax.security.auth.PrivateCredentialPermission.CredOwner

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
pack-priv String	principalClass
pack-priv String	principalName
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	CredOwner(String principalClass, String principalName)

Method Summary

Modifier and Type	Method and Description
public boolean	implies(Object obj)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

principalClass	back to summary
pack-priv String principalClass

principalName	back to summary
pack-priv String principalName

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

Constructor Detail

CredOwner	back to summary
pack-priv CredOwner(String principalClass, String principalName)

Method Detail

implies	back to summary
public boolean implies(Object obj)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

public final Class PrivateCredentialPermission

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class PrivateCredentialPermission.CredOwner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail