com.sssw.fw.security.api
Interface EbiElementTypeMeta

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiElementTypeMeta

extends EbiFrameworkElement

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

Field Summary

static String	ACL_ELEMENT_TYPE_META key for element type metadata (used in FWELEMENTTYPE column of SECURITYACCESSRIGHTS table)
static String	EL_FW_ELEMENTTYPEMETA ElementTypeMeta element type
static int	ELEMTYPE_ID_UNKNOWN The constant for the "unknown" element type ID.

Method Summary

boolean	addElementType(String elementType) Deprecated. EbiElementTypeMeta.addElementType(String, int)
boolean	addElementType(String elType, int elTypeID) Adds an element type.
boolean	addElementType(String elType, int elTypeID, String subsystem) Adds an element type to a subsystem.
boolean	addElementType(String elementType, String subsystem) Deprecated. EbiElementTypeMeta.addElementType(String, int, String)
String	getAdminID(String subsystem) Gets the adminID for a subsystem.
String	getAdminType(String subsystem) Gets the adminType for a subsystem.
int	getElementTypeID(String elType) Given an element type name, returns the respective element type ID.
String	getElementTypeMetaXML() Gets xml format for the element type metadata.
String[]	getElementTypes() Gets the list of supported element types.
String[]	getElementTypes(String subsystem) Gets the list of supported element types for a subsystem.
String	getSubsystem(String elementType) Gets the subsystem for the specified element type.
String[]	getSubsystems() Gets the list of subsystems that support acls.
boolean	removeElementType(String elementType) Removes an element type from the list.
boolean	removeElementType(String elementType, String subsystem) Removes an element type from the list.
void	removeSubsystem(String subsystem) Removes a custom subsystem and related settings.
void	setAdminID(String adminID, String subsystem) Sets the adminID for a sepcified subsystem.
void	setAdminType(String adminType, String subsystem) Sets the adminType for a sepcified subsystem.
boolean	validateAdminID(String adminID, String subsystem) Validates an admin ID.
boolean	validateElementType(String elementType) Validates an element type.
boolean	validateElementType(String elementType, String subsystem) Validates an element type for a specified subsystem.
boolean	validateSubsystem(String subsystem) Validates a subsystem.

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

ELEMTYPE_ID_UNKNOWN

public static final int ELEMTYPE_ID_UNKNOWN

The constant for the "unknown" element type ID.

See Also:

EbiElementTypeMeta.getElementTypeID(String)

EL_FW_ELEMENTTYPEMETA

public static final String EL_FW_ELEMENTTYPEMETA

ElementTypeMeta element type

ACL_ELEMENT_TYPE_META

public static final String ACL_ELEMENT_TYPE_META

key for element type metadata (used in FWELEMENTTYPE column of SECURITYACCESSRIGHTS table)

Method Detail

validateElementType

public boolean validateElementType(String elementType)

Validates an element type.

Parameters:

elementType - an element type.

Returns:

true if the element type is in the supported list.

validateElementType

public boolean validateElementType(String elementType,
                                   String subsystem)

Validates an element type for a specified subsystem.

Parameters:

elementType - an element type.

subsystem - a subsystem name.

Returns:

true if the element type is in the supported list.

getSubsystem

public String getSubsystem(String elementType)

Gets the subsystem for the specified element type.

Parameters:

elementType - an element type.

Returns:

the subsystem name for the element type.

validateSubsystem

public boolean validateSubsystem(String subsystem)

Validates a subsystem.

Parameters:

subsystem - a subsystem name.

Returns:

true if the subsystem exists, false otherwise.

validateAdminID

public boolean validateAdminID(String adminID,
                               String subsystem)

Validates an admin ID.

Parameters:

adminID - an admin ID.

subsystem - a subsystem name.

Returns:

true if the adminID is speficied for the subsystem.

addElementType

public boolean addElementType(String elementType)

Deprecated. EbiElementTypeMeta.addElementType(String, int)

Adds a element type to support acl.

Parameters:

elementType - a element type.

addElementType

public boolean addElementType(String elementType,
                              String subsystem)

Deprecated. EbiElementTypeMeta.addElementType(String, int, String)

Adds a element type to support acl.

Parameters:

elementType - a element type.

subsystem - a subsytem name.

addElementType

public boolean addElementType(String elType,
                              int elTypeID)

Adds an element type.

Parameters:

elType - the name of the element type to add

elTypeID - the ID of the element type to add

Returns:

true if the type was added successfully, false if it already exists

addElementType

public boolean addElementType(String elType,
                              int elTypeID,
                              String subsystem)

Adds an element type to a subsystem.

Parameters:

elType - the name of the element type to add

elTypeID - the ID of the element type to add

subsystem - the name of the subsystem

Returns:

true if the type was added successfully, false if it already exists

removeElementType

public boolean removeElementType(String elementType)

Removes an element type from the list. (built in element types are not allowed to be removed.)

Parameters:

elementType - a element type.

Returns:

true if the specified element type is removed from the list successfully.

removeElementType

public boolean removeElementType(String elementType,
                                 String subsystem)

Removes an element type from the list. (built in element types are not allowed to be removed.)

Parameters:

elementType - a element type.

subsystem - a subsystem name.

Returns:

true if the specified element type is removed from the list successfully.

setAdminID

public void setAdminID(String adminID,
                       String subsystem)

Sets the adminID for a sepcified subsystem. You must call setAdminType() first to create the specified subsystem.

Parameters:

adminID - an adminID.

subsystem - a subsytem name.

setAdminType

public void setAdminType(String adminType,
                         String subsystem)

Sets the adminType for a sepcified subsystem.

Parameters:

adminType - an adminType.

subsystem - a subsytem name.

getSubsystems

public String[] getSubsystems()

Gets the list of subsystems that support acls.

Returns:

a String array of subsystems.

getElementTypes

public String[] getElementTypes()

Gets the list of supported element types.

Returns:

a String array of supported element types.

getElementTypes

public String[] getElementTypes(String subsystem)

Gets the list of supported element types for a subsystem.

Parameters:

subsystem - a subsystem name.

Returns:

a String array of supported element types.

getAdminID

public String getAdminID(String subsystem)

Gets the adminID for a subsystem.

Parameters:

subsystem - a subsystem name.

Returns:

the adminID for the specified subsystem.

getAdminType

public String getAdminType(String subsystem)

Gets the adminType for a subsystem.

Parameters:

subsystem - a subsystem name.

Returns:

the adminType for the specified subsystem.

getElementTypeMetaXML

public String getElementTypeMetaXML()

Gets xml format for the element type metadata.

Returns:

element type metadata in xml format.

removeSubsystem

public void removeSubsystem(String subsystem)

Removes a custom subsystem and related settings. (Built-in subsystems are not allowed to be removed.)

Parameters:

subsystem - name of the custom subsystem.

getElementTypeID

public int getElementTypeID(String elType)

Given an element type name, returns the respective element type ID.

Parameters:

elType - the element type name

Returns:

the respective element type ID, or ELEMTYPE_ID_UNKNOWN if the element type name specified does not match to a known type ID