org.pageseeder.berlioz.generator

Class GetMatchingService

java.lang.Object

org.pageseeder.berlioz.generator.GetMatchingService

All Implemented Interfaces:

Cacheable, ContentGenerator

public final class GetMatchingService
extends Object
implements ContentGenerator, Cacheable

Returns the current service configuration as XML.

This content generator is mostly useful for developers to see how the services are configured.

Configuration

There is no configuration associated with this generator.

Parameters

This generator does not use and require any parameter.

Returned XML

This generator contains the /WEB-INF/config/services.xml used by Berlioz to load its services.

 <services version="1.0"> ... </services>

The formatting of the XML may differ from the actual files as it is parsed before being returned; the XML declaration and comments are stripped.

Error Handling

Should there be any problem parsing or reading the file, the XML returned will be:

 <no-data error="[error]" details="[error-details]"/>

The error details are only shown if available.

Usage

To use this generator in Berlioz (in /WEB-INF/config/services.xml):

 <generator class="org.pageseeder.berlioz.generator.GetServices"
                         name="[name]" target="[target]"/>

Etag

This generator uses a weak etag based on the name, length and last modified date of the file.

Since:

Berlioz 0.9.3

Version:

Berlioz 0.9.32

Author:

Christophe Lauret

Constructor Summary

Constructors

Constructor and Description
GetMatchingService()

Method Summary

Modifier and Type	Method and Description
String	getETag(ContentRequest req) Returns the ETag for the specified content request.
void	process(ContentRequest req, org.pageseeder.xmlwriter.XMLWriter xml) Produces the actual content.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetMatchingService

public GetMatchingService()

Method Detail

getETag

public String getETag(ContentRequest req)

Description copied from interface: Cacheable

Returns the ETag for the specified content request.

Specified by:

getETag in interface Cacheable

Parameters:

req - the content request.

Returns:

The corresponding ETag.

process

public void process(ContentRequest req,
                    org.pageseeder.xmlwriter.XMLWriter xml)
             throws IOException

Description copied from interface: ContentGenerator

Produces the actual content.

This is the main method of this interface, it should:

• perform one specific function
• write the result on the XML writer

Implementation should specify which attribute or parameters are used or required.

Specified by:

process in interface ContentGenerator

Parameters:

req - The content request.

xml - The XML output.

Throws:

IOException - If an I/O error occurs while writing to the XML writer.