Package com.atlassian.confluence.plugin.descriptor.web

Class DefaultWebInterfaceContext

java.lang.Object

com.atlassian.confluence.plugin.descriptor.web.DefaultWebInterfaceContext

All Implemented Interfaces:

ContextMap<String,Object>, WebInterfaceContext, Map<String,Object>

@ParametersAreNonnullByDefault
public class DefaultWebInterfaceContext
extends Object
implements WebInterfaceContext

Implementation which stores everything in a map for easy conversion and copying, if not type safety.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from interface com.atlassian.confluence.plugin.descriptor.web.WebInterfaceContext

CONTEXT_KEY_ATTACHMENT, CONTEXT_KEY_COMMENT, CONTEXT_KEY_CONTENT_DRAFT, CONTEXT_KEY_DRAFT, CONTEXT_KEY_EDIT_PAGE_RESTRICTED, CONTEXT_KEY_LABEL, CONTEXT_KEY_PAGE, CONTEXT_KEY_PARENT_PAGE, CONTEXT_KEY_PERSONAL_INFORMATION, CONTEXT_KEY_SPACE, CONTEXT_KEY_SPACE_ID, CONTEXT_KEY_SPACE_KEY, CONTEXT_KEY_TARGET_USER, CONTEXT_KEY_USER

Constructor Summary

Constructors

Constructor	Description
DefaultWebInterfaceContext()

Method Summary

Modifier and Type	Method	Description
static DefaultWebInterfaceContext	copyOf(WebInterfaceContext webInterfaceContext)
static DefaultWebInterfaceContext	createFrom(Map<String,?> contextMap)	Creates a new DefaultWebInterfaceContext with a copy of the data from another context map.
@Nullable Attachment	getAttachment()	Returns the attachment related to the web interface state, or null if there is no attachment.
@Nullable Comment	getComment()	Returns the comment related to the web interface state, or null if there is no comment.
@Nullable ContentEntityObject	getContentDraft()	Deprecated. since 5.9.
@Nullable ConfluenceUser	getCurrentUser()
@Nullable Draft	getDraft()	Deprecated. since 5.9.
@Nullable DisplayableLabel	getLabel()	Returns the label related to the web interface state, or null if there is no label.
@Nullable AbstractPage	getPage()	Returns the page related to the web interface state, or null if there is no page.
@Nullable Object	getParameter(String key)	Returns a custom parameter, or null if the parameter has not been set.
@Nullable AbstractPage	getParentPage()	Returns the parent page related to the web interface state, or null if there is no parent page.
@Nullable PersonalInformation	getPersonalInformation()	Returns the personal information (i.e.
@Nullable Space	getSpace()	Returns the space related to the web interface state, or null if there is no space.
Optional<Long>	getSpaceId()	Returns the space-id of the space related to the web interface state, if such space exists.
@Nullable String	getSpaceKey()	Returns the space-key related to the web interface state, or null if there is no space-key.
@Nullable ConfluenceUser	getTargetedUser()
boolean	hasParameter(String key)	Returns true if the parameter has been set (even if it is set to null).
boolean	isEditPageRestricted()	Deprecated. since 5.9.
DefaultWebInterfaceContext	putAllMissing(WebInterfaceContext source)	Put all missing parameters from source into current web interface context
void	setAttachment(Attachment attachment)
void	setComment(Comment comment)
void	setCurrentUser(@Nullable ConfluenceUser user)	Set the current user on the context
void	setIsEditPageRestricted(boolean restricted)	Deprecated. since 5.9.
void	setLabel(DisplayableLabel label)
void	setPage(@Nullable AbstractPage page)
void	setParameter(String key, @Nullable Object value)
void	setParameters(Map<String,?> parameters)
void	setPersonalInformation(PersonalInformation personalInformation)
void	setSpace(@Nullable Space space)
void	setTargetedUser(@Nullable ConfluenceUser user)
Map<String,Object>	toMap()	Converts the parameters into a map using the "context keys" defined as constants in this class.
void	withLazyParameter(String key, Supplier<?> supplier)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.plugin.descriptor.web.ContextMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

DefaultWebInterfaceContext

public DefaultWebInterfaceContext()

Method Details

copyOf

public static DefaultWebInterfaceContext copyOf(WebInterfaceContext webInterfaceContext)

Since:

5.8

createFrom

public static DefaultWebInterfaceContext createFrom(Map<String,?> contextMap)

Creates a new DefaultWebInterfaceContext with a copy of the data from another context map. If the other context is also an implementation of DefaultWebInterfaceContext, then any lazy properties will be copied intact, and will not be evaluated.

Since:

5.8

getCurrentUser

public @Nullable ConfluenceUser getCurrentUser()

Specified by:

getCurrentUser in interface WebInterfaceContext

Returns:

the current user or null if there is no user logged in.

setCurrentUser

public void setCurrentUser(@Nullable ConfluenceUser user)

Set the current user on the context

Parameters:

user - the current user

Since:

5.2

getPage

public @Nullable AbstractPage getPage()

Description copied from interface: WebInterfaceContext

Returns the page related to the web interface state, or null if there is no page.

Specified by:

getPage in interface WebInterfaceContext

getDraft

@Deprecated
public @Nullable Draft getDraft()

Deprecated.

since 5.9. Use only if you still need access to legacy drafts, otherwise use getPage()

Description copied from interface: WebInterfaceContext

Returns a draft related to the web interface state, or null if there is no draft.

Specified by:

getDraft in interface WebInterfaceContext

getContentDraft

@Deprecated
public @Nullable ContentEntityObject getContentDraft()

Deprecated.

since 5.9. Use getPage()

Description copied from interface: WebInterfaceContext

Returns a draft related to the web interface state, or null if there is no draft.

Specified by:

getContentDraft in interface WebInterfaceContext

setPage

public void setPage(@Nullable AbstractPage page)

getSpace

public @Nullable Space getSpace()

Description copied from interface: WebInterfaceContext

Returns the space related to the web interface state, or null if there is no space.

Specified by:

getSpace in interface WebInterfaceContext

getSpaceId

public Optional<Long> getSpaceId()

Description copied from interface: WebInterfaceContext

Returns the space-id of the space related to the web interface state, if such space exists.

Specified by:

getSpaceId in interface WebInterfaceContext

getSpaceKey

public @Nullable String getSpaceKey()

Description copied from interface: WebInterfaceContext

Returns the space-key related to the web interface state, or null if there is no space-key.

Specified by:

getSpaceKey in interface WebInterfaceContext

setSpace

public void setSpace(@Nullable Space space)

getComment

public @Nullable Comment getComment()

Description copied from interface: WebInterfaceContext

Returns the comment related to the web interface state, or null if there is no comment.

Specified by:

getComment in interface WebInterfaceContext

setComment

public void setComment(Comment comment)

getLabel

public @Nullable DisplayableLabel getLabel()

Description copied from interface: WebInterfaceContext

Returns the label related to the web interface state, or null if there is no label.

Specified by:

getLabel in interface WebInterfaceContext

setLabel

public void setLabel(DisplayableLabel label)

getAttachment

public @Nullable Attachment getAttachment()

Description copied from interface: WebInterfaceContext

Returns the attachment related to the web interface state, or null if there is no attachment.

Specified by:

getAttachment in interface WebInterfaceContext

setAttachment

public void setAttachment(Attachment attachment)

getPersonalInformation

public @Nullable PersonalInformation getPersonalInformation()

Description copied from interface: WebInterfaceContext

Returns the personal information (i.e. user profile) that is related to the web interface state, or null if there is no personal information.

Specified by:

getPersonalInformation in interface WebInterfaceContext

setPersonalInformation

public void setPersonalInformation(PersonalInformation personalInformation)

getParameter

public @Nullable Object getParameter(String key)

Description copied from interface: WebInterfaceContext

Returns a custom parameter, or null if the parameter has not been set.

Specified by:

getParameter in interface WebInterfaceContext

hasParameter

public boolean hasParameter(String key)

Description copied from interface: WebInterfaceContext

Returns true if the parameter has been set (even if it is set to null). Useful for checking boolean custom parameters.

Specified by:

hasParameter in interface WebInterfaceContext

setParameter

public void setParameter(String key,
 @Nullable Object value)

setParameters

public void setParameters(Map<String,?> parameters)

withLazyParameter

public void withLazyParameter(String key,
 Supplier<?> supplier)

Since:

7.0.1

toMap

public Map<String,Object> toMap()

Description copied from interface: WebInterfaceContext

Converts the parameters into a map using the "context keys" defined as constants in this class. Parameters which have not been set may be omitted from the resulting map.

Specified by:

toMap in interface ContextMap<String,Object>

Specified by:

toMap in interface WebInterfaceContext

Returns:

mutable copy of the context map

getTargetedUser

public @Nullable ConfluenceUser getTargetedUser()

Specified by:

getTargetedUser in interface WebInterfaceContext

Returns:

the user targeted by the action, or null if there is none. The targeted user is the user the action is performing against, not necessarily the logged in user.

setTargetedUser

public void setTargetedUser(@Nullable ConfluenceUser user)

Parameters:

user - the user targeted by the current action.

Since:

5.2

setIsEditPageRestricted

@Deprecated
public void setIsEditPageRestricted(boolean restricted)

Deprecated.

since 5.9. Use proper permissions checks on the content

isEditPageRestricted

@Deprecated
public boolean isEditPageRestricted()

Deprecated.

since 5.9. Use proper permissions checks on the content

Description copied from interface: WebInterfaceContext

Indicates if the current edit page is restricted (i.e. has some kind of permissions in place).

Specified by:

isEditPageRestricted in interface WebInterfaceContext

getParentPage

public @Nullable AbstractPage getParentPage()

Description copied from interface: WebInterfaceContext

Returns the parent page related to the web interface state, or null if there is no parent page.

Specified by:

getParentPage in interface WebInterfaceContext

putAllMissing

public DefaultWebInterfaceContext putAllMissing(WebInterfaceContext source)

Put all missing parameters from source into current web interface context

Parameters:

source - which contains parameters to be copied in.

Returns:

current context

Since:

5.10