PortletHeaderResponse (Jetspeed-2 Core API 2.1.3 API)

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.portlet
Interface PortletHeaderResponse

public interface PortletHeaderResponse

Method Summary

String getContent()
          Temporary solution: get the content after calling include this will be deprecated

Map getHeaderConfiguration()
          Configuration data for use by HeaderResource

HeaderResource getHeaderResource()
          Retrieves the header resource for this request

Map getHeaderResourceRegistry()
          Map containing overrides of content for header statements

void include(PortletHeaderRequest request, PortletHeaderResponse response, String headerResource)
          Dispatch to a servlet or resource to generate and include the header content

boolean isDesktop()
          Is request for /desktop rather than /portal

Method Summary
`String`	`getContent()` Temporary solution: get the content after calling include this will be deprecated
`Map`	`getHeaderConfiguration()` Configuration data for use by HeaderResource
`HeaderResource`	`getHeaderResource()` Retrieves the header resource for this request
`Map`	`getHeaderResourceRegistry()` Map containing overrides of content for header statements
`void`	`include(PortletHeaderRequest request, PortletHeaderResponse response, String headerResource)` Dispatch to a servlet or resource to generate and include the header content
`boolean`	`isDesktop()` Is request for /desktop rather than /portal

Method Detail

getHeaderResource

HeaderResource getHeaderResource()

Retrieves the header resource for this request

Returns:: a per request HeaderResource

isDesktop

boolean isDesktop()

Is request for /desktop rather than /portal

Returns:: true if request is for /desktop, false if request is for /portal

getHeaderConfiguration

Map getHeaderConfiguration()

Configuration data for use by HeaderResource

Returns:: an immutable Map

getHeaderResourceRegistry

Map getHeaderResourceRegistry()

Map containing overrides of content for header statements

Returns:: an immutable Map

getContent

String getContent()

Temporary solution: get the content after calling include this will be deprecated

include

void include(PortletHeaderRequest request,
             PortletHeaderResponse response,
             String headerResource)
             throws javax.portlet.PortletException

Dispatch to a servlet or resource to generate and include the header content

Parameters:: request -; response -; headerResource -
Throws:: javax.portlet.PortletException