com.atlassian.confluence.plugin.descriptor.web
Interface WebInterfaceContext

All Known Implementing Classes:

DefaultWebInterfaceContext

public interface WebInterfaceContext

When rendering web fragments, this context is used for retrieval of Confluence content information. It can be converted to and from a Map to fit with the Condition and WebInterfaceManager interfaces. The map returned by toMap() is also used as a Velocity context for rendering URLs.

Parameters that are only used in a couple of places can be retrieved without type-safe accessors via getParameter(String) or hasParameter(String).

Since:

2.8

See Also:

BaseConfluenceCondition, ConfluenceWebInterfaceManager

Field Summary

static java.lang.String	CONTEXT_KEY_ATTACHMENT
static java.lang.String	CONTEXT_KEY_COMMENT
static java.lang.String	CONTEXT_KEY_DRAFT
static java.lang.String	CONTEXT_KEY_EDIT_PAGE_RESTRICTED
static java.lang.String	CONTEXT_KEY_LABEL
static java.lang.String	CONTEXT_KEY_PAGE
static java.lang.String	CONTEXT_KEY_PARENT_PAGE
static java.lang.String	CONTEXT_KEY_PERSONAL_INFORMATION
static java.lang.String	CONTEXT_KEY_SPACE
static java.lang.String	CONTEXT_KEY_SPACE_KEY
static java.lang.String	CONTEXT_KEY_TARGET_USER
static java.lang.String	CONTEXT_KEY_USER

Method Summary

Attachment	getAttachment() Returns the attachment related to the web interface state, or null if there is no attachment.
Comment	getComment() Returns the comment related to the web interface state, or null if there is no comment.
ConfluenceUser	getCurrentUser()
Draft	getDraft() Returns a draft related to the web interface state, or null if there is no draft.
DisplayableLabel	getLabel() Returns the label related to the web interface state, or null if there is no label.
AbstractPage	getPage() Returns the page related to the web interface state, or null if there is no page.
java.lang.Object	getParameter(java.lang.String key) Returns a custom parameter, or null if the parameter has not been set.
AbstractPage	getParentPage() Returns the parent page related to the web interface state, or null if there is no parent page.
PersonalInformation	getPersonalInformation() Returns the personal information (i.e.
Space	getSpace() Returns the space related to the web interface state, or null if there is no space.
java.lang.String	getSpaceKey() Returns the space-key related to the web interface state, or null if there is no space-key.
com.atlassian.user.User	getTargetUser() Returns the target user of the action, or null if there is no target user.
com.atlassian.user.User	getUser() Deprecated. since 5.2. See getCurrentUser() instead.
boolean	hasParameter(java.lang.String key) Returns true if the parameter has been set (even if it is set to null).
boolean	isEditPageRestricted() Indicates if the current edit page is restricted (i.e.
java.util.Map<java.lang.String,java.lang.Object>	toMap() Converts the parameters into a map using the "context keys" defined as constants in this class.

Field Detail

CONTEXT_KEY_USER

static final java.lang.String CONTEXT_KEY_USER

See Also:

Constant Field Values

CONTEXT_KEY_TARGET_USER

static final java.lang.String CONTEXT_KEY_TARGET_USER

See Also:

Constant Field Values

CONTEXT_KEY_PAGE

static final java.lang.String CONTEXT_KEY_PAGE

See Also:

Constant Field Values

CONTEXT_KEY_DRAFT

static final java.lang.String CONTEXT_KEY_DRAFT

See Also:

Constant Field Values

CONTEXT_KEY_SPACE

static final java.lang.String CONTEXT_KEY_SPACE

See Also:

Constant Field Values

CONTEXT_KEY_SPACE_KEY

static final java.lang.String CONTEXT_KEY_SPACE_KEY

See Also:

Constant Field Values

CONTEXT_KEY_COMMENT

static final java.lang.String CONTEXT_KEY_COMMENT

See Also:

Constant Field Values

CONTEXT_KEY_LABEL

static final java.lang.String CONTEXT_KEY_LABEL

See Also:

Constant Field Values

CONTEXT_KEY_ATTACHMENT

static final java.lang.String CONTEXT_KEY_ATTACHMENT

See Also:

Constant Field Values

CONTEXT_KEY_PERSONAL_INFORMATION

static final java.lang.String CONTEXT_KEY_PERSONAL_INFORMATION

See Also:

Constant Field Values

CONTEXT_KEY_EDIT_PAGE_RESTRICTED

static final java.lang.String CONTEXT_KEY_EDIT_PAGE_RESTRICTED

See Also:

Constant Field Values

CONTEXT_KEY_PARENT_PAGE

static final java.lang.String CONTEXT_KEY_PARENT_PAGE

See Also:

Constant Field Values

Method Detail

getUser

@Deprecated
com.atlassian.user.User getUser()

Deprecated. since 5.2. See getCurrentUser() instead.

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

getCurrentUser

ConfluenceUser getCurrentUser()

Returns:

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

Since:

5.2

getTargetUser

com.atlassian.user.User getTargetUser()

Returns the target user of the action, or null if there is no target user. The target user is the user the action is performing against, not necessarily the logged in user.

getPage

AbstractPage getPage()

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

getDraft

Draft getDraft()

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

getSpace

Space getSpace()

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

getSpaceKey

java.lang.String getSpaceKey()

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

getComment

Comment getComment()

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

getLabel

DisplayableLabel getLabel()

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

getAttachment

Attachment getAttachment()

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

getPersonalInformation

PersonalInformation getPersonalInformation()

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

getParameter

java.lang.Object getParameter(java.lang.String key)

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

hasParameter

boolean hasParameter(java.lang.String key)

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

toMap

java.util.Map<java.lang.String,java.lang.Object> toMap()

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.

isEditPageRestricted

boolean isEditPageRestricted()

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

getParentPage

AbstractPage getParentPage()

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