com.atlassian.confluence.api.model.permissions

Class Target

java.lang.Object

com.atlassian.confluence.api.model.permissions.Target

Direct Known Subclasses:

Target.ContainerTarget, Target.ModelObjectTarget

@ExperimentalApi
public abstract class Target
extends Object

The target for an operation permissions check.

Since:

5.8

See Also:

OperationService, OperationCheck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Target.ContainerTarget A target for a container being used to check operations on a different target type within it.
static class	Target.ModelObjectTarget A target that points to a single model object, e.g.

Field Summary

Fields

Modifier and Type	Field and Description
protected TargetType	targetType

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static Target	forChildrenOfContainer(Container container, TargetType childTargetType) Create a Target for a container being used to check operations on a different child TargetType within it.
static Target	forModelObject(Object modelObject) Create a Target that points to a single model object, e.g.
TargetType	getTargetType() Get the TargetType for this model object.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

targetType

protected final TargetType targetType

Method Detail

forModelObject

public static Target forModelObject(Object modelObject)

Create a Target that points to a single model object, e.g. a Content.

Parameters:

modelObject - an API-layer model object (for example, a Content)

Throws:

IllegalArgumentException - if modelObject is an unsupported type

forChildrenOfContainer

public static Target forChildrenOfContainer(Container container,
                                            TargetType childTargetType)

Create a Target for a container being used to check operations on a different child TargetType within it.

For example, a ContentType.PAGE container used to check operations on contained TargetType.COMMENTs.

Parameters:

container - an API-layer model object (for example, a Content) that is a container of other targets

childTargetType - the TargetType (different from that of the container) whose permissions will be checked within the container

Throws:

IllegalArgumentException - if container is an unsupported type

getTargetType

@Nonnull
public final TargetType getTargetType()

Get the TargetType for this model object.

This determines the type of OperationCheck to perform.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object