ZipArchiveSerializer (Cocoon Pipeline Components 1.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.cocoon.serialization
Class ZipArchiveSerializer

java.lang.Object
  org.apache.cocoon.util.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.serialization.AbstractSerializer
                  org.apache.cocoon.serialization.ZipArchiveSerializer

All Implemented Interfaces:: ContentHandler, Disposable, LexicalHandler, Poolable, Recyclable, org.apache.cocoon.serialization.Serializer, Serviceable, org.apache.cocoon.sitemap.SitemapOutputComponent, XMLConsumer, org.apache.cocoon.xml.XMLConsumer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer

public class ZipArchiveSerializer
extends org.apache.cocoon.serialization.AbstractSerializer
implements Disposable, Serviceable

A serializer that builds Zip archives by aggregating several sources.

The input document should describe entries of the archive by means of their name (which can be a path) and their content either as URLs or inline data :

URLs, given by the "src" attribute, are Cocoon sources and as such can use any of the protocols handled by Cocoon, including "cocoon:" to include dynamically generated content in the archive.
inline data is represented by an XML document that is serialized to the zip entry using the serializer identified by the "serializer" attribute.

Example :

   <zip:archive xmlns:zip="http://apache.org/cocoon/zip-archive/1.0">
     <zip:entry name="foo.html" src="cocoon://dynFoo.html"/>
     <zip:entry name="images/bar.jpeg" src="bar.jpeg"/>
     <zip:entry name="index.html" serializer="html">
       <html>
         <head>
           <title>Index page</title>
         </head>
         <body>
           Please go <a href="foo.html">there</a>
         </body<
       </html>
     </zip:entry>
   </zip:archive:zip>

Version:: $Id: ZipArchiveSerializer.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
`protected byte[]`	`buffer` Temporary byte buffer to read source data
`protected int`	`contentDepth` Current depth of the serialized content
`protected ServiceManager`	`manager` The component manager
`protected SourceResolver`	`resolver` The resolver to get sources
`protected ServiceSelector`	`selector` The serializer component selector
`protected org.apache.cocoon.serialization.Serializer`	`serializer` Serializer used when in IN_CONTENT state
`protected int`	`state` The current state
`static String`	`ZIP_NAMESPACE` The namespace for elements handled by this serializer, "http://apache.org/cocoon/zip-archive/1.0".
`protected ZipOutputStream`	`zipOutput` The Zip stream where entries will be written

Fields inherited from class org.apache.cocoon.serialization.AbstractSerializer

output

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.serialization.Serializer

ROLE

Constructor Summary
`ZipArchiveSerializer()`

Method Summary
`protected void`	`addEntry(Attributes atts)` Add an entry in the archive.
`void`	`characters(char[] buffer, int offset, int length)`
`void`	`dispose()`
`void`	`endDocument()`
`void`	`endElement(String namespaceURI, String localName, String qName)`
`void`	`endPrefixMapping(String prefix)`
`String`	`getMimeType()` Returns default mime type for zip archives, `application/zip`.
`void`	`recycle()`
`void`	`service(ServiceManager manager)`
`void`	`startDocument()`
`void`	`startElement(String namespaceURI, String localName, String qName, Attributes atts)`
`void`	`startPrefixMapping(String prefix, String uri)` Begin the scope of a prefix-URI Namespace mapping.

Methods inherited from class org.apache.cocoon.serialization.AbstractSerializer

setOutputStream, shouldSetContentLength

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

ZIP_NAMESPACE

public static final String ZIP_NAMESPACE

The namespace for elements handled by this serializer, "http://apache.org/cocoon/zip-archive/1.0".

See Also:: Constant Field Values

manager

protected ServiceManager manager

The component manager

selector

protected ServiceSelector selector

The serializer component selector

zipOutput

protected ZipOutputStream zipOutput

The Zip stream where entries will be written

state

protected int state

The current state

resolver

protected SourceResolver resolver

The resolver to get sources

buffer

protected byte[] buffer

Temporary byte buffer to read source data

serializer

protected org.apache.cocoon.serialization.Serializer serializer

Serializer used when in IN_CONTENT state

contentDepth

protected int contentDepth

Current depth of the serialized content

Constructor Detail