nextapp.echo.webcontainer.service
Class StaticTextService

java.lang.Object
  nextapp.echo.webcontainer.service.StaticTextService

All Implemented Interfaces:

Service

public class StaticTextService
extends java.lang.Object
implements Service

A service which renders a text resource, such as a text or XML document.

Field Summary

Fields inherited from interface nextapp.echo.webcontainer.Service

DO_NOT_CACHE

Constructor Summary

StaticTextService(java.lang.String id, java.lang.String contentType, java.lang.String content)
Creates a new StaticTextService.

Method Summary

static StaticTextService	forResource(java.lang.String id, java.lang.String contentType, java.lang.String resourceName) Creates a new StaticTextService based on the content in the specified CLASSPATH resource.
java.lang.String	getId() Returns the unique identifier of this service.
int	getVersion() Returns the version of the service to be retrieved.
void	service(Connection conn) Services an HTTP request.

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticTextService

public StaticTextService(java.lang.String id,
                         java.lang.String contentType,
                         java.lang.String content)

Creates a new StaticTextService.

Parameters:

id - the Service identifier

contentType - the content type of the document

content - the text

Method Detail

forResource

public static StaticTextService forResource(java.lang.String id,
                                            java.lang.String contentType,
                                            java.lang.String resourceName)

Creates a new StaticTextService based on the content in the specified CLASSPATH resource. A runtime exception will be thrown in the even the resource does not exist (it generally should not be caught).

Parameters:

id - the Service identifier

contentType - the content type of the document

resourceName - the path to the content resource in the CLASSPATH

Returns:

the created StaticTextService

getId

public java.lang.String getId()

Description copied from interface: Service

Returns the unique identifier of this service.

Specified by:

getId in interface Service

Returns:

the unique identifier of this service

See Also:

Service.getId()

getVersion

public int getVersion()

Description copied from interface: Service

Returns the version of the service to be retrieved. When a service is requested with an updated version number, a non-cached copy will be used. getVersion() should return distinct values whenever the service's content may have changed.

Specified by:

getVersion in interface Service

Returns:

the current version number of the service

See Also:

Service.getVersion()

service

public void service(Connection conn)
             throws java.io.IOException

Description copied from interface: Service

Services an HTTP request. Information about the HTTP request as well as methods for issuing a response are available from the provided Connection object.

Specified by:

service in interface Service

Parameters:

conn - a Connection object which wraps HttpServletRequest and HttpServletResponse objects and provides access to the facilities of the Echo application container

Throws:

java.io.IOException - in the event of errors related to processing the HTTP request or producing a response

See Also:

Service.service(nextapp.echo.webcontainer.Connection)