com.fatwire.assetapi.site

Interface PermissionManager

public interface PermissionManager

Interface that handles Content Server user access permissions for Asset and Asset Type

Method Summary

Modifier and Type	Method and Description
List<SAFEPermission>	getSAFEPermissions(AssetId asset) Retrieves the list of SAFE permissions defined for this asset
boolean	isAssetPermissionGranted(String site, String assettype, String subtype, String user, Permission.AssetFunctionEnum function) Checks whether user has the start menu permission for the given site, aset type, subtype; there is no corresponding set method in this API because the start menu permissions are decided by user Roles in the site, so it will be changed by changing the user Roles
boolean	isSAFEPermissionGranted(String site, AssetId asset, String user, Permission.AssetSafeFunctionEnum function) Checks whether the user has SAFE permission for the given asset in the given site
List<CCFunction>	listFunctions() Gets the list of CCFunctions defined in Content Server
void	setSAFEPermission(String site, AssetId asset, List<SAFEPermission> permissions) Set the user's SAFE permission for the given site, asset, and function

Method Detail

isSAFEPermissionGranted

boolean isSAFEPermissionGranted(String site,
                                AssetId asset,
                                String user,
                                Permission.AssetSafeFunctionEnum function)
                         throws SiteAccessException

Checks whether the user has SAFE permission for the given asset in the given site

Parameters:

site - the Content Server site name to check the permission for

asset - the AssetId to check the permission for

user - the String format user id to check the permission for

function - the SAFE function to check the permision for

Returns:

true indicates that the user has the permission; false indicates otherwise

Throws:

SiteAccessException - throw Exception if error met in checking the permission

getSAFEPermissions

List<SAFEPermission> getSAFEPermissions(AssetId asset)
                                 throws SiteAccessException

Retrieves the list of SAFE permissions defined for this asset

Parameters:

asset - the asset to retrieve the SAFE permissions for

Returns:

the list of SAFE permissions

Throws:

SiteAccessException - throw this Excepiton if errors met

setSAFEPermission

void setSAFEPermission(String site,
                       AssetId asset,
                       List<SAFEPermission> permissions)
                throws SiteAccessException

Set the user's SAFE permission for the given site, asset, and function

Parameters:

site - the Content Server site name to set the permission for

asset - the AssetId to set the permission for

permissions - the list of permissions to set

Throws:

SiteAccessException - throw this Excepiton if errors met

isAssetPermissionGranted

boolean isAssetPermissionGranted(String site,
                                 String assettype,
                                 String subtype,
                                 String user,
                                 Permission.AssetFunctionEnum function)
                          throws SiteAccessException

Checks whether user has the start menu permission for the given site, aset type, subtype; there is no corresponding set method in this API because the start menu permissions are decided by user Roles in the site, so it will be changed by changing the user Roles

Parameters:

site - the Content Server site to check the start menu permission for

assettype - the asset type to check the permission for

subtype - the asset subtype to check the permission for

user - the String format user id to check the permission for

function - the start menu function to check (NEW OR SEARCH)

Returns:

true indicates the user will have the permission; false indicates otherwise

Throws:

SiteAccessException - throw Exception if errors met

listFunctions

List<CCFunction> listFunctions()
                        throws SiteAccessException

Gets the list of CCFunctions defined in Content Server

Returns:

the list of CCFunctions

Throws:

SiteAccessException - throws this exception if error met