This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.publication
Class PageEnvelopeFactory

java.lang.Object
  org.apache.lenya.cms.publication.PageEnvelopeFactory

public class PageEnvelopeFactory
extends java.lang.Object

Common entry point for creating page envelopes.

Constructor Summary

protected

PageEnvelopeFactory() Creates a new PageEnvelopeFactory.

Method Summary

static PageEnvelopeFactory	getInstance() Returns the singleton PageEnvelopeFactory.
PageEnvelope	getPageEnvelope(DocumentFactory map, java.util.Map objectModel, Publication pub) Returns the page envelope for the object model of a Cocoon component.
PageEnvelope	getPageEnvelope(DocumentFactory map, java.lang.String contextPath, java.lang.String webappUrl, java.io.File servletContext, Publication pub) Creates a page envelope.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageEnvelopeFactory

protected PageEnvelopeFactory()

Creates a new PageEnvelopeFactory.

Method Detail

getInstance

public static PageEnvelopeFactory getInstance()

Returns the singleton PageEnvelopeFactory.

Returns:

The factory.

getPageEnvelope

public PageEnvelope getPageEnvelope(DocumentFactory map,
                                    java.util.Map objectModel,
                                    Publication pub)
                             throws PageEnvelopeException

Returns the page envelope for the object model of a Cocoon component.

Parameters:

map - The document identity map to use.

objectModel - The object model.

pub - The publication.

Returns:

A page envelope.

Throws:

PageEnvelopeException - if something went wrong.

getPageEnvelope

public PageEnvelope getPageEnvelope(DocumentFactory map,
                                    java.lang.String contextPath,
                                    java.lang.String webappUrl,
                                    java.io.File servletContext,
                                    Publication pub)
                             throws PageEnvelopeException

Creates a page envelope.

Parameters:

map - The document identity map to use.

contextPath - The servlet context prefix.

webappUrl - The web application URL.

servletContext - The servlet context directory.

pub - The publication.

Returns:

A page envelope.

Throws:

PageEnvelopeException - if something went wrong.