Oracle Entitlements Server for Java API Reference

com.bea.security
Class AccessResult

java.lang.Object
  |
  +--com.bea.security.AccessResult

Direct Known Subclasses:

ExtendedAccessResult

public class AccessResult

extends java.lang.Object

AccessResult is the object returned to the application after an authorization query. Primarily this object returns a boolean as to whether access is permitted or denied through its isAllowed() method. An AccessResult object also returns a date and time as to when the decision was evaluated and, optionally, lets an application re-query the decision without having to provide the original arguments.

Author:

Copyright © 2004-2008, Oracle and/or its affiliates. All rights reserved.

Method Summary

java.util.Date	getDecisionTime() Gets the date and time that this decision was made.
boolean	isAllowed() Gets the boolean result of this access decision.
void	reQuery() Refreshes the decision results by running the original access query again.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isAllowed

public boolean isAllowed()

Gets the boolean result of this access decision.

Returns:

a boolean that indicates if the access query is true or false.

reQuery

public void reQuery()
             throws IdentityNotAuthenticException,
                    ParameterException

Refreshes the decision results by running the original access query again. The original arguments for the query are recorded in this class. Any context used in the original query will be evaluated against the actual context, instead of a copy.

Throws:

IdentityNotAuthenticException - This exception is thrown if the identity that originally has submitted this query has become invalid or is no longer authenticated.

ParameterException - This exception is thrown if any of the original query arguments become invalid.

getDecisionTime

public java.util.Date getDecisionTime()

Gets the date and time that this decision was made.

Returns:

a java.util.Date that contains the date and time of this access decision. The time is recorded to the nearest millisecond.