uk.ac.cam.caret.sakai.rwiki.service.api

Interface RWikiSecurityService

public interface RWikiSecurityService

Field Summary

Fields

Modifier and Type	Field and Description
static String	SECURE_ADMIN Security function name for admin.
static String	SECURE_CREATE Security function name for create. required to create
static String	SECURE_DELETE Security function name for delete. required to delete
static String	SECURE_READ Security function name for read. required to read
static String	SECURE_SUPER_ADMIN Security function name for admin.
static String	SECURE_UPDATE Security function name for update. required to update

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkAdmin(RWikiEntity rwe) check for admin permission
boolean	checkAdminPermission(String reference) Check for admin permission (rwiki.admin) on the reference which must point to a resolvable entity.
boolean	checkCreatePermission(String reference) Check for super create permission (rwiki.create) on the reference which must point to a resolvable entity.
boolean	checkGetPermission(String reference) Check for get permission (rwiki.read) on the reference which must point to a resolvable entity.
boolean	checkRead(RWikiEntity rwe) Check for read permission
boolean	checkSearchPermission(String reference) Check for search permission (rwiki.search) on the reference which must point to a resolvable entity.
boolean	checkSuperAdminPermission(String reference) Check for super admin permission (rwiki.superadmin) on the reference which must point to a resolvable entity.
boolean	checkUpdate(RWikiEntity rwe) check for update permission
boolean	checkUpdatePermission(String reference) Check for update permission (rwiki.update) on the reference which must point to a resolvable entity.
String	createPermissionsReference(String pageSpace) generate a default reference to a permission from the page space URL
String	getSiteId() Get the current site ID
String	getSiteReference() Get the current site reference, must be called in a request cycle to work

Field Detail

SECURE_CREATE

static final String SECURE_CREATE

Security function name for create. required to create

See Also:

Constant Field Values

SECURE_READ

static final String SECURE_READ

Security function name for read. required to read

See Also:

Constant Field Values

SECURE_UPDATE

static final String SECURE_UPDATE

Security function name for update. required to update

See Also:

Constant Field Values

SECURE_DELETE

static final String SECURE_DELETE

Security function name for delete. required to delete

See Also:

Constant Field Values

SECURE_SUPER_ADMIN

static final String SECURE_SUPER_ADMIN

Security function name for admin. Having this overrides for the site

See Also:

Constant Field Values

SECURE_ADMIN

static final String SECURE_ADMIN

Security function name for admin. Having this is required to do admin on objects

See Also:

Constant Field Values

Method Detail

getSiteReference

String getSiteReference()

Get the current site reference, must be called in a request cycle to work

Returns:

checkGetPermission

boolean checkGetPermission(String reference)

Check for get permission (rwiki.read) on the reference which must point to a resolvable entity. This check is performed for the current user

Parameters:

reference -

Returns:

checkUpdatePermission

boolean checkUpdatePermission(String reference)

Check for update permission (rwiki.update) on the reference which must point to a resolvable entity. This check is performed for the current user

Parameters:

reference -

Returns:

checkAdminPermission

boolean checkAdminPermission(String reference)

Check for admin permission (rwiki.admin) on the reference which must point to a resolvable entity. This check is performed for the current user

Parameters:

reference -

Returns:

checkSuperAdminPermission

boolean checkSuperAdminPermission(String reference)

Check for super admin permission (rwiki.superadmin) on the reference which must point to a resolvable entity. This check is performed for the current user

Parameters:

reference -

Returns:

checkCreatePermission

boolean checkCreatePermission(String reference)

Check for super create permission (rwiki.create) on the reference which must point to a resolvable entity. This check is performed for the current user

Parameters:

reference -

Returns:

checkSearchPermission

boolean checkSearchPermission(String reference)

Check for search permission (rwiki.search) on the reference which must point to a resolvable entity. This check is performed for the current user

Parameters:

reference -

Returns:

getSiteId

String getSiteId()

Get the current site ID

Returns:

createPermissionsReference

String createPermissionsReference(String pageSpace)

generate a default reference to a permission from the page space URL

Parameters:

pageSpace -

Returns:

checkRead

boolean checkRead(RWikiEntity rwe)

Check for read permission

Parameters:

rwo -

user -

Returns:

checkUpdate

boolean checkUpdate(RWikiEntity rwe)

check for update permission

Parameters:

rwo -

user -

Returns:

checkAdmin

boolean checkAdmin(RWikiEntity rwe)

check for admin permission

Parameters:

rwo -

user -

Returns: