public class DoorsApplication
extends com.sodius.mdw.internal.platform.doors.InternalDoorsApplication
Connection to an active DOORS client is made using the DOORS COM automation layer. This requires the DOORS client to be running on the same host as the Java program. Connecting to a DOORS client executed in a virtual environment (e.g. through CITRIX) is not supported.
To connect to a DOORS client in batch mode, refer to DoorsUtils.createApplication()
.
This class is not intended to be subclassed by clients but may be instantiated.
Modifier and Type | Class and Description |
---|---|
static interface |
DoorsApplication.Factory
Clients are advised not to use this class.
|
Modifier and Type | Field and Description |
---|---|
static int |
ERROR_DOORS_NOT_RUNNING
The status code of the exception throws when a DOORS client is not running.
|
static String |
OPTION_FETCH_ALL_CHILDREN
Deprecated.
Clients are advised not to use this field.
|
static String |
PLUGIN_ID
The Eclipse Plug-In ID this class belongs to.
|
Constructor and Description |
---|
DoorsApplication()
Instantiates a
DoorsApplication . |
Modifier and Type | Method and Description |
---|---|
void |
checkIsRunning()
Verifies a DOORS client is currently running an throws an exception if not.
|
void |
dispose()
Disposes internal resources used by this application.
|
DoorsDatabase |
getDatabase()
Retrieve an instance representing the DOORS database,
to get access to available folders and modules.
|
DoorsDatabase |
getDatabase(Map<String,?> options)
Retrieve an instance representing the DOORS database,
to get access to available folders and modules.
|
boolean |
isBatch()
Always return
false as the DOORS client this instance connects to is not running in batch mode. |
boolean |
isRunning()
Determines whether a DOORS client is currently running on the workstation.
|
int |
runFile(File file)
Executes the specified DXL script.
|
public static final String PLUGIN_ID
@Deprecated public static final String OPTION_FETCH_ALL_CHILDREN
public static final int ERROR_DOORS_NOT_RUNNING
checkIsRunning()
,
Constant Field Valuespublic DoorsApplication()
DoorsApplication
.
No connection to DOORS is performed in this constructor.public void dispose()
dispose
in class com.sodius.mdw.internal.platform.doors.InternalDoorsApplication
public boolean isRunning()
true
if a DOORS client is currently running, false
otherwise.public void checkIsRunning() throws org.eclipse.core.runtime.CoreException
DoorsApplication.ERROR_DOORS_NOT_RUNNING
.checkIsRunning
in class com.sodius.mdw.internal.platform.doors.InternalDoorsApplication
org.eclipse.core.runtime.CoreException
- if a DOORS client is not currently running.isRunning()
,
ERROR_DOORS_NOT_RUNNING
public boolean isBatch()
false
as the DOORS client this instance connects to is not running in batch mode.isBatch
in class com.sodius.mdw.internal.platform.doors.InternalDoorsApplication
false
as the DOORS client this instance connects to is not running in batch mode.public DoorsDatabase getDatabase() throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException
- if anything prevents from connecting to DOORS.public DoorsDatabase getDatabase(Map<String,?> options) throws org.eclipse.core.runtime.CoreException
getDatabase()
method.options
- options to configure the access to the DOORS client.org.eclipse.core.runtime.CoreException
- if anything prevents from connecting to DOORS.getDatabase()
public int runFile(File file) throws org.eclipse.core.runtime.CoreException
runFile
in class com.sodius.mdw.internal.platform.doors.InternalDoorsApplication
file
- a file containing a DXL script to execute.0
if successful or 1
is something went wrong.org.eclipse.core.runtime.CoreException
- if anything prevents the DXL script to execute properly.