|
BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bea.security.PublicSecurityService | +--com.bea.security.AuthorizationService
The authorization service is a service that allows an application to determine if a specific identity is permitted to access a specific resource.
Field Summary | |
static int |
ONCE
Indicates that an authorization query will only be asked once for a resource and action. |
static int |
POST
Indicates that an authorization query is being asked after a resource is aquired, but before it has been processed or presented. |
static int |
PRIOR
Indicates that an authorization query is being asked before a resource is aquired. |
Fields inherited from class com.bea.security.PublicSecurityService |
COMPATIBLE,
COMPATIBLE_DEPRECATED,
COMPATIBLE_UNKNOWN,
NOT_COMPATIBLE |
Method Summary | |
ServiceType |
getServiceType()
Indicates this service's type. |
ServiceVersion |
getVersion()
Indicates this service's version. |
AccessResult |
isAccessAllowed(AuthenticIdentity ident,
RuntimeResource resource,
RuntimeAction action)
Determines if an AuthenticIdentity is permitted to access a specific resource with a specific action. |
AccessResult |
isAccessAllowed(AuthenticIdentity ident,
RuntimeResource resource,
RuntimeAction action,
AppContext context)
Determines if an AuthenticIdentity is permitted to access a specific resource with a specific action. |
AccessResult |
isAccessAllowed(AuthenticIdentity ident,
RuntimeResource resource,
RuntimeAction action,
AppContext context,
int direction)
Determines if an AuthenticIdentity is permitted to access a specific
resource with a specific action. |
boolean |
isAuthenticationRequired(RuntimeResource resource,
RuntimeAction action)
Determines if a resource and action requires authentication before it is accessed. |
int |
isCompatible(ServiceVersion version)
Determines if the version of the public service API specified in the Java application is compatible with the current version of the service API in the security runtime instance. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int ONCE
public static final int PRIOR
public static final int POST
Method Detail |
public ServiceType getServiceType()
ServiceType
object indicating this service's type.public ServiceVersion getVersion()
ServiceVersion
indicating the service version number and patch level.public int isCompatible(ServiceVersion version)
version
- a ServiceVersion
which is being asked for by the Java application.
The current service, that is, the service in the security runtime instance,
will indiciate if it supports the version specified in the isCompatible()
method.NOT_COMPATIBLE
if the service is not compatible
with the supplied version, COMPATIBLE
if the service is fully compatible,
COMPATIBLE_DEPRECATED
if the service is compatible, but some functions have
been depricated between the versions, or, finally, COMPATIBLE_UNKNOWN
if the version
passed in is newer than the current version, so compatibility is unknown.public AccessResult isAccessAllowed(AuthenticIdentity ident, RuntimeResource resource, RuntimeAction action) throws IdentityNotAuthenticException, ParameterException
AuthenticIdentity
is permitted to access a specific resource with a specific action. The application context is not
taken into account for this decision. The direction
parameter, which cannot be specified using
this version of this method, is set to ONCE
by default.
ident
- an AuthenticIdentity
that is asking permission to access a resource with an action.resource
- the RuntimeResource
that is being checked for permission.action
- the RuntimeAction
to be performed on the resource.AccessResult
which encodes if the AuthenticIdentity
has permission to access this resource or not.public AccessResult isAccessAllowed(AuthenticIdentity ident, RuntimeResource resource, RuntimeAction action, AppContext context) throws IdentityNotAuthenticException, ParameterException
AuthenticIdentity
is permitted to access a specific resource with a specific action. The application context is also
taken into account for this decision. The direction
parameter, which cannot be specified using
this version of this method, is set to ONCE
by default.
ident
- an AuthenticIdentity
that is asking permission to access a resource.resource
- the RuntimeResource
that is being checked for permission.action
- the RuntimeAction
to be performed on the resource.context
- an object with an AppContext
interface containing name/value pairs relevant to this application's current context. Providers may
use the values in this context to help determine the answer to this query.AccessResult
which encodes if the AuthenticIdentity
has permission to access this resource or not.IdentityNotAuthenticException
is thrown if the identity provides is invalid or not properly authenticated.public AccessResult isAccessAllowed(AuthenticIdentity ident, RuntimeResource resource, RuntimeAction action, AppContext context, int direction) throws ParameterException, IdentityNotAuthenticException
AuthenticIdentity
is permitted to access a specific
resource with a specific action. The application context is also
taken into account for this decision.
ident
- an AuthenticIdentity
that is asking permission to access a resource.resource
- the RuntimeResource
that is being checked for permission.action
- the RuntimeAction
to be performed on the resource.context
- an object with an AppContext
interface containing name/value pairs relevant to this application's current context. Providers may
use the values in this context to help determine the answer to this query.direction
- determines how this access request is processed. This parameter can be
set to PRIOR
, POST
, or ONCE
.
PRIOR
indicates that this access request
is to be evaluated
before the resource is acquired,
POST
indicates that this access request is to be evaluated
after the resource is required, and ONCE
indicates that
this access request is to be evaluated only once.
An application may use the PRIOR
and POST
parameters in cases where an AuthenticIdentity
may be permitted to
acquire a resource prior to using it, but then may not be permitted
to use it after it is acquired.AccessResult
which encodes if the Identity
has permission to access this resource or not.public boolean isAuthenticationRequired(RuntimeResource resource, RuntimeAction action) throws ParameterException
resource
- a RuntimeResource
that indicates the resource in question.action
- a RuntimeAction
that indicates the action in question.true
if this resource and action requires the application to authenticate the user and do an isAccessAllowed
call to determine the final access decision. A false
if this resource and action does not require authentication.
In the event no authentication is required, isAccessAllowed need not be called and the application can allow the action on the
resource in question.
|
Documentation is available at http://edocs.bea.com/ales/docs21 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |