Index (Jakarta Authorization API documentation)

A C D E F G H I J L P R S W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addToExcludedPolicy(Permission) - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to add a single excluded policy statement to this PolicyConfiguration.
addToExcludedPolicy(PermissionCollection) - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to add excluded policy statements to this PolicyConfiguration.
addToRole(String, Permission) - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to add a single permission to a named role in this PolicyConfiguration.
addToRole(String, PermissionCollection) - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to add permissions to a named role in this PolicyConfiguration.
addToUncheckedPolicy(Permission) - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to add a single unchecked policy statement to this PolicyConfiguration.
addToUncheckedPolicy(PermissionCollection) - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to add unchecked policy statements to this PolicyConfiguration.

C

commit() - Method in interface jakarta.security.jacc.PolicyConfiguration: This method is used to set to "inService" the state of the policy context whose interface is this PolicyConfiguration Object.

D

delete() - Method in interface jakarta.security.jacc.PolicyConfiguration: Causes all policy statements to be deleted from this PolicyConfiguration and sets its internal state such that calling any method, other than delete, getContextID, or inService on the PolicyConfiguration will be rejected and cause an UnsupportedOperationException to be thrown.

E

EJBMethodPermission - Class in jakarta.security.jacc: Class for Jakarta Enterprise Beans method permissions.
EJBMethodPermission(String, String) - Constructor for class jakarta.security.jacc.EJBMethodPermission: Creates a new EJBMethodPermission with the specified name and actions.
EJBMethodPermission(String, String, Method) - Constructor for class jakarta.security.jacc.EJBMethodPermission: Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodInterface, and the Method object.
EJBMethodPermission(String, String, String, String[]) - Constructor for class jakarta.security.jacc.EJBMethodPermission: Creates a new EJBMethodPermission with name corresponding to the EJBName and actions composed from methodName, methodInterface, and methodParams.
EJBRoleRefPermission - Class in jakarta.security.jacc: Class for Jakarta Enterprise Beans isCallerInRole (String reference) permissions.
EJBRoleRefPermission(String, String) - Constructor for class jakarta.security.jacc.EJBRoleRefPermission: Creates a new EJBRoleRefPermission with the specified name and actions.
equals(Object) - Method in class jakarta.security.jacc.EJBMethodPermission: Checks two EJBMethodPermission objects for equality.
equals(Object) - Method in class jakarta.security.jacc.EJBRoleRefPermission: Checks two EJBRoleRefPermission objects for equality.
equals(Object) - Method in class jakarta.security.jacc.WebResourcePermission: Checks two WebResourcePermission objects for equality.
equals(Object) - Method in class jakarta.security.jacc.WebRoleRefPermission: Checks two WebRoleRefPermission objects for equality.
equals(Object) - Method in class jakarta.security.jacc.WebUserDataPermission: Checks two WebUserDataPermission objects for equality.

F

FACTORY_NAME - Static variable in class jakarta.security.jacc.PolicyConfigurationFactory
FACTORY_NAME - Static variable in class jakarta.security.jacc.PolicyFactory

G

get() - Static method in class jakarta.security.jacc.PolicyConfigurationFactory: This static method uses a system property to find and instantiate (via a public constructor) a provider specific factory implementation class.
get(String) - Static method in class jakarta.security.jacc.PolicyContext: This method may be used by a Policy provider to activate the PolicyContextHandler registered to the context object key and cause it to return the corresponding policy context object from the container.
getActions() - Method in class jakarta.security.jacc.EJBMethodPermission: Returns a String containing a canonical representation of the actions of this EJBMethodPermission.
getActions() - Method in class jakarta.security.jacc.EJBRoleRefPermission: Returns a canonical String representation of the actions of this EJBRoleRefPermission.
getActions() - Method in class jakarta.security.jacc.WebResourcePermission: Returns a canonical String representation of the actions of this WebResourcePermission.
getActions() - Method in class jakarta.security.jacc.WebRoleRefPermission: Returns a canonical String representation of the actions of this WebRoleRefPermission.
getActions() - Method in class jakarta.security.jacc.WebUserDataPermission: Returns a canonical String representation of the actions of this WebUserDataPermission.
getCallerPrincipal(Set<Principal>) - Method in interface jakarta.security.jacc.PrincipalMapper: Pick from the principals within the passed-in set of principals the platform-specific java.security.Principal that represents the name of the authenticated caller, or null if the current caller is not authenticated.
getCallerPrincipal(Subject) - Method in interface jakarta.security.jacc.PrincipalMapper: Pick from the principals within the passed-in Subject the platform-specific java.security.Principal that represents the name of authenticated caller, or null if the current caller is not authenticated.
getContext(String) - Static method in class jakarta.security.jacc.PolicyContext: This method may be used by a Policy provider to activate the PolicyContextHandler registered to the context object key and cause it to return the corresponding policy context object from the container.
getContext(String, Object) - Method in interface jakarta.security.jacc.PolicyContextHandler: This public method is used by the PolicyContext class to activate the handler and obtain from it the context object identified by the (case-sensitive) key.
getContextID() - Method in interface jakarta.security.jacc.PolicyConfiguration: This method returns this object's policy context identifier.
getContextID() - Static method in class jakarta.security.jacc.PolicyContext: This static method returns the value of the policy context identifier associated with the thread on which the accessor is called.
getExcludedPermissions() - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to return all excluded policy statements that have been added to this PolicyConfiguration via prior calls to addToExcludedPolicy(Permission) and addToExcludedPolicy(PermissionCollection).
getHandlerKeys() - Static method in class jakarta.security.jacc.PolicyContext: This method may be used to obtain the keys that identify the container specific context handlers registered by the container.
getKeys() - Method in interface jakarta.security.jacc.PolicyContextHandler: This public method returns the keys identifying the context objects supported by the handler.
getMappedRoles(Set<Principal>) - Method in interface jakarta.security.jacc.PrincipalMapper: Pick from the principals within the passed-in set of principals all application roles that are associated with the caller principal.
getMappedRoles(Subject) - Method in interface jakarta.security.jacc.PrincipalMapper: Pick from the principals within the passed-in Subject all application roles that are associated with the caller principal.
getPermissionCollection(Subject) - Method in interface jakarta.security.jacc.Policy: Returns a collection of at least all declared permissions associated with the caller principal contained in the @{subject} parameter.
getPerRolePermissions() - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to return all per role policy statements that have been added to this PolicyConfiguration via prior calls to addToRole(String, Permission) and addToRole(String, PermissionCollection), indexed by the role names used in those calls.
getPolicy() - Method in class jakarta.security.jacc.PolicyFactory: This method is used to obtain an instance of the provider specific class that implements the Policy interface that corresponds to policy context within the provider.
getPolicy(String) - Method in class jakarta.security.jacc.PolicyFactory: This method is used to obtain an instance of the provider specific class that implements the Policy interface that corresponds to policy context within the provider.
getPolicyConfiguration() - Method in class jakarta.security.jacc.PolicyConfigurationFactory: This method is used to obtain an instance of the provider specific class that implements the PolicyConfiguration interface that corresponds to the identified policy context within the provider.
getPolicyConfiguration(String) - Method in class jakarta.security.jacc.PolicyConfigurationFactory: This method is used to obtain an instance of the provider specific class that implements the PolicyConfiguration interface that corresponds to the identified policy context within the provider.
getPolicyConfiguration(String, boolean) - Method in class jakarta.security.jacc.PolicyConfigurationFactory: This method is used to obtain an instance of the provider specific class that implements the PolicyConfiguration interface that corresponds to the identified policy context within the provider.
getPolicyConfigurationFactory() - Static method in class jakarta.security.jacc.PolicyConfigurationFactory: This static method uses a system property to find and instantiate (via a public constructor) a provider specific factory implementation class.
getPolicyFactory() - Static method in class jakarta.security.jacc.PolicyFactory: Get the system-wide PolicyFactory implementation.
getUncheckedPermissions() - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to return all unchecked policy statements that have been added to this PolicyConfiguration via prior calls to addToUncheckedPolicy(Permission) and addToUncheckedPolicy(PermissionCollection).
getWrapped() - Method in class jakarta.security.jacc.PolicyConfigurationFactory: If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
getWrapped() - Method in class jakarta.security.jacc.PolicyFactory: If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

H

hashCode() - Method in class jakarta.security.jacc.EJBMethodPermission: Returns the hash code value for this EJBMethodPermission.
hashCode() - Method in class jakarta.security.jacc.EJBRoleRefPermission: Returns the hash code value for this EJBRoleRefPermission.
hashCode() - Method in class jakarta.security.jacc.WebResourcePermission: Returns the hash code value for this WebResourcePermission.
hashCode() - Method in class jakarta.security.jacc.WebRoleRefPermission: Returns the hash code value for this WebRoleRefPermission.
hashCode() - Method in class jakarta.security.jacc.WebUserDataPermission: Returns the hash code value for this WebUserDataPermission.
HTTP_SERVLET_REQUEST - Static variable in class jakarta.security.jacc.PolicyContext: Key to use for getting an `jakarta.servlet.http.HttpServletRequest` from PolicyContext.getContext(String) When this handler is activated, the container must return the `HttpServletRequest` object corresponding to the component request being processed by the container.

I

implies(Permission) - Method in class jakarta.security.jacc.EJBMethodPermission: Determines if the argument Permission is "implied by" this EJBMethodPermission.
implies(Permission) - Method in class jakarta.security.jacc.EJBRoleRefPermission: Determines if the argument Permission is "implied by" this EJBRoleRefPermission.
implies(Permission) - Method in interface jakarta.security.jacc.Policy: This method checks whether the permission represented by the @{permissionToBeChecked} parameter is granted to the anonymous (unauthenticated) caller principal.
implies(Permission) - Method in class jakarta.security.jacc.WebResourcePermission: Determines if the argument Permission is "implied by" this WebResourcePermission.
implies(Permission) - Method in class jakarta.security.jacc.WebRoleRefPermission: Determines if the argument Permission is "implied by" this WebRoleRefPermission.
implies(Permission) - Method in class jakarta.security.jacc.WebUserDataPermission: Determines if the argument Permission is "implied by" this WebUserDataPermission.
implies(Permission, Set<Principal>) - Method in interface jakarta.security.jacc.Policy: Returns a collection of at least all declared permissions associated with the caller principal contained in the set of principals being passed in.
implies(Permission, Subject) - Method in interface jakarta.security.jacc.Policy: This method checks whether the permission represented by the @{permissionToBeChecked} parameter is granted to the caller principal within the @{subject} parameter.
impliesByRole(Permission, Subject) - Method in interface jakarta.security.jacc.Policy: This method checks whether the permission represented by the @{permissionToBeChecked} parameter is granted to the caller principal within the @{subject} parameter based on one or more roles associated with that caller principal.
inService() - Method in interface jakarta.security.jacc.PolicyConfiguration: This method is used to determine if the policy context whose interface is this PolicyConfiguration Object is in the "inService" state.
inService(String) - Method in class jakarta.security.jacc.PolicyConfigurationFactory: This method determines if the identified policy context exists with state "inService" in the Policy provider associated with the factory.
isAnyAuthenticatedUserRoleMapped() - Method in interface jakarta.security.jacc.PrincipalMapper: Jakarta Security defines the "any authenticated caller role" as "**" and allows an application specific mapping for this role to be established.
isExcluded(Permission) - Method in interface jakarta.security.jacc.Policy: This method checks whether the permission represented by the @{permissionToBeChecked} parameter is excluded by this policy.
isUnchecked(Permission) - Method in interface jakarta.security.jacc.Policy: This method checks whether the permission represented by the @{permissionToBeChecked} parameter is unchecked by this policy.

J

jakarta.security.jacc - module jakarta.security.jacc
jakarta.security.jacc - package jakarta.security.jacc: This package contains the Jakarta Authorization API

L

linkConfiguration(PolicyConfiguration) - Method in interface jakarta.security.jacc.PolicyConfiguration: Creates a relationship between this configuration and another such that they share the same principal-to-role mappings.

P

Policy - Interface in jakarta.security.jacc: A Policy object is responsible for determining whether a caller principal (including the unauthenticated one) has permission to perform a security-sensitive operation.
PolicyConfiguration - Interface in jakarta.security.jacc: The methods of this interface are used by containers to create policy statements in a Policy provider.
PolicyConfigurationFactory - Class in jakarta.security.jacc: Abstract factory and finder class for obtaining the instance of the class that implements the PolicyConfigurationFactory of a provider.
PolicyConfigurationFactory() - Constructor for class jakarta.security.jacc.PolicyConfigurationFactory: Default constructor for if no wrapping is needed
PolicyConfigurationFactory(PolicyConfigurationFactory) - Constructor for class jakarta.security.jacc.PolicyConfigurationFactory: If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
PolicyContext - Class in jakarta.security.jacc: This utility class is used by containers to communicate policy context identifiers and other policy relevant context to Policy providers.
PolicyContextException - Exception Class in jakarta.security.jacc: This checked exception is thrown by implementations of the PolicyConfiguration Interface, the PolicyConfigurationFactory abstract class, the PolicyContext utility class, and implementations of the PolicyContextException Interface.
PolicyContextException() - Constructor for exception class jakarta.security.jacc.PolicyContextException: Constructs a new PolicyContextException with null as its detail message.
PolicyContextException(String) - Constructor for exception class jakarta.security.jacc.PolicyContextException: Constructs a new PolicyContextException with the specified detail message
PolicyContextException(String, Throwable) - Constructor for exception class jakarta.security.jacc.PolicyContextException: Constructs a new PolicyContextException with the specified detail message and cause.
PolicyContextException(Throwable) - Constructor for exception class jakarta.security.jacc.PolicyContextException: Constructs a new PolicyContextException with the specified cause.
PolicyContextHandler - Interface in jakarta.security.jacc: This interface defines the methods that must be implemented by handlers that are to be registered and activated by the PolicyContext class.
PolicyFactory - Class in jakarta.security.jacc: Abstract factory and finder class for obtaining the instance of the class that implements the PolicyFactory of a provider.
PolicyFactory() - Constructor for class jakarta.security.jacc.PolicyFactory: Default constructor for if no wrapping is needed
PolicyFactory(PolicyFactory) - Constructor for class jakarta.security.jacc.PolicyFactory: If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
PRINCIPAL_MAPPER - Static variable in class jakarta.security.jacc.PolicyContext: Key to use for getting a `jakarta.security.jacc.PrincipalMapper` from PolicyContext.getContext(String)
PrincipalMapper - Interface in jakarta.security.jacc: A PrincipalMapper is an object that maps from a collection of generic Principals or a Subject to well known entities in Jakarta EE.

R

refresh() - Method in interface jakarta.security.jacc.Policy: Optional method; TODO: needed?
registerHandler(String, PolicyContextHandler, boolean) - Static method in class jakarta.security.jacc.PolicyContext: Method used to register a container specific PolicyContext handler.
removeExcludedPolicy() - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to remove any excluded policy statements from this PolicyConfiguration.
removeRole(String) - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to remove a role and all its permissions from this PolicyConfiguration.
removeUncheckedPolicy() - Method in interface jakarta.security.jacc.PolicyConfiguration: Used to remove any unchecked policy statements from this PolicyConfiguration.

S

setContextID(String) - Static method in class jakarta.security.jacc.PolicyContext: Method used to modify the value of the policy context identifier associated with the thread on which this method is called.
setHandlerData(Object) - Static method in class jakarta.security.jacc.PolicyContext: Method that may be used to associate a thread-scoped handler data object with the PolicyContext.
setPolicy(Policy) - Method in class jakarta.security.jacc.PolicyFactory: Set the context Policy implementation.
setPolicy(String, Policy) - Method in class jakarta.security.jacc.PolicyFactory: Set the context Policy implementation.
setPolicyConfigurationFactory(PolicyConfigurationFactory) - Static method in class jakarta.security.jacc.PolicyConfigurationFactory: Set the system-wide PolicyFactory implementation.
setPolicyFactory(PolicyFactory) - Static method in class jakarta.security.jacc.PolicyFactory: Set the system-wide PolicyFactory implementation.
SOAP_MESSAGE - Static variable in class jakarta.security.jacc.PolicyContext: Key to use for getting an `jakarta.xml.soap.SOAPMessage` from PolicyContext.getContext(String) If the request being processed by the container arrived as a SOAP request at the `ServiceEndpoint` method interface, the container must return the SOAP message object when this handler is activated.
SUBJECT - Static variable in class jakarta.security.jacc.PolicyContext: Key to use for getting a `javax.security.auth.Subject` from PolicyContext.getContext(String) When this handler is activated as the result of a policy decision performed by a container before dispatch into a component, this handler must return a `Subject` containing the principals and credentials of the “caller” of the component.
supports(String) - Method in interface jakarta.security.jacc.PolicyContextHandler: This public method returns a boolean result indicating whether or not the handler supports the context object identified by the (case-sensitive) key value.

W

WebResourcePermission - Class in jakarta.security.jacc: Class for Jakarta Servlet web resource permissions.
WebResourcePermission(HttpServletRequest) - Constructor for class jakarta.security.jacc.WebResourcePermission: Creates a new WebResourcePermission from the HttpServletRequest object.
WebResourcePermission(String, String) - Constructor for class jakarta.security.jacc.WebResourcePermission: Creates a new WebResourcePermission with the specified name and actions.
WebResourcePermission(String, String[]) - Constructor for class jakarta.security.jacc.WebResourcePermission: Creates a new WebResourcePermission with name corresponding to the URLPatternSpec, and actions composed from the array of HTTP methods.
WebRoleRefPermission - Class in jakarta.security.jacc: Class for Jakarta Servlet isUserInRole (String reference) permissions.
WebRoleRefPermission(String, String) - Constructor for class jakarta.security.jacc.WebRoleRefPermission: Creates a new WebRoleRefPermission with the specified name and actions.
WebUserDataPermission - Class in jakarta.security.jacc: Class for Jakarta Servlet Web user data permissions.
WebUserDataPermission(HttpServletRequest) - Constructor for class jakarta.security.jacc.WebUserDataPermission: Creates a new WebUserDataPermission from the HttpServletRequest object.
WebUserDataPermission(String, String) - Constructor for class jakarta.security.jacc.WebUserDataPermission: Creates a new WebUserDataPermission with the specified name and actions.
WebUserDataPermission(String, String[], String) - Constructor for class jakarta.security.jacc.WebUserDataPermission: Creates a new WebUserDataPermission with name corresponding to the URLPatternSpec, and actions composed from the array of HTTP methods and the transport type.

A C D E F G H I J L P R S W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form