com.crossingchannels.portal.websphere.specification.jee5

Class EarDescriptor

java.lang.Object

com.crossingchannels.portal.websphere.specification.jee5.EarDescriptor

public class EarDescriptor
extends java.lang.Object

Represents an JEE version 5 compatible EAR descriptor.

Constructor Summary

Constructors

Constructor and Description
EarDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	addWebArchive(java.lang.String webArchiveURI, java.lang.String contextRoot) Add a new web archive to this descriptor.
static EarDescriptor	fromInputStream(java.io.InputStream earXmlInputStream) Create a new EarDescriptor object using the supplied XML file.
java.lang.String	getDisplayName()
java.lang.String	getWebArchiveContextRoot(java.lang.String webArchiveURI) Get the context root of the requested web archive.
java.util.Set<java.lang.String>	getWebArchiveURIs() Get a set of the URIs of all web archive registered in this descriptor.
void	setDisplayName(java.lang.String displayName)

Methods inherited from class java.lang.Object

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

Constructor Detail

EarDescriptor

public EarDescriptor()

Method Detail

fromInputStream

public static final EarDescriptor fromInputStream(java.io.InputStream earXmlInputStream)
                                           throws IllegalDescriptorFoundException

Create a new EarDescriptor object using the supplied XML file.

Parameters:

earXmlInputStream - InputStream containing the XML file.

Returns:

Instance of EarDescriptor.

Throws:

IllegalDescriptorFoundException - Thrown if the descriptor is not valid.

addWebArchive

public void addWebArchive(java.lang.String webArchiveURI,
                 java.lang.String contextRoot)

Add a new web archive to this descriptor.

Parameters:

webArchiveURI - URI of the web archive to add.

contextRoot - Context root of the archive.

getDisplayName

public java.lang.String getDisplayName()

Returns:

the displayName

getWebArchiveContextRoot

public java.lang.String getWebArchiveContextRoot(java.lang.String webArchiveURI)

Get the context root of the requested web archive.

Parameters:

webArchiveURI - URI of the web archive requested.

Returns:

The context root or NULL if non set.

getWebArchiveURIs

public java.util.Set<java.lang.String> getWebArchiveURIs()

Get a set of the URIs of all web archive registered in this descriptor.

Returns:

Unmodifable set of URIs.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Parameters:

displayName - the displayName to set