com.epicentric.permission
Class GenericPermissionCatalog

java.lang.Object
  |
  +--com.epicentric.permission.GenericPermissionCatalog

All Implemented Interfaces:

PermissionCatalog

Deprecated. As of version 4.0, to be removed in 8.0 or later; replaced by a new permissioning system, described in the section on permissions checking in Vignette Portal Developer's Guide.

public class GenericPermissionCatalog

extends Object

implements PermissionCatalog

General-purpose implementation of a PermissionCatalog. Typically an object will create one of these to describe its permissions and return it as a PermissionCatalog (not exposing add() since clients shouldn't modify it).

Constructor Summary

GenericPermissionCatalog(String name)
Deprecated.

Method Summary

void	add(String id, String name, String description, boolean def) Deprecated. Adds a descriptor to the catalog.
PermissionCatalogItem	getItem(String permission_id) Deprecated. Look up a single descriptor.
PermissionCatalogItem[]	getItems() Deprecated. Returns an array containing all the catalog's items.
PermissionCatalogItem[]	getItemsPrefixedBy(String permission_id_prefix) Deprecated. Return items in the catalog whose permissionIDs are prefixed by the given string.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericPermissionCatalog

public GenericPermissionCatalog(String name)

Deprecated.

Parameters:

name - The name of the catalog, for debugging, etc.

Method Detail

getItems

public PermissionCatalogItem[] getItems()

Deprecated.

Returns an array containing all the catalog's items. Used to iterate over all the descriptors, e.g. when rendering them in a user interface.

Specified by:

getItems in interface PermissionCatalog

getItem

public PermissionCatalogItem getItem(String permission_id)

Deprecated.

Look up a single descriptor. Lookup is case-insensitive. Returns null if not found.

Specified by:

getItem in interface PermissionCatalog

getItemsPrefixedBy

public PermissionCatalogItem[] getItemsPrefixedBy(String permission_id_prefix)

Deprecated.

Return items in the catalog whose permissionIDs are prefixed by the given string. For example, getItemsPrefixedBy("standard.") would return items "standard.edit" and "standard.enabled", if such items exist. Lookup is case-insensitive.

Return an array of length 0 if no items are found. Return no permissions if prefix is null. Return all permissions if prefix is blank.

Specified by:

getItemsPrefixedBy in interface PermissionCatalog

add

public void add(String id,
                String name,
                String description,
                boolean def)
         throws IllegalArgumentException

Deprecated.

Adds a descriptor to the catalog. The id is converted to lowercase. Throws an exception if the id is already taken.