com.atlassian.confluence.labels
Class LabelPermissionSupport

java.lang.Object
  com.atlassian.confluence.labels.LabelPermissionSupport

public class LabelPermissionSupport
extends Object

Performs permission checking for label editing actions

Constructor Summary

LabelPermissionSupport()

Method Summary

static List	filterLabelsByNamespace(List labelList, com.atlassian.user.User user, Namespace namespace) Takes a list of label objects and filters out those not in the specified namespace
static List	filterVisibleLabels(List labelList, com.atlassian.user.User user, boolean hideSpecialLables) Takes a list of label objects and filters out those not visible to the given user
static boolean	isLabelableByUser(Labelable object, PermissionManager permissionManager) Checks that the object permits labels to be edited by the logged in user.
static boolean	userCanEditLabel(Label label, Labelable object, PermissionManager permissionManager)
static boolean	userCanEditLabel(ParsedLabelName ref, Labelable object, PermissionManager permissionManager)
static boolean	userCanEditLabels(Labelable object, PermissionManager permissionManager) Deprecated. since 3.1 use isLabelableByUser Checks that the object permits labels to be edited for this user.
static boolean	userCanViewObject(Labelable object, PermissionManager permissionManager)

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelPermissionSupport

public LabelPermissionSupport()

Method Detail

isLabelableByUser

public static boolean isLabelableByUser(Labelable object,
                                        PermissionManager permissionManager)

Checks that the object permits labels to be edited by the logged in user.

Parameters:

object - - the object to be labelled, if null returns false.

permissionManager - - permission manaager to use

Returns:

true if permitted.

userCanEditLabels

@Deprecated
public static boolean userCanEditLabels(Labelable object,
                                                   PermissionManager permissionManager)

Deprecated. since 3.1 use isLabelableByUser Checks that the object permits labels to be edited for this user.

Parameters:

object - - the object to be labelled, if null returns false.

permissionManager - - permission manaager to use

Returns:

true if permitted.

userCanEditLabel

public static boolean userCanEditLabel(ParsedLabelName ref,
                                       Labelable object,
                                       PermissionManager permissionManager)

userCanEditLabel

public static boolean userCanEditLabel(Label label,
                                       Labelable object,
                                       PermissionManager permissionManager)

userCanViewObject

public static boolean userCanViewObject(Labelable object,
                                        PermissionManager permissionManager)

filterVisibleLabels

public static List filterVisibleLabels(List labelList,
                                       com.atlassian.user.User user,
                                       boolean hideSpecialLables)

Takes a list of label objects and filters out those not visible to the given user

Parameters:

labelList - a list of Label objects

user - the User the labels are filtered for

hideSpecialLables - whether to hide special labels, such as favourites

Returns:

a filtered list of Label objects

filterLabelsByNamespace

public static List filterLabelsByNamespace(List labelList,
                                           com.atlassian.user.User user,
                                           Namespace namespace)

Takes a list of label objects and filters out those not in the specified namespace

Parameters:

labelList - a list of Label objects

user - the User the labels are filtered for

namespace - the Namespace to filter by

Returns:

a filtered list of Label objects