com.cafesoft.cams.access
Interface ResourceRequest

All Known Implementing Classes:

AbstractResourceRequest

public interface ResourceRequest

ResourceRequest represents a user or system's request for a generic Resource, which may be protected by the Cafesoft Access Management System.

A ResourceRequest is uniquely identified by:

1. it's type, which is defined by the class implementing this interface
2. it's resource identifier
3. the action(s) being requested on the Resource.

Since:

2/1/2002

Method Summary

String	getActions() Get the actions being requested on the Resource
long	getActionsMask() Get an integer mask representing the actions being requested on the Resource.
String	getId() Get the Resource's Id
ResourceType	getResourceType() Get the ResourceType.
void	setActions(String actions) Set the actions being performed on the Resource
void	setId(String id) Set the Resource's Id

Method Detail

getResourceType

public ResourceType getResourceType()

Get the ResourceType.

Returns:

the ResourceType of the Resource.

getId

public String getId()

Get the Resource's Id

Returns:

a String representing the Resource's fully-qualified identifier.

setId

public void setId(String id)
           throws InvalidResourceException

Set the Resource's Id

Parameters:

id - a String indicating the Resource's Id

Throws:

InvalidResourceException - if the Resource's identifier is valid. This may occur if the identifier must follow a specific pattern, or it must be non-null or non-empty.

getActions

public String getActions()

Get the actions being requested on the Resource

Returns:

a String indicating the actions being requested

setActions

public void setActions(String actions)
                throws InvalidResourceException

Set the actions being performed on the Resource

Parameters:

actions - a String indicating the action(s) being requested.

Throws:

InvalidResourceException - if one or more actions is invalid for the resource associated with this request.

getActionsMask

public long getActionsMask()

Get an integer mask representing the actions being requested on the Resource. (Use of this value rather than the String actions can significantly improve performance).

Returns:

an integer representing the actions being requested on the Resource.