This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.security.auth
class AuthPermission

java.lang.Object extended by java.security.Permission extended by java.security.BasicPermission extended by javax.security.auth.AuthPermission
All Implemented Interfaces:
Serializable, Guard

public final class AuthPermission
extends BasicPermission

This class is for authentication permissions. An AuthPermission contains a name (also referred to as a "target name") but no actions list; you either have the named permission or you don't.

The target name is the name of a security configuration parameter (see below). Currently the AuthPermission object is used to guard access to the Policy, Subject, LoginContext, and Configuration objects.

The possible target names for an Authentication Permission are:

	doAs -			allow the caller to invoke the
				Subject.doAs methods.

	doAsPrivileged -	allow the caller to invoke the
				Subject.doAsPrivileged methods.

	getSubject -		allow for the retrieval of the
				Subject(s) associated with the
				current Thread.

	getSubjectFromDomainCombiner -	allow for the retrieval of the
				Subject associated with the
				a SubjectDomainCombiner.

	setReadOnly -		allow the caller to set a Subject
				to be read-only.

	modifyPrincipals -	allow the caller to modify the Set
				of Principals associated with a
				Subject

	modifyPublicCredentials - allow the caller to modify the
				Set of public credentials
				associated with a Subject

	modifyPrivateCredentials - allow the caller to modify the
				Set of private credentials
				associated with a Subject

	refreshCredential -	allow code to invoke the refresh
				method on a credential which implements
				the Refreshable interface.

	destroyCredential -	allow code to invoke the destroy
				method on a credential object
				which implements the Destroyable
				interface.

	createLoginContext.{name} -  allow code to instantiate a
				LoginContext with the
				specified name.  name
				is used as the index into the installed login
				Configuration
				(that returned by
				Configuration.getConfiguration()).
				name can be wildcarded (set to '*')
				to allow for any name.

	getLoginConfiguration - allow for the retrieval of the system-wide
				login Configuration.

	createLoginConfiguration.{type} - allow code to obtain a Configuration
				object via
				Configuration.getInstance.

	setLoginConfiguration - allow for the setting of the system-wide
				login Configuration.

	refreshLoginConfiguration - allow for the refreshing of the system-wide
				login Configuration.
 

The following target name has been deprecated in favor of createLoginContext.{name}.

	createLoginContext -	allow code to instantiate a
				LoginContext.
 

javax.security.auth.Policy has been deprecated in favor of java.security.Policy. Therefore, the following target names have also been deprecated:

	getPolicy -		allow the caller to retrieve the system-wide
				Subject-based access control policy.

	setPolicy -		allow the caller to set the system-wide
				Subject-based access control policy.

	refreshPolicy -		allow the caller to refresh the system-wide
				Subject-based access control policy.
 


Constructor Summary

          Creates a new AuthPermission with the specified name.
AuthPermission(String name, String actions)

          Creates a new AuthPermission object with the specified name.
 
Method Summary
 
Methods inherited from class java.security.BasicPermission
equals, getActions, hashCode, implies, newPermissionCollection
 
Methods inherited from class java.security.Permission
checkGuard, equals, getActions, getName, hashCode, implies, newPermissionCollection, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuthPermission

public AuthPermission(String name)
Creates a new AuthPermission with the specified name. The name is the symbolic name of the AuthPermission.

Parameters:
name - the name of the AuthPermission

AuthPermission

public AuthPermission(String name,
                      String actions)
Creates a new AuthPermission object with the specified name. The name is the symbolic name of the AuthPermission, and the actions String is currently unused and should be null.

Parameters:
name - the name of the AuthPermission

actions - should be null.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.