org.netbeans.modules.j2ee.dd.api.client

Class DDProvider

java.lang.Object

org.netbeans.modules.j2ee.dd.api.client.DDProvider

public final class DDProvider
extends Object

Provides access to Deployment Descriptor root (AppClient object).

Method Summary

Methods

Modifier and Type	Method and Description
org.netbeans.modules.schema2beans.BaseBean	getBaseBean(CommonDDBean bean) Deprecated. do not use - temporary workaround that exposes the schema2beans implementation
AppClient	getDDRoot(File f) Returns the root of deployment descriptor bean graph for java.io.File object.
AppClient	getDDRoot(FileObject fo) Returns the root of deployment descriptor bean graph for given file object.
AppClient	getDDRootCopy(FileObject fo) Returns the root of deployment descriptor bean graph for given file object.
static DDProvider	getDefault() Accessor method for DDProvider singleton

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static DDProvider getDefault()

Accessor method for DDProvider singleton

Returns:

DDProvider object

getDDRoot

public AppClient getDDRoot(File f)
                    throws IOException,
                           SAXException

Returns the root of deployment descriptor bean graph for java.io.File object.

Parameters:

f - File representing the web.xml file

Returns:

appClient object - root of the deployment descriptor bean graph

Throws:

IOException

SAXException

getDDRoot

public AppClient getDDRoot(FileObject fo)
                    throws IOException

Returns the root of deployment descriptor bean graph for given file object. The method is useful for clints planning to read only the deployment descriptor or to listen to the changes.

Parameters:

fo - FileObject representing the application-client.xml file

Returns:

AppClient object - root of the deployment descriptor bean graph

Throws:

IOException

getDDRootCopy

public AppClient getDDRootCopy(FileObject fo)
                        throws IOException

Returns the root of deployment descriptor bean graph for given file object. The method is useful for clients planning to modify the deployment descriptor. Finally the RootInterface.write(org.openide.filesystems.FileObject) should be used for writing the changes.

Parameters:

fo - FileObject representing the ejb-jar.xml file

Returns:

EjbJar object - root of the deployment descriptor bean graph

Throws:

IOException

getBaseBean

public org.netbeans.modules.schema2beans.BaseBean getBaseBean(CommonDDBean bean)

Deprecated. do not use - temporary workaround that exposes the schema2beans implementation

Convenient method for getting the BaseBean object from CommonDDBean object. The j2eeserver module needs BaseBean to implement jsr88 API. This is a temporary workaround until the implementation of jsr88 moves into ddapi or the implementation in j2eeserver gets changed.