org.apache.cocoon.sitemap
Interface SitemapOutputComponent

All Superinterfaces:
Component
All Known Subinterfaces:
Reader, Serializer
All Known Implementing Classes:
AbstractReader, AbstractSerializer, AbstractTextSerializer, AxisRPCReader, CaptchaReader, ComposerReader, DatabaseReader, ElementProcessorSerializer, EncodingSerializer, EventAwareReader, FOPSerializer, HSSFSerializer, HTMLSerializer, HTMLSerializer, ImageOpReader, ImageReader, IncludingHTMLSerializer, iTextSerializer, JSPReader, LinkSerializer, POIFSSerializer, ProxyReader, ResourceReader, RTFSerializer, ServiceableReader, SVGSerializer, SWFSerializer, TextSerializer, XHTMLSerializer, XMidiSerializer, XMLSerializer, XMLSerializer, ZipArchiveSerializer

public interface SitemapOutputComponent
extends Component

This interface marks a component as a sitemap component that produces a response, like a serializer or a reader.

Version:
CVS $Id: SitemapOutputComponent.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Giacomo Pati, Carsten Ziegeler

Method Summary
 String getMimeType()
          Get the media type of the output of this Component to be used in Content-Type header in the response.
 void setOutputStream(OutputStream out)
          Set the OutputStream where the requested resource should be serialized.
 boolean shouldSetContentLength()
          Test if the component wants to set the content length
 

Method Detail

setOutputStream

void setOutputStream(OutputStream out)
                     throws IOException
Set the OutputStream where the requested resource should be serialized.

Throws:
IOException

getMimeType

String getMimeType()
Get the media type of the output of this Component to be used in Content-Type header in the response.
Example content type value: text/html; charset=utf-8.
The returned value is used if no mime-type attribute is set in the sitemap.

See Also:
AbstractProcessingPipeline.setMimeTypeForSerializer(org.apache.cocoon.environment.Environment), AbstractProcessingPipeline.setMimeTypeForReader(org.apache.cocoon.environment.Environment)

shouldSetContentLength

boolean shouldSetContentLength()
Test if the component wants to set the content length



Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.