org.ow2.util.ee.deploy.api.deployable
Interface IDeployable<T extends IDeployable<T>>

Type Parameters:

T - the type of the deployable.

All Known Subinterfaces:

CARDeployable, EARDeployable, EJB21Deployable, EJB3Deployable, EJBDeployable<T>, LibDeployable, OSGiDeployable, RARDeployable, UnknownDeployable, WARDeployable

public interface IDeployable<T extends IDeployable<T>>

This interface is used to represent any deployment object that can be used within EasyBeans.
The EJB/WEB/RAR/EAR, etc components should extend this interface.

Author:

Florent Benoit

Method Summary

void	addExtension(IDeployableInfo extension) Adds a deployable info that can be used by a deployer.
IArchive	getArchive() Gets the Archive of this deployable object.
IDeployableInfo	getExtension(Class<? extends IDeployableInfo> extensionClass) Gets the extension for the given class.
String	getModuleName() Gets the module name for this deployable.
T	getOriginalDeployable() If the Deployable has been unpacked, return the initial archive.
String	getShortName() Gets a shorter name for this deployable.
T	getUnpackedDeployable() If the Deployable has been unpacked, return the unpacked deployable.
void	setOriginalDeployable(T originalDeployable) If the EAR has been unpacked, return the initial archive.
void	setUnpackedDeployable(T unpackedDeployable) If the Deployable has been unpacked, sets the unpacked deployable.

Method Detail

getArchive

IArchive getArchive()

Gets the Archive of this deployable object.

Returns:

the archive for this deployable.

getOriginalDeployable

T getOriginalDeployable()

If the Deployable has been unpacked, return the initial archive.

Returns:

the deployable before it is unpacked.

getUnpackedDeployable

T getUnpackedDeployable()

If the Deployable has been unpacked, return the unpacked deployable.

Returns:

the unpacked deployable associated to this deployable.

setUnpackedDeployable

void setUnpackedDeployable(T unpackedDeployable)

If the Deployable has been unpacked, sets the unpacked deployable.

Parameters:

unpackedDeployable - the unpacked deployable associated to this deployable.

setOriginalDeployable

void setOriginalDeployable(T originalDeployable)

If the EAR has been unpacked, return the initial archive.

Parameters:

originalDeployable - the deployable before it is unpacked.

addExtension

void addExtension(IDeployableInfo extension)

Adds a deployable info that can be used by a deployer.

Parameters:

extension - the implementation of the extension to register.

getExtension

IDeployableInfo getExtension(Class<? extends IDeployableInfo> extensionClass)

Gets the extension for the given class.

Parameters:

extensionClass - the class to used as a key

Returns:

the extension else null if not found.

getShortName

String getShortName()

Gets a shorter name for this deployable.

Returns:

a shorter name based on the URL.

getModuleName

String getModuleName()

Gets the module name for this deployable. This module name is a name based on the short name but without any extension.

Returns:

the module name of this deployable