com.sssw.fw.security.api
Interface EbiAccessRightMeta

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiAccessRightMeta

extends EbiFrameworkElement

This provides an interface for the Access Right Meta object which contains access right metadata information for an object type.

Field Summary

static String

EL_FW_ACLMETA AccessRightMeta element type

Method Summary

boolean	addPermission(String permName, int permID) Adds a permission to the ACL meta of the associated element type.
String	getAccessRightMetaXML() Gets the permission metadata in xml format.
String	getElementType() Gets the element type.
int	getMaxPermissionID() Gets the max permission ID for this element type.
int	getPermissionIdentifier(String permName) Gets permission ID for a specified permission.
int[]	getPermissionIDs() Gets the list of permission IDs for the associated element type.
String	getPermissionName(int permID) Gets permission Name for a specified permission ID.
String[]	getPermissionNames() Gets the list of permission names for the associated element type.
boolean	removePermission(String permName) Remove a permission.
void	setElementType(String elementType) Sets an element type.
boolean	validatePermission(int permID) Validates a permission.

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_FW_ACLMETA

public static final String EL_FW_ACLMETA

AccessRightMeta element type

Method Detail

getElementType

public String getElementType()

Gets the element type.

Returns:

the element type.

setElementType

public void setElementType(String elementType)

Sets an element type.

Parameters:

elementType - an element type.

getAccessRightMetaXML

public String getAccessRightMetaXML()

Gets the permission metadata in xml format.

Returns:

the metadata.

validatePermission

public boolean validatePermission(int permID)

Validates a permission.

Parameters:

permID - a permission ID.

Returns:

true if the permission is supported by this element type.

addPermission

public boolean addPermission(String permName,
                             int permID)

Adds a permission to the ACL meta of the associated element type.

Parameters:

permName - permission name of a permission to be added.

permID - permission identifier of the specified permission.

Returns:

true if the permission is added successfully, false otherwise.

removePermission

public boolean removePermission(String permName)

Remove a permission.

Parameters:

permName - a name of a permission to be removed.

getPermissionIDs

public int[] getPermissionIDs()

Gets the list of permission IDs for the associated element type.

Returns:

a list of permission IDs.

getPermissionNames

public String[] getPermissionNames()

Gets the list of permission names for the associated element type.

Returns:

a String array of permission names.

getPermissionIdentifier

public int getPermissionIdentifier(String permName)

Gets permission ID for a specified permission.

Parameters:

permName - a name of the specified permission.

getPermissionName

public String getPermissionName(int permID)

Gets permission Name for a specified permission ID.

Returns:

permission name for the specified permission ID.

getMaxPermissionID

public int getMaxPermissionID()

Gets the max permission ID for this element type.