org.jasig.portlet.announcements.service

Class UserPermissionChecker

java.lang.Object

org.jasig.portlet.announcements.service.UserPermissionChecker

public final class UserPermissionChecker
extends Object

Author:

Erik A. Olsson (eolsson@uci.edu) $LastChangedBy$ $LastChangedDate$ 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_ROLE_NAME
static String	AUDIENCE_ROLE_NAME
static String	AUTHOR_ROLE_NAME
static String	GUEST_USERNAME
static String	MODERATOR_ROLE_NAME
static String	PORTAL_ADMIN_ROLE_NAME

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

PORTAL_ADMIN_ROLE_NAME

public static final String PORTAL_ADMIN_ROLE_NAME

See Also:

Constant Field Values

ADMIN_ROLE_NAME

public static final String ADMIN_ROLE_NAME

See Also:

Constant Field Values

MODERATOR_ROLE_NAME

public static final String MODERATOR_ROLE_NAME

See Also:

Constant Field Values

AUTHOR_ROLE_NAME

public static final String AUTHOR_ROLE_NAME

See Also:

Constant Field Values

AUDIENCE_ROLE_NAME

public static final String AUDIENCE_ROLE_NAME

See Also:

Constant Field Values

GUEST_USERNAME

public static final String GUEST_USERNAME

See Also:

Constant Field Values

Method Detail

inRoleForTopic

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

Parameters:

request -

role -

topic -

Returns:

true if the user in the PortletRequest has the role specified by the Topic

isPortalAdmin

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

isGuest

public boolean isGuest()

getUserName

public String getUserName()

Returns:

the userName

isAdmin

public boolean isAdmin()

Returns:

the admin

isModerator

public boolean isModerator()

Returns:

the moderator

isAuthor

public boolean isAuthor()

Returns:

the author

isAudience

public boolean isAudience()

Returns:

the audience

canEditTopic

public boolean canEditTopic()

validateCanEditTopic

public void validateCanEditTopic()