| java.lang.Object
 org.netbeans.modules.j2ee.deployment.plugins.spi.IncrementalDeployment
All known Subclasses: org.netbeans.tests.j2eeserver.plugin.IncrementalDeploySupport,
| IncrementalDeployment | | abstract public class IncrementalDeployment (Code) | | This interface replaces DeploymentManager calls deploy and redeploy during
directory-based deployment. The calling sequence is as following:
Initially, j2eeserver will call getDirectoryForNewApplication()
to request destination directory to deliver the being deployed application or
stand-alone module. In case of J2EE applications, getDirectoryForNewModule()
will be called for each child module.
After done with copying of files over to the destination, initialDeploy() will
be called to signal the copying is done. Processing of the returned ProgressObject
is the same as in DeploymentManager.distribute() call.
Subsequent deployments are incremental. For each root and child module the IDE will ask plugin
for destination directory by calling getDirectoryForModule(). After delivering
the changed files for all modules, the IDE then call incrementalDeploy with
the description of what have changed since previous deployment.
For in-place file deployment, where the file copying step is skipped, method
getDirectoryForNewApplication or getDirectoryForNewModule calls
return null.
J2eeserver optain an instance of IncrementalDeployment from server integration plugin by
calling
OptionalDeploymentManagerFactory to optain an instance of IncrementalDeployment
for each
javax.enterprise.deploy.spi.DeploymentManager instance.
author:
George Finklang |
| Method Summary | |
| abstract public boolean | canFileDeploy(Target target, J2eeModule deployable)
| | abstract public File | getDirectoryForModule(TargetModuleID module)
Return absolute path to which the IDE will write the content changes of specified module.
Parameters:
module - id for the target module. | | abstract public File | getDirectoryForNewApplication(Target target, J2eeModule app, ModuleConfiguration configuration)
Return absolute path which the IDE will write the specified app or
stand-alone module content to. | | public File | getDirectoryForNewApplication(String deploymentName, Target target, ModuleConfiguration configuration)
Return absolute path the IDE will write the app or stand-alone module content to. | | abstract public File | getDirectoryForNewModule(File appDir, String uri, J2eeModule module, ModuleConfiguration configuration)
Return absolute path to which the IDE will write the specified module content. | | public String | getModuleUrl(TargetModuleID module)
Get the URI pointing to location of child module inside a application archive. | | abstract public ProgressObject | incrementalDeploy(TargetModuleID module, AppChangeDescriptor changes)
Before this method is called, the on-disk representation of TargetModuleID
is updated.
Parameters:
module - the TargetModuleID of the deployed application or stand-alone module.
Parameters:
changes - AppChangeDescriptor describing what in the application changed. | | abstract public ProgressObject | initialDeploy(Target target, J2eeModule app, ModuleConfiguration configuration, File dir)
First time deployment file distribution. | | public void | notifyDeployment(TargetModuleID module)
Inform the plugin that the specified module is being deployed. |
| canFileDeploy | | abstract public boolean canFileDeploy(Target target, J2eeModule deployable)(Code) | | Whether the deployable object could be file deployed to the specified target
Parameters:
target - target in question
Parameters:
deployable - the deployable object in question true if it is possible to do file deployment |
| getDirectoryForModule | | abstract public File getDirectoryForModule(TargetModuleID module)(Code) | | Return absolute path to which the IDE will write the content changes of specified module.
Parameters:
module - id for the target module. absolute path root directory for the specified module. |
| getDirectoryForNewApplication | | abstract public File getDirectoryForNewApplication(Target target, J2eeModule app, ModuleConfiguration configuration)(Code) | | Return absolute path which the IDE will write the specified app or
stand-alone module content to.
Parameters:
target - target server of the deployment
Parameters:
app - the app or stand-alone module to deploy
Parameters:
configuration - server specific data for deployment absolute path root directory for the specified app ornull if server can accept the deployment from an arbitrary directory. |
| getDirectoryForNewApplication | | public File getDirectoryForNewApplication(String deploymentName, Target target, ModuleConfiguration configuration)(Code) | | Return absolute path the IDE will write the app or stand-alone module content to.
Note: to use deployment name, implementation nees to override this.
Parameters:
deploymentName - name to use in deployment
Parameters:
target - target server of the deployment
Parameters:
configuration - server specific data for deployment absolute path root directory for the specified app or null if server can accept the deployment from an arbitrary directory. |
| getDirectoryForNewModule | | abstract public File getDirectoryForNewModule(File appDir, String uri, J2eeModule module, ModuleConfiguration configuration)(Code) | | Return absolute path to which the IDE will write the specified module content.
Parameters:
appDir - the root directory of containing application
Parameters:
uri - the URI of child module within the app
Parameters:
module - the child module object to deploy
Parameters:
configuration - server specific data for deployment absolute path root directory for the specified module. |
| getModuleUrl | | public String getModuleUrl(TargetModuleID module)(Code) | | Get the URI pointing to location of child module inside a application archive.
Parameters:
module - TargetModuleID of the child module its relative path within application archive, returns null by default (for standalone module) |
| incrementalDeploy | | abstract public ProgressObject incrementalDeploy(TargetModuleID module, AppChangeDescriptor changes)(Code) | | Before this method is called, the on-disk representation of TargetModuleID
is updated.
Parameters:
module - the TargetModuleID of the deployed application or stand-alone module.
Parameters:
changes - AppChangeDescriptor describing what in the application changed. the ProgressObject providing feedback on deployment progress. |
| initialDeploy | | abstract public ProgressObject initialDeploy(Target target, J2eeModule app, ModuleConfiguration configuration, File dir)(Code) | | First time deployment file distribution. Before this method is called
the module content files should be ready in the destination location.
Parameters:
target - target of deployment
Parameters:
app - the app to deploy
Parameters:
configuration - server specific data for deployment
Parameters:
dir - the destination directory for the given deploy app the object for feedback on progress of deployment |
| notifyDeployment | | public void notifyDeployment(TargetModuleID module)(Code) | | Inform the plugin that the specified module is being deployed. Notification
is sent even if there is really nothing needed to be deployed.
Parameters:
module - module which is being deployed. |
|
|