com.sssw.fw.security.api
Interface EbiPermissionMeta

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiPermissionMeta

extends EbiFrameworkElement

This provides an interface for the Permission MetaData object which contains permission meta info for the framework.

Field Summary

static String	ACL_PERMISSION_META No information available
static String	EL_FW_PERMMETA PermissionMeta element type

Method Summary

boolean	addPermission(String permName, String permDescr) Adds a customized permission.
Permission	getPermission(int permissionID) Gets a Permission object by a given permissionID.
Permission	getPermission(String permission) Gets a Permission object by a given permission name.
String	getPermissionDescription(String permName) Gets the permission description for a specified permission
int	getPermissionIdentifier(String permName) Gets permission ID for a specified permission.
int[]	getPermissionIDs() Gets supported permission IDs.
String	getPermissionMetaXML() Gets xml format for the permission metadata.
String	getPermissionName(int permissionID) Gets the permission name for a specified permissionID.
String[]	getPermissionNames() Gets supported permission Names
boolean	hasCustomPermissions() Checks to see if there are any custom permmissions defined in the framework.
boolean	isPermissionBuiltIn(String permissionName) Check if the permission is built-in.
boolean	isPermissionValid(String permissionName) Check if the specified permission is a valid permission.
boolean	modifyPermission(String permName, String permDescr) Modifies a permission description.
void	removePermission(String permName) Removes 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_PERMMETA

public static final String EL_FW_PERMMETA

PermissionMeta element type

ACL_PERMISSION_META

public static final String ACL_PERMISSION_META

No information available

Method Detail

hasCustomPermissions

public boolean hasCustomPermissions()

Checks to see if there are any custom permmissions defined in the framework.

Returns:

true if there is any.

addPermission

public boolean addPermission(String permName,
                             String permDescr)

Adds a customized permission.

Parameters:

permName - a name for the new permission.

permDescr - the description for the new permission. (optional)

modifyPermission

public boolean modifyPermission(String permName,
                                String permDescr)

Modifies a permission description.

Parameters:

permName - a name of the permission to be modified.

permDescr - the description of the permission.

removePermission

public void removePermission(String permName)

Removes a permission. Cannot remove any built-in permissions.

Parameters:

permName - a name of the permission to be removed.

getPermissionIDs

public int[] getPermissionIDs()

Gets supported permission IDs.

Returns:

an int array of permission IDs.

getPermissionNames

public String[] getPermissionNames()

Gets supported permission Names

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 permissionID)

Gets the permission name for a specified permissionID.

Parameters:

permissionID - a permissionID.

getPermissionDescription

public String getPermissionDescription(String permName)

Gets the permission description for a specified permission

Parameters:

permName - a name of the specified permission.

getPermission

public Permission getPermission(String permission)

Gets a Permission object by a given permission name.

Parameters:

permission - a name of the specified permission

Returns:

a Permission object.

getPermission

public Permission getPermission(int permissionID)

Gets a Permission object by a given permissionID.

Parameters:

permissionID - a permission ID

Returns:

a Permission object.

isPermissionBuiltIn

public boolean isPermissionBuiltIn(String permissionName)

Check if the permission is built-in.

Parameters:

permissionName - name of a permission.

Returns:

true if the specified permission is built-in, false otherwise.

isPermissionValid

public boolean isPermissionValid(String permissionName)

Check if the specified permission is a valid permission.

Parameters:

permissionName - name of a permission

Returns:

true if the specified permission is a valid permission, false otherwise.

getPermissionMetaXML

public String getPermissionMetaXML()

Gets xml format for the permission metadata.

Returns:

permission metadata in xml format.