com.atlassian.jira.dashboard.permission

Class JiraGadgetPermissionManager

java.lang.Object

com.atlassian.jira.dashboard.permission.JiraGadgetPermissionManager

All Implemented Interfaces:

GadgetPermissionManager

public class JiraGadgetPermissionManager
extends Object
implements GadgetPermissionManager

Constructor Summary

Constructors

Constructor and Description
JiraGadgetPermissionManager(PermissionManager permissionManager, com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.gadgets.dashboard.spi.DashboardPermissionService permissionService, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
com.atlassian.gadgets.dashboard.DashboardState	filterGadgets(com.atlassian.gadgets.dashboard.DashboardState dashboardState, ApplicationUser remoteUser) Removes any gadgets a user doesn't have permission to see in the passed in dashboard state.
io.atlassian.fugue.Option<com.atlassian.gadgets.plugins.PluginGadgetSpec>	getPluginGadgetSpec(URI gadgetUri) Retrieve the equivalent of PluginGadgetSpec object from gadgetUri.
com.atlassian.gadgets.Vote	voteOn(com.atlassian.gadgets.plugins.PluginGadgetSpec pluginGadgetSpec, ApplicationUser remoteUser) Decides if a user has permission to view a particular gadget.

Methods inherited from class java.lang.Object

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

Constructor Detail

JiraGadgetPermissionManager

public JiraGadgetPermissionManager(PermissionManager permissionManager,
                                   com.atlassian.plugin.PluginAccessor pluginAccessor,
                                   com.atlassian.gadgets.dashboard.spi.DashboardPermissionService permissionService,
                                   com.atlassian.event.api.EventPublisher eventPublisher)

Method Detail

voteOn

public com.atlassian.gadgets.Vote voteOn(com.atlassian.gadgets.plugins.PluginGadgetSpec pluginGadgetSpec,
                                         ApplicationUser remoteUser)

Description copied from interface: GadgetPermissionManager

Decides if a user has permission to view a particular gadget.

Specified by:

voteOn in interface GadgetPermissionManager

Parameters:

pluginGadgetSpec - The gadget spec to check permissions for

remoteUser - The user viewing the dashboard. May be null for anonymous users

Returns:

Vote.DENY if the user doesn't have permission. Vote.ALLOW otherwise

filterGadgets

public com.atlassian.gadgets.dashboard.DashboardState filterGadgets(com.atlassian.gadgets.dashboard.DashboardState dashboardState,
                                                                    ApplicationUser remoteUser)

Description copied from interface: GadgetPermissionManager

Removes any gadgets a user doesn't have permission to see in the passed in dashboard state. This will only be done for dashboards where the user has read only permission. If the user has write permission, the gadget will be left in place, and the dashboard plugin will render a place holder with an appropriate error message. The user can the remove the gadget him/herself.

Specified by:

filterGadgets in interface GadgetPermissionManager

Parameters:

dashboardState - The dashboard state to filter

remoteUser - The user viewing the dashboard. May be null for anonymous users

Returns:

A filtered dashboardstate with any offending gadgets removed.

getPluginGadgetSpec

public io.atlassian.fugue.Option<com.atlassian.gadgets.plugins.PluginGadgetSpec> getPluginGadgetSpec(URI gadgetUri)

Description copied from interface: GadgetPermissionManager

Retrieve the equivalent of PluginGadgetSpec object from gadgetUri.

Specified by:

getPluginGadgetSpec in interface GadgetPermissionManager

Parameters:

gadgetUri - The url to be used to retrieve the PluginGadgetSpec object.

Returns:

Either a PluginGadgetSpec if it exists, otherwise nothing.