org.apache.pluto.descriptors.services.impl

Class AbstractWebAppDescriptorService

java.lang.Object

org.apache.pluto.descriptors.services.impl.AbstractWebAppDescriptorService

All Implemented Interfaces:

WebAppDescriptorService

Direct Known Subclasses:

ContextWebAppDescriptorServiceImpl, FileWebAppDescriptorServiceImpl

public abstract class AbstractWebAppDescriptorService
extends java.lang.Object
implements WebAppDescriptorService

Abstract Implementation of the Web Application Deployment Descriptor service. Provides default implementation of the service; requiring only that subclasses provide the input streams to/from the actual descriptor.

Since:

Mar 5, 2005

Version:

$Id: AbstractWebAppDescriptorService.java 156743 2005-03-10 05:50:30Z ddewolf $

Author:

David H. DeWolf

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WEB_XML_MAPPING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebAppDescriptorService(java.lang.String contextPath) Default Constructor.
protected	AbstractWebAppDescriptorService(java.lang.String contextPath, boolean create) Secondary Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.exolab.castor.mapping.Mapping	getCastorMapping() Read and Retrieve the Web Application's Castor Mapping resource.
java.lang.String	getContextPath()
protected java.lang.String	getDTDUri() Retrieve the Web Application Deployment descriptor's DTD uri.
protected boolean	getIgnoreExtraElements()
protected abstract java.io.InputStream	getInputStream()
protected abstract java.io.OutputStream	getOutputStream()
protected java.lang.String	getPublicId() Retrieve the Web Application Deployment descriptor's public Id.
WebAppDD	read() Read the Web Application Deployment Descriptor.
protected java.lang.Object	readInternal() Read the and convert the descriptor into it's Object graph.
void	write(WebAppDD webApp) Write the deployment descriptor.
protected void	writeInternal(java.lang.Object object) Write the object graph to it's descriptor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pluto.descriptors.services.WebAppDescriptorService

getContextPath

Field Detail

WEB_XML_MAPPING

public static final java.lang.String WEB_XML_MAPPING

See Also:

Constant Field Values

Constructor Detail

AbstractWebAppDescriptorService

protected AbstractWebAppDescriptorService(java.lang.String contextPath)

Default Constructor.

AbstractWebAppDescriptorService

protected AbstractWebAppDescriptorService(java.lang.String contextPath,
                               boolean create)

Secondary Constructor. Create an instance and specify whether or not a default/empty instance should be returned if no descriptor is available.

Parameters:

create -

Method Detail

read

public WebAppDD read()
              throws java.io.IOException

Read the Web Application Deployment Descriptor.

Specified by:

read in interface WebAppDescriptorService

Returns:

WebAppDD instance representing the descriptor.

Throws:

java.io.IOException

write

public void write(WebAppDD webApp)
           throws java.io.IOException

Write the deployment descriptor.

Specified by:

write in interface WebAppDescriptorService

Parameters:

webApp -

Throws:

java.io.IOException

getPublicId

protected java.lang.String getPublicId()

Retrieve the Web Application Deployment descriptor's public Id.

Returns:

getDTDUri

protected java.lang.String getDTDUri()

Retrieve the Web Application Deployment descriptor's DTD uri.

Returns:

getCastorMapping

protected org.exolab.castor.mapping.Mapping getCastorMapping()
                                                      throws java.io.IOException,
                                                             org.exolab.castor.mapping.MappingException

Read and Retrieve the Web Application's Castor Mapping resource.

Returns:

Throws:

java.io.IOException

org.exolab.castor.mapping.MappingException

getContextPath

public java.lang.String getContextPath()

readInternal

protected java.lang.Object readInternal()
                                 throws java.io.IOException

Read the and convert the descriptor into it's Object graph.

Returns:

Throws:

java.io.IOException

writeInternal

protected void writeInternal(java.lang.Object object)
                      throws java.io.IOException

Write the object graph to it's descriptor.

Parameters:

object -

Throws:

java.io.IOException

getIgnoreExtraElements

protected boolean getIgnoreExtraElements()

getInputStream

protected abstract java.io.InputStream getInputStream()
                                               throws java.io.IOException

Throws:

java.io.IOException

getOutputStream

protected abstract java.io.OutputStream getOutputStream()
                                                 throws java.io.IOException

Throws:

java.io.IOException