com.sssw.fw.security.api
Interface EbiSecurityMetaDelegate

All Superinterfaces:

EbiDelegate

public interface EbiSecurityMetaDelegate

extends EbiDelegate

The security meta delegate is provided as a facade for accessing acl based security related metadata info either through the local security manager or through the remote security service EJB

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

boolean	addAccessRightMeta(EbiContext context, EbiAccessRightMeta meta) Adds the access right meta for a supported element type.
EbiAccessRightMeta	createAccessRightMeta() Gets a new AccessRight meta object for use in AccessRight meta creation.
EbiAccessRightMeta	getAccessRightMeta(EbiContext context, String elementType) Gets an access right meta for a supported element type in readonly mode.
EbiAccessRightMeta	getClonedAccessRightMeta(EbiContext context, String elementType) Gets an access right meta for a supported element type for modification.
EbiElementTypeMeta	getClonedElementTypeMeta(EbiContext context) Gets the EbiElementTypeMeta object for modification.
EbiPermissionMeta	getClonedPermissionMeta(EbiContext context) Gets the permission meta for the framework for modification.
EbiElementTypeMeta	getElementTypeMeta(EbiContext context) Gets the EbiElementTypeMeta object in readonly mode.
EbiPermissionMeta	getPermissionMeta(EbiContext context) Gets the permission meta for the framework in readonly mode.
String[]	getSupportedElementTypes(EbiContext context) Gets an array of element types that support ACLs.
boolean	modifyAccessRightMeta(EbiContext context, EbiAccessRightMeta meta) Modifies the access right meta for a supported element type.
boolean	modifyElementTypeMeta(EbiContext context, EbiElementTypeMeta elemTypeMeta) Modifies the EbiElementTypeMeta object.
boolean	modifyPermissionMeta(EbiContext context, EbiPermissionMeta meta) Modifies the permission meta for the framework.
boolean	removeAccessRightMeta(EbiContext context, String elementType) Removes the access right meta for a supported element type.
boolean	validateElementType(EbiContext context, String elementType) Validates a given framework element type.

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

getName

Method Detail

validateElementType

public boolean validateElementType(EbiContext context,
                                   String elementType)
                            throws EboUnrecoverableSystemException

Validates a given framework element type.

Parameters:

context - an EbiContext object.

elementType - a framework element type.

Returns:

true if the framework element type is supported, false otherwise.

getSupportedElementTypes

public String[] getSupportedElementTypes(EbiContext context)
                                  throws EboUnrecoverableSystemException

Gets an array of element types that support ACLs.

Parameters:

context - an EbiContext object.

Returns:

an array of element types.

getElementTypeMeta

public EbiElementTypeMeta getElementTypeMeta(EbiContext context)
                                      throws EboUnrecoverableSystemException

Gets the EbiElementTypeMeta object in readonly mode.

Parameters:

context - an EbiContext object.

Returns:

an EbiElementTypeMeta object.

getClonedElementTypeMeta

public EbiElementTypeMeta getClonedElementTypeMeta(EbiContext context)
                                            throws EboUnrecoverableSystemException

Gets the EbiElementTypeMeta object for modification.

Parameters:

context - an EbiContext object.

Returns:

an EbiElementTypeMeta object.

modifyElementTypeMeta

public boolean modifyElementTypeMeta(EbiContext context,
                                     EbiElementTypeMeta elemTypeMeta)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Modifies the EbiElementTypeMeta object.

Parameters:

context - an EbiContext object.

elemTypeMeta - a modified EbiElementTypeMeta object.

Returns:

true if the element type meta is updated successfully.

getPermissionMeta

public EbiPermissionMeta getPermissionMeta(EbiContext context)
                                    throws EboUnrecoverableSystemException

Gets the permission meta for the framework in readonly mode.

Parameters:

context - an EbiContext object.

Returns:

an EbiPermissionMeta object that contains the permission meta for the framework.

getClonedPermissionMeta

public EbiPermissionMeta getClonedPermissionMeta(EbiContext context)
                                          throws EboUnrecoverableSystemException

Gets the permission meta for the framework for modification.

Parameters:

context - an EbiContext object.

Returns:

an EbiPermissionMeta object that contains the permission meta for the framework.

modifyPermissionMeta

public boolean modifyPermissionMeta(EbiContext context,
                                    EbiPermissionMeta meta)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Modifies the permission meta for the framework. (add/modify/remove customized permissions)

Parameters:

context - an EbiContext object.

meta - an EbiPermissionMeta object.

Returns:

true if the permission description is modified successfully, false otherwise.

getAccessRightMeta

public EbiAccessRightMeta getAccessRightMeta(EbiContext context,
                                             String elementType)
                                      throws EboUnrecoverableSystemException

Gets an access right meta for a supported element type in readonly mode.

Parameters:

context - an EbiContext object.

element - type a supported element type.

Returns:

an EbiAccessRightMeta object for the supported element type.

getClonedAccessRightMeta

public EbiAccessRightMeta getClonedAccessRightMeta(EbiContext context,
                                                   String elementType)
                                            throws EboUnrecoverableSystemException

Gets an access right meta for a supported element type for modification.

Parameters:

context - an EbiContext object.

element - type a supported element type.

Returns:

an EbiAccessRightMeta object for the supported element type.

addAccessRightMeta

public boolean addAccessRightMeta(EbiContext context,
                                  EbiAccessRightMeta meta)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Adds the access right meta for a supported element type.

Parameters:

context - an EbiContext object.

meta - an EbiAccessRightMeta object for the element type.

modifyAccessRightMeta

public boolean modifyAccessRightMeta(EbiContext context,
                                     EbiAccessRightMeta meta)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Modifies the access right meta for a supported element type.

Parameters:

context - an EbiContext object.

meta - an EbiAccessRightMeta object for the element type.

removeAccessRightMeta

public boolean removeAccessRightMeta(EbiContext context,
                                     String elementType)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Removes the access right meta for a supported element type.

Parameters:

context - an EbiContext object.

elementType - a supported element type.

createAccessRightMeta

public EbiAccessRightMeta createAccessRightMeta()
                                         throws EboUnrecoverableSystemException,
                                                EboSecurityException

Gets a new AccessRight meta object for use in AccessRight meta creation.

Returns:

a new EbiAccessRightMeta object.