Java Doc for J2eeModuleImplementation.java in  » 6.0-JDK-Core » j2eeserver » org » netbeans » modules » j2ee » deployment » devmodules » spi » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » j2eeserver » org.netbeans.modules.j2ee.deployment.devmodules.spi 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleImplementation

All known Subclasses:   org.netbeans.tests.j2eeserver.devmodule.TestJ2eeModuleImpl,
J2eeModuleImplementation
public interface J2eeModuleImplementation (Code)
Base SPI interface for J2eeModule . Implementation of this interface is used to create J2eeModule instance using the J2eeModuleFactory .
author:
   sherold
since:
   1.23




Method Summary
 voidaddPropertyChangeListener(PropertyChangeListener listener)
     Add a PropertyChangeListener to the listener list.
 FileObjectgetArchive()
     Returns the archive file for the module of null if the archive file does not exist (for example, has not been compiled yet).
 IteratorgetArchiveContents()
     Returns the contents of the archive, in copyable form.
 FileObjectgetContentDirectory()
     This call is used in in-place deployment.
 FilegetDeploymentConfigurationFile(String name)
     Returns source deployment configuration file path for the given deployment configuration file name.
Parameters:
  name - file name of the deployment configuration file, WEB-INF/sun-web.xmlfor example.
 MetadataModel<T>getMetadataModel(Class<T> type)
     Returns a metadata model of a deployment descriptor specified by the type parameter.

As an example, passing org.netbeans.modules.j2ee.dd.api.web.WebAppMetadata.class as a type parameter will return a metadata model of the web module deployment descriptor - web.xml.


Parameters:
  type - metadata model type class for which a MetadataModelinstance will be returned.
 ObjectgetModuleType()
     Returns module type.
 StringgetModuleVersion()
     Returns a Java EE module specification version, version of a web application for example.
 FilegetResourceDirectory()
     Returns the module resource directory, or null if the module has no resource directory.
abstract  StringgetUrl()
     Returns the location of the module within the application archive.
 voidremovePropertyChangeListener(PropertyChangeListener listener)
     Remove a PropertyChangeListener from the listener list.



Method Detail
addPropertyChangeListener
void addPropertyChangeListener(PropertyChangeListener listener)(Code)
Add a PropertyChangeListener to the listener list.
Parameters:
  listener - PropertyChangeListener



getArchive
FileObject getArchive() throws java.io.IOException(Code)
Returns the archive file for the module of null if the archive file does not exist (for example, has not been compiled yet).



getArchiveContents
Iterator getArchiveContents() throws java.io.IOException(Code)
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. Iterator through RootedEntrys



getContentDirectory
FileObject getContentDirectory() throws java.io.IOException(Code)
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 J2eeModuleImplementation.getArchiveContents came from. FileObject for the content directory, return null if the module doesn't have a build directory, like an binary archive project



getDeploymentConfigurationFile
File getDeploymentConfigurationFile(String name)(Code)
Returns source deployment configuration file path for the given deployment configuration file name.
Parameters:
  name - file name of the deployment configuration file, WEB-INF/sun-web.xmlfor example. absolute path to the deployment configuration file, or null if thespecified file name is not known to this J2eeModule.



getMetadataModel
MetadataModel<T> getMetadataModel(Class<T> type)(Code)
Returns a metadata model of a deployment descriptor specified by the type parameter.

As an example, passing org.netbeans.modules.j2ee.dd.api.web.WebAppMetadata.class as a type parameter will return a metadata model of the web module deployment descriptor - web.xml.


Parameters:
  type - metadata model type class for which a MetadataModelinstance will be returned. metadata model of a deployment descriptor specified by the typeparameter.



getModuleType
Object getModuleType()(Code)
Returns module type. module type.



getModuleVersion
String getModuleVersion()(Code)
Returns a Java EE module specification version, version of a web application for example.

Do not confuse with the Java EE platform specification version. module specification version.




getResourceDirectory
File getResourceDirectory()(Code)
Returns the module resource directory, or null if the module has no resource directory. the module resource directory, or null if the module has no resourcedirectory.



getUrl
abstract String getUrl()(Code)
Returns the location of the module within the application archive. TODO: this does not belong here.. it has to be moved to J2eeApplication



removePropertyChangeListener
void removePropertyChangeListener(PropertyChangeListener listener)(Code)
Remove a PropertyChangeListener from the listener list.
Parameters:
  listener - PropertyChangeListener



w___ww___.__j__a__v___a2___s___.___c__om__ | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.