org.randombits.support.confluence

Class PageInfo

java.lang.Object

org.randombits.support.confluence.RequestInfo

org.randombits.support.confluence.PageInfo

Direct Known Subclasses:

MacroInfo

public class PageInfo
extends RequestInfo

Represents a page (or more specifically, a ContentEntityObject) execution context.

Author:

David Peterson

Constructor Summary

Constructors

Constructor and Description
PageInfo(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant, com.atlassian.confluence.core.ContentEntityObject content)
PageInfo(javax.servlet.http.HttpServletRequest req, com.atlassian.confluence.core.ContentEntityObject content)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Call this method to indicate the class can free up its resources.
com.atlassian.confluence.core.ContentEntityObject	getContent()
org.randombits.storage.Storage	getContentProperties() Returns a storage instance allowing access to the content properties for the current ContentEntityObject.
static com.atlassian.confluence.core.ContentEntityObject	getCurrentContent() Returns the current content that is being executed in a Macro environment.
com.atlassian.user.User	getCurrentUser()
com.atlassian.confluence.spaces.Space	getSpace() Returns the current space.
protected void	setContent(com.atlassian.confluence.core.ContentEntityObject content)

Methods inherited from class org.randombits.support.confluence.RequestInfo

finalize, getEnvironmentAssistant, getRequest, getRequestAttributes, getRequestParams, getSession, getSessionAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

PageInfo

public PageInfo(javax.servlet.http.HttpServletRequest req,
        com.atlassian.confluence.core.ContentEntityObject content)

PageInfo

public PageInfo(org.randombits.support.core.env.EnvironmentAssistant environmentAssistant,
        com.atlassian.confluence.core.ContentEntityObject content)

Method Detail

getCurrentContent

public static com.atlassian.confluence.core.ContentEntityObject getCurrentContent()

Returns the current content that is being executed in a Macro environment.

Returns:

The current content entity object.

setContent

protected void setContent(com.atlassian.confluence.core.ContentEntityObject content)

getContent

public com.atlassian.confluence.core.ContentEntityObject getContent()

Returns:

the ContentEntityObject this macro is being executed in.

getContentProperties

public org.randombits.storage.Storage getContentProperties()

Returns a storage instance allowing access to the content properties for the current ContentEntityObject. If the content entity object is not set, null is returned.

Returns:

The content property storage.

getSpace

public com.atlassian.confluence.spaces.Space getSpace()

Returns the current space.

Returns:

The current space.

getCurrentUser

public com.atlassian.user.User getCurrentUser()

close

public void close()

Description copied from class: RequestInfo

Call this method to indicate the class can free up its resources. Any call to methods on this instance after calling close may throw unexpected errors.

Overrides:

close in class RequestInfo