org.jasig.portlet.announcements.service

Class UserPermissionChecker

java.lang.Object

org.jasig.portlet.announcements.service.UserPermissionChecker

All Implemented Interfaces:

UserRoles

public final class UserPermissionChecker
extends Object
implements UserRoles

Utility class that can be used statically to check role membership of a Topic, or when instantiated, can be used inside a JSP for example to check role membership as it relates to a specific Topic.

Version:

$Id: $Id

Author:

Erik A. Olsson (eolsson@uci.edu)

Field Summary

Fields inherited from interface org.jasig.portlet.announcements.model.UserRoles

ADMIN_ROLE_NAME, AUDIENCE_ROLE_NAME, AUTHOR_ROLE_NAME, MODERATOR_ROLE_NAME, PORTAL_ADMIN_ROLE_NAME

Method Summary

Modifier and Type	Method and Description
boolean	canEditTopic() canEditTopic.
String	getUserName() Used in JSPs.
static boolean	inRoleForTopic(javax.portlet.PortletRequest request, String role, Topic topic) inRoleForTopic.
boolean	isAdmin() Used in JSPs.
boolean	isAudience() isAudience.
boolean	isAuthor() isAuthor.
boolean	isGuest() isGuest.
boolean	isModerator() isModerator.
static boolean	isPortalAdmin(javax.portlet.PortletRequest request) isPortalAdmin.
void	validateCanEditTopic() validateCanEditTopic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

inRoleForTopic

public static boolean inRoleForTopic(javax.portlet.PortletRequest request,
                                     String role,
                                     Topic topic)

inRoleForTopic.

Parameters:

request - a PortletRequest object.

role - a String object.

topic - a Topic object.

Returns:

a boolean.

isPortalAdmin

public static boolean isPortalAdmin(javax.portlet.PortletRequest request)

isPortalAdmin.

Parameters:

request - a PortletRequest object.

Returns:

a boolean.

isGuest

public boolean isGuest()

isGuest.

Returns:

a boolean.

getUserName

public String getUserName()

Used in JSPs.

Returns:

the userName

isAdmin

public boolean isAdmin()

Used in JSPs.

Returns:

the admin

isModerator

public boolean isModerator()

isModerator.

Returns:

a boolean.

isAuthor

public boolean isAuthor()

isAuthor.

Returns:

a boolean.

isAudience

public boolean isAudience()

isAudience.

Returns:

a boolean.

canEditTopic

public boolean canEditTopic()

canEditTopic.

Returns:

a boolean.

validateCanEditTopic

public void validateCanEditTopic()

validateCanEditTopic.