net.sf.jportlet.service.ssi
Class SSIText

java.lang.Object
  |
  +--net.sf.jportlet.service.ssi.SSIText

All Implemented Interfaces:

SSI

Direct Known Subclasses:

SSIVelocity

public class SSIText

extends java.lang.Object

implements SSI

Default implementation of SSI. This implementation just include the content of the stream to include without processing it. This SSI is appropriate for text files

Author:

Herve Tchepannou

Field Summary

protected boolean	_init
protected org.apache.commons.logging.Log	_log
protected net.sf.jportlet.service.PortletServiceConfig	_serviceConfig
protected net.sf.jportlet.service.PortletServiceContext	_serviceContext
protected javax.servlet.ServletContext	_servletContext
static int	BUFFER_SIZE

Constructor Summary

SSIText()

Method Summary

void	destroy() This method is called by the container when shutted down
void	include(java.lang.String path, net.sf.jportlet.portlet.PortletContext context, net.sf.jportlet.portlet.PortletRequest request, net.sf.jportlet.portlet.PortletResponse response) Include a file
void	init(net.sf.jportlet.service.PortletServiceConfig config) This method is called by the container when started

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

Constant Field Values

_serviceConfig

protected net.sf.jportlet.service.PortletServiceConfig _serviceConfig

_serviceContext

protected net.sf.jportlet.service.PortletServiceContext _serviceContext

_init

protected boolean _init

_servletContext

protected javax.servlet.ServletContext _servletContext

_log

protected org.apache.commons.logging.Log _log

Constructor Detail

SSIText

public SSIText()

Method Detail

destroy

public void destroy()

Description copied from interface: SSI

This method is called by the container when shutted down

Specified by:

destroy in interface SSI

See Also:

net.sf.jportal.ssi.SSI#destroy()

include

public void include(java.lang.String path,
                    net.sf.jportlet.portlet.PortletContext context,
                    net.sf.jportlet.portlet.PortletRequest request,
                    net.sf.jportlet.portlet.PortletResponse response)
             throws PortletServiceException,
                    java.io.IOException

Description copied from interface: SSI

Include a file

Specified by:

include in interface SSI

Parameters:

path - path of the file to include

context - context of the portlet

request - request

response - response

Throws:

java.io.IOException - if any IO error occurs

PortletServiceException

See Also:

net.sf.jportal.ssi.SSI#include(java.lang.String, net.sf.jportlet.portlet.PortletRequest, net.sf.jportlet.portlet.PortletResponse)

init

public void init(net.sf.jportlet.service.PortletServiceConfig config)
          throws PortletServiceException

Description copied from interface: SSI

This method is called by the container when started

Specified by:

init in interface SSI

Parameters:

config - configuration of the service

PortletServiceException

See Also:

net.sf.jportal.ssi.SSI#init(javax.servlet.ServletConfig)