com.cafesoft.cams.access
Class AccessControlCheck

java.lang.Object
  |
  +--com.cafesoft.cams.access.AccessControlCheck

All Implemented Interfaces:

Recyclable

public class AccessControlCheck

extends Object

implements Recyclable

Encapsulates key AccessControlService request and response parameters. Implementations might be used to cache metadata about past access control request/response pairs.

Since:

12/4/2002

See Also:

AccessControlCheckException, AccessControlRequest, AccessControlResponse, ResourceRequest

Method Summary

static AccessControlCheck	create(ResourceRequest resourceRequest, AccessControlResponse response) A factory method used to create an AccessControlCheck from an AccessControlRequest and an AccessControlResponse.
String	getMessage() Get the AccessControlResponse message.
int	getReason() Get the AccessControlResponse reason code.
ResourceRequest	getResourceRequest() Get the ResourceRequest associated with the AccessControlCheck.
String	getSecurityDomainName() Get the AccessControlResponse security domain name.
int	getStatus() Get the AccessControlResponse status code.
void	recycle() Recycle the resources of this object
String	toString() Get a String representation of the AccessControlCheck

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AccessControlCheck create(ResourceRequest resourceRequest,
                                        AccessControlResponse response)
                                 throws AccessControlCheckException

A factory method used to create an AccessControlCheck from an AccessControlRequest and an AccessControlResponse.

Parameters:

resourceRequest - the ResourceRequest associated with the check.

response - the AccessControlResponse associated with the check.

Returns:

an AccessControlCheck containing pertinent information about the overall request and response.

Throws:

AccessControlCheckException - if an error creating the AccessControlCheck from the input parameters.

getResourceRequest

public ResourceRequest getResourceRequest()

Get the ResourceRequest associated with the AccessControlCheck.

Returns:

the ResourceRequest.

getStatus

public int getStatus()

Get the AccessControlResponse status code.

Returns:

the AccessControlResponse status code;.

getReason

public int getReason()

Get the AccessControlResponse reason code.

Returns:

the AccessControlResponse reason code;.

getMessage

public String getMessage()

Get the AccessControlResponse message.

Returns:

the AccessControlResponse message.

getSecurityDomainName

public String getSecurityDomainName()

Get the AccessControlResponse security domain name.

Returns:

the security domain name

recycle

public void recycle()

Description copied from interface: Recyclable

Recycle the resources of this object

Specified by:

recycle in interface Recyclable

toString

public String toString()

Get a String representation of the AccessControlCheck

Overrides:

toString in class Object

Returns:

a String representation of the AccessControlCheck