org.netbeans.modules.j2ee.deployment.devmodules.api
Class ServerInstance

java.lang.Object
  org.netbeans.modules.j2ee.deployment.devmodules.api.ServerInstance

public final class ServerInstance
extends Object

The class allowing the client to query the instance identified by the instance ID. Because corresponding instance can be removed anytime each method can throw InstanceRemovedException.

Since:

1.45

Nested Class Summary

class

ServerInstance.Descriptor Descriptor providing extra (and optional) information about the server instance.

Method Summary

ServerInstance.Descriptor	getDescriptor() Returns descriptor providing extra information about the instance.
String	getDisplayName() Returns the display name of this instance.
J2eePlatform	getJ2eePlatform() Returns the platform for this instance.
String	getServerDisplayName() Returns the display name of the server.
String	getServerID() Returns the ID of the server associated with this instance.
boolean	isDeployOnSaveSupported() Returns true when the deploy on save is supported by the server.
boolean	isDeployOnSaveSupported(J2eeModule module) Returns true when the deploy on save is supported by the server for the given module.
boolean	isRunning() Returns true if this instance is running, false otherwise.

Methods inherited from class java.lang.Object

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

Method Detail

getDisplayName

public String getDisplayName()
                      throws InstanceRemovedException

Returns the display name of this instance.

Returns:

the display name of this instance

Throws:

InstanceRemovedException - if the instance is not available anymore

getServerDisplayName

public String getServerDisplayName()
                            throws InstanceRemovedException

Returns the display name of the server.

Returns:

the display name of the server

Throws:

InstanceRemovedException - if the instance is not available anymore

getServerID

public String getServerID()
                   throws InstanceRemovedException

Returns the ID of the server associated with this instance.

Returns:

the ID of the server associated with this instance

Throws:

InstanceRemovedException - if the instance is not available anymore

isRunning

public boolean isRunning()
                  throws InstanceRemovedException

Returns true if this instance is running, false otherwise.

Returns:

true if this instance is running, false otherwise

Throws:

InstanceRemovedException - if the instance is not available anymore

getJ2eePlatform

public J2eePlatform getJ2eePlatform()
                             throws InstanceRemovedException

Returns the platform for this instance.

Returns:

the platform for this instance

Throws:

InstanceRemovedException - if the instance is not available anymore

isDeployOnSaveSupported

public boolean isDeployOnSaveSupported(J2eeModule module)
                                throws InstanceRemovedException

Returns true when the deploy on save is supported by the server for the given module.

Parameters:

module - module representing the application

Returns:

true when the deploy on save is supported by the server for the given module

Throws:

InstanceRemovedException - if the instance is not available anymore

Since:

1.49

isDeployOnSaveSupported

public boolean isDeployOnSaveSupported()
                                throws InstanceRemovedException

Returns true when the deploy on save is supported by the server.

Returns:

true when the deploy on save is supported by the server

Throws:

InstanceRemovedException - if the instance is not available anymore

Since:

1.53

getDescriptor

public ServerInstance.Descriptor getDescriptor()
                                        throws InstanceRemovedException

Returns descriptor providing extra information about the instance. May return null if the server does not support this.

Returns:

descriptor providing extra information about the instance or null

Throws:

InstanceRemovedException - if the instance is not available anymore

Since:

1.46