org.mevenide.netbeans.j2ee
Class MavenJ2eeModule

java.lang.Object
  org.mevenide.netbeans.j2ee.MavenJ2eeModule

All Implemented Interfaces:

org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

Direct Known Subclasses:

MavenJ2eeModuleContainer

public class MavenJ2eeModule
extends java.lang.Object
implements org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

Author:

Milos Kleint (mkleint@codehaus.org)

Nested Class Summary

Nested classes/interfaces inherited from interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule.RootedEntry, org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule.VersionListener

Field Summary

Fields inherited from interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

APP_XML, CLIENT, CLIENT_XML, CONN, CONNECTOR_XML, EAR, EJB, EJBJAR_XML, EJBSERVICES_XML, J2EE_13, J2EE_14, MIME_J2EE_MODULE_TARGET, WAR, WEB_XML, WEBSERVICES_XML

Constructor Summary

MavenJ2eeModule(org.mevenide.netbeans.api.project.MavenProject proj)
Creates a new instance of MavenJ2eeModule

Method Summary

void	addVersionListener(org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule.VersionListener listener) TODO: what are the listeners for?
org.openide.filesystems.FileObject	getArchive() Returns the archive file for the module of null if the archive file does not exist (for example, has not been compiled yet).
java.util.Iterator	getArchiveContents() Returns the contents of the archive, in copyable form.
org.openide.filesystems.FileObject	getContentDirectory() This call is used in in-place deployment.
org.netbeans.modules.schema2beans.BaseBean	getDeploymentDescriptor(java.lang.String location) Returns a live bean representing the final deployment descriptor that will be used for deploment of the module.
java.lang.Object	getModuleType()
java.lang.String	getModuleVersion()
java.lang.String	getUrl()
void	removeVersionListener(org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule.VersionListener listener) TODO: what are the listeners for?
void	setUrl(java.lang.String newurl)

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenJ2eeModule

public MavenJ2eeModule(org.mevenide.netbeans.api.project.MavenProject proj)

Creates a new instance of MavenJ2eeModule

Method Detail

addVersionListener

public void addVersionListener(org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule.VersionListener listener)

TODO: what are the listeners for?

Specified by:

addVersionListener in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

removeVersionListener

public void removeVersionListener(org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule.VersionListener listener)

TODO: what are the listeners for?

Specified by:

removeVersionListener in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

getArchive

public org.openide.filesystems.FileObject getArchive()
                                              throws java.io.IOException

Returns the archive file for the module of null if the archive file does not exist (for example, has not been compiled yet).

Specified by:

getArchive in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

Throws:

java.io.IOException

getArchiveContents

public java.util.Iterator getArchiveContents()
                                      throws java.io.IOException

Returns the contents of the archive, in copyable form. Used for incremental deployment. Currently uses its own RootedEntry interface. If the J2eeModule instance describes a j2ee application, the result should not contain module archives.

Specified by:

getArchiveContents in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

Returns:

Iterator through RootedEntrys

Throws:

java.io.IOException

getContentDirectory

public org.openide.filesystems.FileObject getContentDirectory()
                                                       throws java.io.IOException

This call is used in in-place deployment. Returns the directory staging the contents of the archive This directory is the one from which the content entries returned by getArchiveContents() came from.

Specified by:

getContentDirectory in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

Returns:

FileObject for the content directory

Throws:

java.io.IOException

getDeploymentDescriptor

public org.netbeans.modules.schema2beans.BaseBean getDeploymentDescriptor(java.lang.String location)

Returns a live bean representing the final deployment descriptor that will be used for deploment of the module. This can be taken from sources, constructed on fly or a combination of these but it needs to be available even if the module has not been built yet.

Specified by:

getDeploymentDescriptor in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

Parameters:

location - Parameterized by location because of possibility of multiple deployment descriptors for a single module (jsp.xml, webservices.xml, etc). Location must be prefixed by /META-INF or /WEB-INF as appropriate.

Returns:

a live bean representing the final DD

getModuleType

public java.lang.Object getModuleType()

Specified by:

getModuleType in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

getModuleVersion

public java.lang.String getModuleVersion()

Specified by:

getModuleVersion in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule

setUrl

public void setUrl(java.lang.String newurl)

Specified by:

setUrl in interface org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule