com.sssw.fw.security.api
Interface EbiSecurityAclDelegate

All Superinterfaces:

EbiDelegate

public interface EbiSecurityAclDelegate

extends EbiDelegate

The security acl delegate is provided as a facade for accessing security acls 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	addAcl(EbiContext context, String elementIID, String elementType, com.sssw.fw.security.api.Acl acl) adds the acl of a framework element.
boolean	addPrincipalsToAcl(EbiContext context, String elementIID, String elementType, String right, Principal[] principals) Add/Update Principals for a permission of an element.
boolean	addPrincipalsToAcl(EbiContext context, String elementIID, String elementType, String right, String[] prinUUIDs, String prinType) Add/Update Principals for a permission of an element.
boolean	checkRestrictedAccess(EbiContext context, String elementIID, String elementType, String right) Checks to see if an element permission has restricted access.
Acl	getAcl(EbiContext context, String elementIID, String elementType) Gets an acl object for a framework element.
Principal[]	getPrincipalsFromAcl(EbiContext context, String elementIID, String elementType, String right) Gets a list of Principals that have a specified permission for a specified element.
boolean	modifyAcl(EbiContext context, String elementIID, String elementType, com.sssw.fw.security.api.Acl acl) Modifies the acl of a framework element.
boolean	removeAcl(EbiContext context, String elementIID, String elementType) Removes the acl for a framework element.
boolean	removeElementAclForPermission(EbiContext context, String elementIID, String elementType, String right, boolean isRestricted) Removes acl completely for a specified element permission.
boolean	removePrincipalFromAcls(EbiContext context, String prinIID, String prinType) Removes all permissions for a principal.
boolean	removePrincipalsFromAcl(EbiContext context, String elementIID, String elementType, String right, Principal[] prinlist) Remove Principals for a permission of an object.
boolean	removePrincipalsFromAcl(EbiContext context, String elementIID, String elementType, String right, String[] prinUUIDs, String prinType) Remove Principals for a permission of an object.
boolean	setAcl(EbiContext context, String elementIID, String elementType, com.sssw.fw.security.api.Acl acl) Sets the acl for a framework element.
boolean	setRestrictedAccess(EbiContext context, String elementIID, String elementType, String right) Sets an element permission to have restricted access.
boolean	setUnRestrictedAccess(EbiContext context, String elementIID, String elementType, String right) Resets an element permission to be unrestricted access.

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

getName

Method Detail

checkRestrictedAccess

public boolean checkRestrictedAccess(EbiContext context,
                                     String elementIID,
                                     String elementType,
                                     String right)
                              throws EboUnrecoverableSystemException

Checks to see if an element permission has restricted access. (i.e., no one except system administrators can access)

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission.

Returns:

true if the permission is restricted.

setRestrictedAccess

public boolean setRestrictedAccess(EbiContext context,
                                   String elementIID,
                                   String elementType,
                                   String right)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException

Sets an element permission to have restricted access. (i.e., no one except system administrators can access the specified element.)

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission.

Returns:

true if the permission access is set successfully.

setUnRestrictedAccess

public boolean setUnRestrictedAccess(EbiContext context,
                                     String elementIID,
                                     String elementType,
                                     String right)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Resets an element permission to be unrestricted access. (i.e., everyone has the permission to access the specified element.)

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission.

Returns:

true if the permission access is set successfully.

Since:

v5.0

getPrincipalsFromAcl

public Principal[] getPrincipalsFromAcl(EbiContext context,
                                        String elementIID,
                                        String elementType,
                                        String right)
                                 throws EboUnrecoverableSystemException

Gets a list of Principals that have a specified permission for a specified element.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element

right - an access right permission. (e.g., EboPermission.READ)

Returns:

a list of Principal objects that are in the acl for this element.

addPrincipalsToAcl

public boolean addPrincipalsToAcl(EbiContext context,
                                  String elementIID,
                                  String elementType,
                                  String right,
                                  Principal[] principals)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Add/Update Principals for a permission of an element.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission. (e.g., EboPermission.READ)

principals - an array of Principal objects to be added.

Returns:

true if the acl for the element is changed successfully.

addPrincipalsToAcl

public boolean addPrincipalsToAcl(EbiContext context,
                                  String elementIID,
                                  String elementType,
                                  String right,
                                  String[] prinUUIDs,
                                  String prinType)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Add/Update Principals for a permission of an element.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission. (e.g., EboPermission.READ)

prinUUIDs - an array of Principal UUIDs to be added. The principal objects provided in the array must have the principal type specified below.

prinType - a principal type for the list of principal UUIDs.

Returns:

true if the acl for the element is changed successfully.

removePrincipalsFromAcl

public boolean removePrincipalsFromAcl(EbiContext context,
                                       String elementIID,
                                       String elementType,
                                       String right,
                                       Principal[] prinlist)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Remove Principals for a permission of an object.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission. (e.g., EboPermission.READ)

principals - an array of Principals be to removed.

Returns:

true if the Principals are removed successfully.

removePrincipalsFromAcl

public boolean removePrincipalsFromAcl(EbiContext context,
                                       String elementIID,
                                       String elementType,
                                       String right,
                                       String[] prinUUIDs,
                                       String prinType)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Remove Principals for a permission of an object.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission. (e.g., EboPermission.READ)

prinUUIDs - an array of Principal UUIDs to be removed. The principal object provided in the array must have the principal type specified below.

prinType - a principal type for the list of principal UUIDs.

Returns:

true if the Principals are removed successfully.

removePrincipalFromAcls

public boolean removePrincipalFromAcls(EbiContext context,
                                       String prinIID,
                                       String prinType)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Removes all permissions for a principal.

Parameters:

context - an EbiContext object.

prinIID - a principal UUID.

prinType - type of Principal.

Returns:

true if the permissions are removed successfully.

removeElementAclForPermission

public boolean removeElementAclForPermission(EbiContext context,
                                             String elementIID,
                                             String elementType,
                                             String right,
                                             boolean isRestricted)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Removes acl completely for a specified element permission.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

right - an access right permission. (e.g., EboPermission.READ)

isRestricted - set the specified element permission to be restricted.

Returns:

true if the principals for a specified element's permission are removed successfully.

getAcl

public Acl getAcl(EbiContext context,
                  String elementIID,
                  String elementType)
           throws EboUnrecoverableSystemException

Gets an acl object for a framework element.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

Returns:

an acl object for specified object.

addAcl

public boolean addAcl(EbiContext context,
                      String elementIID,
                      String elementType,
                      com.sssw.fw.security.api.Acl acl)
               throws EboUnrecoverableSystemException,
                      EboSecurityException

adds the acl of a framework element.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type for the specified element.

acl - the acl object for the element.

Returns:

true if the acl for the element is added successfully.

modifyAcl

public boolean modifyAcl(EbiContext context,
                         String elementIID,
                         String elementType,
                         com.sssw.fw.security.api.Acl acl)
                  throws EboUnrecoverableSystemException,
                         EboSecurityException

Modifies the acl of a framework element.

Parameters:

context - an EbiContext object.

elementIID - an element UUID.

elementType - an element type.

acl - the acl object for the element.

Returns:

true if the acl for the element is changed successfully.

setAcl

public boolean setAcl(EbiContext context,
                      String elementIID,
                      String elementType,
                      com.sssw.fw.security.api.Acl acl)
               throws EboUnrecoverableSystemException,
                      EboSecurityException

Sets the acl for a framework element.

Parameters:

context - an EbiContext object.

elementIID - an element IID.

elementType - an element type.

acl - the acl object for the element.

Returns:

true if the acl for the element is added successfully.

removeAcl

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

Removes the acl for a framework element.

Parameters:

context - an EbiContext object.

elementIID - an element IID.

elementType - an element type.

Returns:

true if the acl for the element is removed successfully.