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

Class Deployment

java.lang.Object

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

public final class Deployment
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Deployment.DeploymentException
static interface	Deployment.Logger
static class	Deployment.Mode Deployment mode enumeration

Method Summary

Modifier and Type	Method and Description
void	addInstanceListener(InstanceListener l) Register an instance listener that will listen to server instances changes.
boolean	canFileDeploy(String instanceId, J2eeModule mod) Determine if a server instance will attempt to use file deployment for a J2eeModule.
String	deploy(J2eeModuleProvider jmp, boolean debug, String clientModuleUrl, String clientUrlPart, boolean forceRedeploy) Deprecated. Should use Deployment.deploy(org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleProvider, org.netbeans.modules.j2ee.deployment.devmodules.api.Deployment.Mode, java.lang.String, java.lang.String, boolean) instead
String	deploy(J2eeModuleProvider jmp, boolean debug, String clientModuleUrl, String clientUrlPart, boolean forceRedeploy, Deployment.Logger logger) Deprecated. Should use Deployment.deploy(org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleProvider, org.netbeans.modules.j2ee.deployment.devmodules.api.Deployment.Mode, java.lang.String, java.lang.String, boolean, org.netbeans.modules.j2ee.deployment.devmodules.api.Deployment.Logger) instead
String	deploy(J2eeModuleProvider jmp, Deployment.Mode mode, String clientModuleUrl, String clientUrlPart, boolean forceRedeploy) Deploys a web J2EE module to server.
String	deploy(J2eeModuleProvider jmp, Deployment.Mode mode, String clientModuleUrl, String clientUrlPart, boolean forceRedeploy, Deployment.Logger logger)
String	deploy(J2eeModuleProvider jmp, Deployment.Mode mode, String clientModuleUrl, String clientUrlPart, boolean forceRedeploy, Deployment.Logger logger, Callable<Void> beforeDeploy) Deploys the module represented by the module provider.
void	disableCompileOnSaveSupport(J2eeModuleProvider provider)
void	enableCompileOnSaveSupport(J2eeModuleProvider provider)
static Deployment	getDefault()
String	getDefaultServerInstanceID() Deprecated. this API is broken by design - the client should choose the instance by usage Deployment.getServerInstanceIDs() and selection of appropriate server instance. Method will be removed in near future. See issue 83934.
String[]	getInstancesOfServer(String id)
J2eePlatform	getJ2eePlatform(String serverInstanceID) Deprecated. use getServerInstance(serverInstanceID).getJ2eePlatform()
String	getServerDisplayName(String id) Returns the display name of the server with given id.
String	getServerID(String instanceId) Deprecated. use getServerInstance(serverInstanceID).getServerID()
String[]	getServerIDs()
ServerInstance	getServerInstance(String serverInstanceId) Returns the server instance allowing client to query its properties and/or status.
String	getServerInstanceDisplayName(String id) Deprecated. use getServerInstance(serverInstanceID).getDisplayName()
String[]	getServerInstanceIDs()
String[]	getServerInstanceIDs(Collection<J2eeModule.Type> moduleTypes) Return ServerInstanceIDs of all registered server instances that support specified module types.
String[]	getServerInstanceIDs(Collection<J2eeModule.Type> moduleTypes, org.netbeans.api.j2ee.core.Profile profile) Return ServerInstanceIDs of all registered server instances that support specified module types and profile.
String[]	getServerInstanceIDs(Collection<J2eeModule.Type> moduleTypes, org.netbeans.api.j2ee.core.Profile profile, String[] tools) Return ServerInstanceIDs of all registered server instances that support specified module types, profile and tools.
String[]	getServerInstanceIDs(Object[] moduleTypes) Deprecated. Deployment.getServerInstanceIDs(java.util.Collection)
String[]	getServerInstanceIDs(Object[] moduleTypes, String specVersion) Deprecated. use #getServerInstanceIDs(java.util.Collection, org.netbeans.modules.j2ee.deployment.devmodules.api.Profile)
String[]	getServerInstanceIDs(Object[] moduleTypes, String specVersion, String[] tools) Deprecated. use #getServerInstanceIDs(java.util.Collection, org.netbeans.modules.j2ee.deployment.capabilities.Profile, java.lang.String[])
boolean	isRunning(String serverInstanceID) Deprecated. use getServerInstance(serverInstanceID).isRunning()
void	removeInstanceListener(InstanceListener l) Remove an instance listener which has been registered previously.
void	resumeDeployOnSave(J2eeModuleProvider jmp) Resumes the deploy on save execution.
void	suspendDeployOnSave(J2eeModuleProvider jmp) Suspends the deploy on save execution regardless of user selection.
void	undeploy(J2eeModuleProvider jmp, boolean startServer, Deployment.Logger logger) Undeploys the project (if it is deployed and available).

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static Deployment getDefault()

deploy

@Deprecated
public String deploy(J2eeModuleProvider jmp,
                                 boolean debug,
                                 String clientModuleUrl,
                                 String clientUrlPart,
                                 boolean forceRedeploy)
                          throws Deployment.DeploymentException

Deprecated. Should use Deployment.deploy(org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleProvider, org.netbeans.modules.j2ee.deployment.devmodules.api.Deployment.Mode, java.lang.String, java.lang.String, boolean) instead

Deploys a web J2EE module to server.

Parameters:

clientModuleUrl - URL of module within a J2EE Application that should be used as a client (can be null for standalone modules)

Note: if null for J2EE application the first web or client module will be used.

Returns:

complete URL to be displayed in browser (server part plus the client module and/or client part provided as a parameter)

Throws:

Deployment.DeploymentException

deploy

public String deploy(J2eeModuleProvider jmp,
                     Deployment.Mode mode,
                     String clientModuleUrl,
                     String clientUrlPart,
                     boolean forceRedeploy)
              throws Deployment.DeploymentException

Deploys a web J2EE module to server.

Parameters:

clientModuleUrl - URL of module within a J2EE Application that should be used as a client (can be null for standalone modules)

Note: if null for J2EE application the first web or client module will be used.

Returns:

complete URL to be displayed in browser (server part plus the client module and/or client part provided as a parameter)

Throws:

Deployment.DeploymentException

deploy

@Deprecated
public String deploy(J2eeModuleProvider jmp,
                                 boolean debug,
                                 String clientModuleUrl,
                                 String clientUrlPart,
                                 boolean forceRedeploy,
                                 Deployment.Logger logger)
                          throws Deployment.DeploymentException

Deprecated. Should use Deployment.deploy(org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleProvider, org.netbeans.modules.j2ee.deployment.devmodules.api.Deployment.Mode, java.lang.String, java.lang.String, boolean, org.netbeans.modules.j2ee.deployment.devmodules.api.Deployment.Logger) instead

Throws:

Deployment.DeploymentException

suspendDeployOnSave

public void suspendDeployOnSave(J2eeModuleProvider jmp)

Suspends the deploy on save execution regardless of user selection.

Parameters:

jmp - java ee project representation

Since:

1.79

resumeDeployOnSave

public void resumeDeployOnSave(J2eeModuleProvider jmp)

Resumes the deploy on save execution. If it was not preceeded by Deployment.suspendDeployOnSave(org.netbeans.modules.j2ee.deployment.devmodules.spi.J2eeModuleProvider) it is noop.

Parameters:

jmp - java ee project representation

Since:

1.79

deploy

public String deploy(J2eeModuleProvider jmp,
                     Deployment.Mode mode,
                     String clientModuleUrl,
                     String clientUrlPart,
                     boolean forceRedeploy,
                     Deployment.Logger logger)
              throws Deployment.DeploymentException

Throws:

Deployment.DeploymentException

deploy

@CheckForNull
public String deploy(J2eeModuleProvider jmp,
                                   Deployment.Mode mode,
                                   String clientModuleUrl,
                                   String clientUrlPart,
                                   boolean forceRedeploy,
                                   Deployment.Logger logger,
                                   @NullAllowed
                                   Callable<Void> beforeDeploy)
                            throws Deployment.DeploymentException

Deploys the module represented by the module provider.

Parameters:

jmp - the representation of module to deploy

mode - the mode we are going to use for the server

clientModuleUrl -

clientUrlPart -

forceRedeploy - whether to use the force to redeploy

logger - logger where to log progress messages

beforeDeploy - the hook to be executed just before the actual module deploy

Returns:

the result url where the module is available

Throws:

Deployment.DeploymentException - if the deployment fails

Since:

1.102

undeploy

public void undeploy(J2eeModuleProvider jmp,
                     boolean startServer,
                     Deployment.Logger logger)
              throws Deployment.DeploymentException

Undeploys the project (if it is deployed and available).

Parameters:

jmp - provider representing the project

startServer - if true server may be started while trying to determine whether the project is deployed

logger - logger for undeploy related events

Throws:

Deployment.DeploymentException

Since:

1.52

enableCompileOnSaveSupport

public void enableCompileOnSaveSupport(J2eeModuleProvider provider)

disableCompileOnSaveSupport

public void disableCompileOnSaveSupport(J2eeModuleProvider provider)

getServerInstanceIDs

public String[] getServerInstanceIDs()

getServerInstanceIDs

@Deprecated
public String[] getServerInstanceIDs(Object[] moduleTypes)

Deprecated. Deployment.getServerInstanceIDs(java.util.Collection)

Return ServerInstanceIDs of all registered server instances that support specified module types.

Parameters:

moduleTypes - list of module types that the server instance must support.

Returns:

ServerInstanceIDs of all registered server instances that meet the specified requirements.

Since:

1.6

getServerInstanceIDs

public String[] getServerInstanceIDs(Collection<J2eeModule.Type> moduleTypes)

Return ServerInstanceIDs of all registered server instances that support specified module types.

Parameters:

moduleTypes - collection of module types that the server instance must support

Returns:

ServerInstanceIDs of all registered server instances that meet the specified requirements.

Since:

1.59

getServerInstanceIDs

@Deprecated
public String[] getServerInstanceIDs(Object[] moduleTypes,
                                                 String specVersion)

Deprecated. use #getServerInstanceIDs(java.util.Collection, org.netbeans.modules.j2ee.deployment.devmodules.api.Profile)

Return ServerInstanceIDs of all registered server instances that support specified module types and J2EE specification versions.

Parameters:

moduleTypes - list of module types that the server instance must support.

specVersion - J2EE specification version that the server instance must support.

Returns:

ServerInstanceIDs of all registered server instances that meet the specified requirements.

Since:

1.6

getServerInstanceIDs

public String[] getServerInstanceIDs(Collection<J2eeModule.Type> moduleTypes,
                                     org.netbeans.api.j2ee.core.Profile profile)

Return ServerInstanceIDs of all registered server instances that support specified module types and profile.

Parameters:

moduleTypes - list of module types that the server instance must support

profile - profile that the server instance must support

Returns:

ServerInstanceIDs of all registered server instances that meet the specified requirements

Since:

1.59

getServerInstanceIDs

@Deprecated
public String[] getServerInstanceIDs(Object[] moduleTypes,
                                                 String specVersion,
                                                 String[] tools)

Deprecated. use #getServerInstanceIDs(java.util.Collection, org.netbeans.modules.j2ee.deployment.capabilities.Profile, java.lang.String[])

Return ServerInstanceIDs of all registered server instances that support specified module types, J2EE specification version and tools.

Parameters:

moduleTypes - list of module types that the server instance must support.

specVersion - J2EE specification version that the server instance must support.

tools - list of tools that the server instance must support.

Returns:

ServerInstanceIDs of all registered server instances that meet the specified requirements.

Since:

1.6

getServerInstanceIDs

public String[] getServerInstanceIDs(Collection<J2eeModule.Type> moduleTypes,
                                     org.netbeans.api.j2ee.core.Profile profile,
                                     String[] tools)

Return ServerInstanceIDs of all registered server instances that support specified module types, profile and tools.

Parameters:

moduleTypes - list of module types that the server instance must support

profile - profile that the server instance must support

tools - list of tools that the server instance must support

Returns:

ServerInstanceIDs of all registered server instances that meet the specified requirements

Since:

1.59

getServerInstanceDisplayName

@Deprecated
public String getServerInstanceDisplayName(String id)

Deprecated. use getServerInstance(serverInstanceID).getDisplayName()

Returns the display name of the instance identified by the given id.

Parameters:

id - id of the instance

Returns:

the display name of the instance, null if the instance does not exist or not defined

getServerID

@Deprecated
public String getServerID(String instanceId)

Deprecated. use getServerInstance(serverInstanceID).getServerID()

Returns the id of the server to which the instance represented by the id belongs to.

Parameters:

instanceId - id of the instance

Returns:

the id of the server, null if the instance does not exist

getDefaultServerInstanceID

@Deprecated
public String getDefaultServerInstanceID()

Deprecated. this API is broken by design - the client should choose the instance by usage Deployment.getServerInstanceIDs() and selection of appropriate server instance. Method will be removed in near future. See issue 83934.

Returns the default server instance or null if no default instance configured.

This method is deprecated, so don't expect it will return any useful default instance. Method will be removed in near future.

Returns:

the default server instance

canFileDeploy

public boolean canFileDeploy(String instanceId,
                             J2eeModule mod)

Determine if a server instance will attempt to use file deployment for a J2eeModule.

Parameters:

instanceId - The target instance's server id

mod - The module to be deployed

Returns:

Whether file deployment will be used

Since:

1.27

getInstancesOfServer

public String[] getInstancesOfServer(String id)

getServerInstance

public ServerInstance getServerInstance(String serverInstanceId)

Returns the server instance allowing client to query its properties and/or status.

Parameters:

serverInstanceId - id of the server instance

Returns:

server instance

Since:

1.45

getServerIDs

public String[] getServerIDs()

getJ2eePlatform

@Deprecated
public J2eePlatform getJ2eePlatform(String serverInstanceID)

Deprecated. use getServerInstance(serverInstanceID).getJ2eePlatform()

Return server instance's J2eePlatform.

Parameters:

serverInstanceID - server instance ID.

Returns:

J2eePlatform for the given server instance, null if server instance of the specified ID does not exist.

Since:

1.5

getServerDisplayName

public String getServerDisplayName(String id)

Returns the display name of the server with given id.

Client is usually searching for the display name of the server for particular instance. For this use getServerInstance(serverInstanceID).getServerDisplyName().

Parameters:

id - id of the server

Returns:

the display name of the server with given id, null if the server does not exist

isRunning

@Deprecated
public boolean isRunning(String serverInstanceID)

Deprecated. use getServerInstance(serverInstanceID).isRunning()

Returns true if the given server instance exists and is running, false otherwise.

Never call this method from the event dispatch thread since it might take several seconds before it finishes.

Parameters:

serverInstanceID - server instance ID.

Returns:

true if the given server instance is running, false otherwise.

Throws:

NullPointerException - if serverInstanceID is null.

Since:

1.32

addInstanceListener

public final void addInstanceListener(InstanceListener l)

Register an instance listener that will listen to server instances changes.

Parameters:

l - listener which should be added.

Since:

1.6

removeInstanceListener

public final void removeInstanceListener(InstanceListener l)

Remove an instance listener which has been registered previously.

Parameters:

l - listener which should be removed.

Since:

1.6