JetspeedPowerTool (Jetspeed-2 Core API 2.3.1 API)

```
public interface JetspeedPowerTool
```
JetspeedPowerTool

Version:

$Id: JetspeedPowerTool.java 516448 2007-03-09 16:25:47Z ate $

Author:

David Sean Taylor

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DECORATOR_TYPE`
`static String`	`FRAGMENT_ATTR`
`static String`	`FRAGMENT_PROCESSING_ERROR_PREFIX`
`static String`	`GENERIC_TEMPLATE_TYPE`
`static String`	`HIDDEN`
`static String`	`LAYOUT_ATTR`
`static String`	`LAYOUT_TEMPLATE_TYPE`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`decorateAndInclude(ContentFragment fragment)` Decorate and include fragment content.
`String`	`getAbsoluteUrl(String relativePath)` Return the absolute portal URL from a given relative url
`String`	`getBasePath()` Gets the Portal Base Path
`List[]`	`getColumns()` Deprecated.
`List<String>`	`getColumnSizes()` For tabular layouts, return the column sizes, usually as percentages but can be any table sizing such pixels
`Object`	`getComponent(String name)` Shortcut convenience method to lookup a Jetspeed service via `ComponentManagement.lookupComponent(Class)`
`ContentFragment`	`getCurrentFragment()` The Power Tool tracks which fragment is being rendered.
`ContentFragment`	`getCurrentLayout()` The Power Tool tracks which layout is being rendered.
`TemplateDescriptor`	`getDecoration(String path, String templateType)` Retrieves a decorator using the Jetspeed template locator algorithm
`List<DecoratorAction>`	`getDecoratorActions()` Gets the list of decorator actions for a window.
`String`	`getElementHtmlString(HeadElement element)` Returns string representation of a head HTML DOM element
`List<KeyValue<String,HeadElement>>`	`getHeadElements()` Returns all the contributed head elements from the current fragment and its child fragments.
`List<KeyValue<String,HeadElement>>`	`getHeadElements(ContentFragment fragment)` Returns all the contributed head elements from the fragment and its child fragments.
`boolean`	`getLoggedOn()` Is the current request being made by a logged on user
`javax.portlet.PortletMode`	`getMappedPortletMode()` Gets the internal (portal) portlet mode for a current portlet window (fragment)
`javax.portlet.WindowState`	`getMappedWindowState()` Gets the internal (portal) window state for the current portlet window (fragment)
`ContentPage`	`getPage()` The Power Tool tracks which page is being rendered.
`String`	`getPageBasePath()` Returns the current Portal Page base path without possible encoded NavigationalState parameter.
`List<DecoratorAction>`	`getPageDecoratorActions()` Gets the list of decorator actions for a page.
`PortalConfiguration`	`getPortalConfiguration()` Helper to retrieve the `PortalConfiguration`
`javax.portlet.PortletMode`	`getPortletMode()` Gets the portlet mode for a current portlet window (fragment)
`PortletWindow`	`getPortletWindow(ContentFragment fragment)` Return the associated PortletWindow for a given fragment
`Subject`	`getSubject()` Returns the current secure subject for the current request thread
`TemplateDescriptor`	`getTemplate(String path, String templateType)` Retrieves a template using the Jetspeed template locator algorithm
`String`	`getTitle()` Returns the appropriate for the title based on locale preferences
`String`	`getTitle(ContentFragment fragment)` Returns the appropriate for the title based on locale preferences
`String`	`getUserAttribute(String attributeName, String defaultValue)`
`Map<String,String>`	`getUserAttributes()`
`javax.portlet.WindowState`	`getWindowState()` Gets the window state for the current portlet window (fragment)
`String`	`includeDecoration(String template, String templateType)` Include a decorator into the rendering stream at the current position in layout
`String`	`includeTemplate(String template, String templateType)` Include a template into the rendering stream at the current position in layout
`boolean`	`isAjaxCustomizationEnabled()` Determine if ajax customization is enabled
`boolean`	`isAutoRefreshEnabled()` Is AutoRefresh support for automatic portlet rendering enabled
`boolean`	`isDojoEnabled(List<KeyValue<String,HeadElement>> headElements)` Returns true if head element has dojo library inclusion.
`boolean`	`isHidden(ContentFragment fragment)` Checks the the visibilty of this fragment with respect to the current RenderReqeust.
`String`	`renderPortletWindow(String windowId, String portletId)` For given window and portlet ids, render a portlet window
`void`	`setCurrentFragment(ContentFragment fragment)` The Power Tool tracks which fragment is being rendered.
`void`	`setCurrentLayout()` The Power Tool tracks which layout is being rendered.

- Field Detail
  - GENERIC_TEMPLATE_TYPE
```
static final String GENERIC_TEMPLATE_TYPE
```
    See Also:
    Constant Field Values
  - FRAGMENT_PROCESSING_ERROR_PREFIX
```
static final String FRAGMENT_PROCESSING_ERROR_PREFIX
```
    See Also:
    Constant Field Values
  - FRAGMENT_ATTR
```
static final String FRAGMENT_ATTR
```
    See Also:
    Constant Field Values
  - LAYOUT_ATTR
```
static final String LAYOUT_ATTR
```
    See Also:
    Constant Field Values
  - HIDDEN
```
static final String HIDDEN
```
    See Also:
    Constant Field Values
  - LAYOUT_TEMPLATE_TYPE
```
static final String LAYOUT_TEMPLATE_TYPE
```
    See Also:
    Constant Field Values
  - DECORATOR_TYPE
```
static final String DECORATOR_TYPE
```
    See Also:
    Constant Field Values
- Method Detail
  - getWindowState
```
javax.portlet.WindowState getWindowState()
                                         throws Exception
```
    Gets the window state for the current portlet window (fragment)
    
    Returns:
    The window state for the current window
    
    Throws:
    
    Exception
  - getMappedWindowState
```
javax.portlet.WindowState getMappedWindowState()
                                               throws Exception
```
    Gets the internal (portal) window state for the current portlet window (fragment)
    
    Returns:
    The window state for the current window
    
    Throws:
    
    Exception
  - getPortletMode
```
javax.portlet.PortletMode getPortletMode()
                                         throws Exception
```
    Gets the portlet mode for a current portlet window (fragment)
    
    Returns:
    The portlet mode of the current window
    
    Throws:
    
    Exception
  - getMappedPortletMode
```
javax.portlet.PortletMode getMappedPortletMode()
                                               throws Exception
```
    Gets the internal (portal) portlet mode for a current portlet window (fragment)
    
    Returns:
    The portlet mode of the current window
    
    Throws:
    
    Exception
  - getCurrentFragment
```
ContentFragment getCurrentFragment()
```
    The Power Tool tracks which fragment is being rendered. This method returns the current fragment.
    
    Returns:
    the current fragment being rendered
  - setCurrentFragment
```
void setCurrentFragment(ContentFragment fragment)
```
    The Power Tool tracks which fragment is being rendered. This method sets the current fragment
    
    Parameters:
    fragment - current fragment to render
  - setCurrentLayout
```
void setCurrentLayout()
```
    The Power Tool tracks which layout is being rendered. This method sets the current layout to the current fragment, if the current fragment is a layout
  - getCurrentLayout
```
ContentFragment getCurrentLayout()
```
    The Power Tool tracks which layout is being rendered. This method gets the current layout
    
    Returns:
    the current layout
  - getPage
```
ContentPage getPage()
```
    The Power Tool tracks which page is being rendered. This method gets the current page
    
    Returns:
    the current page being rendered
  - getColumns
```
List[] getColumns()
```
    Deprecated.
    
    For tabular layouts, the Power Tool can provide the set of columns being rendered for layout
    
    Returns:
    an array of lists of content ContentFragment
  - getColumnSizes
```
List<String> getColumnSizes()
```
    For tabular layouts, return the column sizes, usually as percentages but can be any table sizing such pixels
    
    Returns:
    list of column sizes, usually percentages
  - getPortletWindow
```
PortletWindow getPortletWindow(ContentFragment fragment)
                               throws Exception
```
    Return the associated PortletWindow for a given fragment
    
    Parameters:
    fragment - Fragment whose PortletWindow we want to retrieve.
    
    Returns:
    The PortletWindow represented by the current fragment.
    
    Throws:
    
    Exception
  - isHidden
```
boolean isHidden(ContentFragment fragment)
```
    Checks the the visibilty of this fragment with respect to the current RenderReqeust.
    
    Parameters:
    fragment - Fragment
    
    Returns:
    whether or not the Fragment in question should be considered visible during rendering.
  - getTemplate
```
TemplateDescriptor getTemplate(String path,
                             String templateType)
                               throws TemplateLocatorException
```
    Retrieves a template using the Jetspeed template locator algorithm
    
    Parameters:
    path - Expected to the template. This may actually be changed by the TL service based the capability and localization information provided by the client.
    templateType - Type off template we are interested in.
    
    Returns:
    Template object containng the pertinent information required to inlcude the request template path in the current response
    
    Throws:
    
    TemplateLocatorException - if the path does not exist.
    See Also:
    TemplateLocator
  - getDecoration
```
TemplateDescriptor getDecoration(String path,
                               String templateType)
                                 throws TemplateLocatorException
```
    Retrieves a decorator using the Jetspeed template locator algorithm
    
    Parameters:
    path - Expected to the template. This may actually be changed by the TL service based the capability and localization information provided by the client.
    templateType - Type off template we are interested in.
    
    Returns:
    Template object containing the pertinent information required to inlcude the request template path in the current response
    
    Throws:
    
    TemplateLocatorException - if the path does not exist.
    See Also:
    TemplateLocator
  - includeTemplate
```
String includeTemplate(String template,
                     String templateType)
                       throws IOException
```
    Include a template into the rendering stream at the current position in layout
    
    Parameters:
    template - name of template to include
    templateType - the type either portlet or layout
    
    Returns:
    the content of the layout
    
    Throws:
    
    IOException
  - includeDecoration
```
String includeDecoration(String template,
                       String templateType)
                         throws IOException
```
    Include a decorator into the rendering stream at the current position in layout
    
    Parameters:
    template - name of template to include
    templateType - the type either portlet or layout
    
    Returns:
    the content of the layout
    
    Throws:
    
    IOException
  - decorateAndInclude
```
String decorateAndInclude(ContentFragment fragment)
                          throws Exception
```
    Decorate and include fragment content.
    
    Parameters:
    fragment - Fragment to include and decorate
    
    Returns:
    String path to the decorator.
    
    Throws:
    
    Exception
  - getDecoratorActions
```
List<DecoratorAction> getDecoratorActions()
```
    Gets the list of decorator actions for a window. Each window (on each page) has its own collection of actionAccess flags associated with it.
    
    Returns:
    A list of DecoratorAction available to the current window, filtered by security access and current state.
    
    Throws:
    
    Exception
  - getPageDecoratorActions
```
List<DecoratorAction> getPageDecoratorActions()
                                              throws Exception
```
    Gets the list of decorator actions for a page. Each layout fragment on a page has its own collection of actionAccess flags associated with it.
    
    Returns:
    A list of actions available to the current window, filtered by security access and current state.
    
    Throws:
    
    Exception
  - getTitle
```
String getTitle(ContentFragment fragment)
```
    Returns the appropriate for the title based on locale preferences
    
    Parameters:
    fragment -
    
    Returns:
    the title of the fragment
  - getTitle
```
String getTitle()
```
    Returns the appropriate for the title based on locale preferences
    
    Returns:
    the title of the current fragment
  - getComponent
```
Object getComponent(String name)
```
    Shortcut convenience method to lookup a Jetspeed service via ComponentManagement.lookupComponent(Class)
    
    Parameters:
    name - the name of the component service
    
    Returns:
    a component service from container
  - getAbsoluteUrl
```
String getAbsoluteUrl(String relativePath)
```
    Return the absolute portal URL from a given relative url
    
    Parameters:
    relativePath -
    
    Returns:
    the full portal URL
  - getSubject
```
Subject getSubject()
```
    Returns the current secure subject for the current request thread
    
    Returns:
    A Java Subject
  - getLoggedOn
```
boolean getLoggedOn()
```
    Is the current request being made by a logged on user
    
    Returns:
    true if user is logged on
  - getBasePath
```
String getBasePath()
```
    Gets the Portal Base Path
    
    Returns:
    the base path portion of the URL
    See Also:
    org.apache.jetspeed.container.url.PortalURL#getBasePath()}
  - getPageBasePath
```
String getPageBasePath()
```
    Returns the current Portal Page base path without possible encoded NavigationalState parameter.
    
    Returns:
    See Also:
    org.apache.jetspeed.container.url.PortalURL#getBasePath()}
  - renderPortletWindow
```
String renderPortletWindow(String windowId,
                         String portletId)
```
    For given window and portlet ids, render a portlet window
    
    Parameters:
    windowId -
    portletId -
    
    Returns:
    the rendered content
  - getElementHtmlString
```
String getElementHtmlString(HeadElement element)
```
    Returns string representation of a head HTML DOM element
    
    Parameters:
    element -
    
    Returns:
    string representation
  - getHeadElements
```
List<KeyValue<String,HeadElement>> getHeadElements(ContentFragment fragment)
                                                   throws Exception
```
    Returns all the contributed head elements from the fragment and its child fragments.
    
    Parameters:
    fragment -
    
    Returns:
    
    Throws:
    
    Exception
  - getHeadElements
```
List<KeyValue<String,HeadElement>> getHeadElements()
                                                   throws Exception
```
    Returns all the contributed head elements from the current fragment and its child fragments.
    
    Returns:
    
    Throws:
    
    Exception
  - isDojoEnabled
```
boolean isDojoEnabled(List<KeyValue<String,HeadElement>> headElements)
```
    Returns true if head element has dojo library inclusion.
    
    Parameters:
    headElements -
    
    Returns:
  - isAjaxCustomizationEnabled
```
boolean isAjaxCustomizationEnabled()
```
    Determine if ajax customization is enabled
    
    Returns:
    true when ajax customization enabled
  - getUserAttributes
```
Map<String,String> getUserAttributes()
```
    Returns:
    an unmodifiable Map of the User "info" attributes or null if not authenticated
  - getUserAttribute
```
String getUserAttribute(String attributeName,
                      String defaultValue)
```
    Returns:
    the value for the User "info" attribute or the provided defaultValue if not authenticated or if the attribute is undefined
  - getPortalConfiguration
```
PortalConfiguration getPortalConfiguration()
```
    Helper to retrieve the PortalConfiguration
    
    Returns:
    the portal configuration
  - isAutoRefreshEnabled
```
boolean isAutoRefreshEnabled()
```
    Is AutoRefresh support for automatic portlet rendering enabled
    
    Returns:
    true when auto refresh is enabled in Jetspeed properties

Interface JetspeedPowerTool

Field Summary

Method Summary

Field Detail

GENERIC_TEMPLATE_TYPE

FRAGMENT_PROCESSING_ERROR_PREFIX

FRAGMENT_ATTR

LAYOUT_ATTR

HIDDEN

LAYOUT_TEMPLATE_TYPE

DECORATOR_TYPE

Method Detail

getWindowState

getMappedWindowState

getPortletMode

getMappedPortletMode

getCurrentFragment

setCurrentFragment

setCurrentLayout

getCurrentLayout

getPage

getColumns

getColumnSizes

getPortletWindow

isHidden

getTemplate

getDecoration

includeTemplate

includeDecoration

decorateAndInclude

getDecoratorActions

getPageDecoratorActions

getTitle

getTitle

getComponent

getAbsoluteUrl

getSubject

getLoggedOn

getBasePath

getPageBasePath

renderPortletWindow

getElementHtmlString

getHeadElements

getHeadElements

isDojoEnabled

isAjaxCustomizationEnabled

getUserAttributes

getUserAttribute

getPortalConfiguration

isAutoRefreshEnabled