net.sf.jportlet.service.velocity
Interface VelocityService

All Superinterfaces:

PortletService

All Known Implementing Classes:

VelocityServiceImpl

public interface VelocityService

extends PortletService

The VelocityService renders Velocity files

Author:

Herve Tchepannou

Field Summary

static java.lang.String	NAME
static java.lang.String	PORTLET
static java.lang.String	PROXY
static java.lang.String	REQUEST
static java.lang.String	RESPONSE
static java.lang.String	RUNTIME

Method Summary

void

merge(java.lang.String path, net.sf.jportlet.portlet.PortletRequest request, net.sf.jportlet.portlet.PortletResponse response) Marge a velocity file with the current request/response The velocity context has the following variables defined: request: The portlet request (type=PortletRequest) response: The portlet response (type=PortletResponse) portlet: The portlet to render (type=Portlet) proxy: The portlet proxy (type=PortletProxy) runtime: Instance of (type=Runtime) All the attributes of the request

void

merge(java.lang.String path, net.sf.jportlet.portlet.PortletRequest request, net.sf.jportlet.portlet.PortletResponse response, java.util.Map context)

Methods inherited from interface net.sf.jportlet.service.PortletService

destroy, getServiceConfig, getServiceName, init

Field Detail

NAME

public static final java.lang.String NAME

PORTLET

public static final java.lang.String PORTLET

See Also:

Constant Field Values

PROXY

public static final java.lang.String PROXY

See Also:

Constant Field Values

REQUEST

public static final java.lang.String REQUEST

See Also:

Constant Field Values

RESPONSE

public static final java.lang.String RESPONSE

See Also:

Constant Field Values

RUNTIME

public static final java.lang.String RUNTIME

See Also:

Constant Field Values

Method Detail

merge

public void merge(java.lang.String path,
                  net.sf.jportlet.portlet.PortletRequest request,
                  net.sf.jportlet.portlet.PortletResponse response)
           throws PortletServiceException

Marge a velocity file with the current request/response The velocity context has the following variables defined:

• request: The portlet request (type=PortletRequest)
• response: The portlet response (type=PortletResponse)
• portlet: The portlet to render (type=Portlet)
• proxy: The portlet proxy (type=PortletProxy)
• runtime: Instance of (type=Runtime)
• All the attributes of the request

PortletServiceException

merge

public void merge(java.lang.String path,
                  net.sf.jportlet.portlet.PortletRequest request,
                  net.sf.jportlet.portlet.PortletResponse response,
                  java.util.Map context)
           throws PortletServiceException

PortletServiceException