Package org.glassfish.deployapi

Class SunDeploymentManager.DeploymentFacilityModuleWork

  • Enclosing class:
    SunDeploymentManager
    protected static class SunDeploymentManager.DeploymentFacilityModuleWork
extends Object
    Encapsulates information used with a single invocation of a DeploymentFacility method-- that is, one item of "work" the DeploymentFacility is being asked to perform. This includes the single target ID of interest (because the DF methods operate on a single module), a collection of all the targets to be included in the operation on that module, and the progress object resulting from the DF method invocation.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addTarget​(javax.enterprise.deploy.spi.Target target)
      Adds a target to the collection of targets for the work to be done for this distinct module.
      String getModuleID()
      Reports the module ID for this instance of DeploymentFacilityModuleWork
      javax.enterprise.deploy.spi.status.ProgressObject getProgressObject()
      Returns the ProgressObject that the DeploymentFacility method returned when it was invoked.
      void setProgressObject​(javax.enterprise.deploy.spi.status.ProgressObject progressObject)
      Records the ProgressObject that the DeploymentFacility returned when its method was invoked.
      javax.enterprise.deploy.spi.Target[] targets()
      Returns an array of Target instances recorded for this module.

    • Constructor Detail

      • DeploymentFacilityModuleWork

        public DeploymentFacilityModuleWork​(String moduleID)
        Creates a new instance of DeploymentFacilityModuleWork.
        Parameters:
        moduleID - the module ID common to all work recorded in this instance

    • Method Detail

      • addTarget

        public void addTarget​(javax.enterprise.deploy.spi.Target target)
        Adds a target to the collection of targets for the work to be done for this distinct module.
        Parameters:
        target - the Target to be added for this module

      • targets

        public javax.enterprise.deploy.spi.Target[] targets()
        Returns an array of Target instances recorded for this module. Note the return of an array of runtime type TargetImpl[].
        Returns:
        array of Target

      • getProgressObject

        public javax.enterprise.deploy.spi.status.ProgressObject getProgressObject()
        Returns the ProgressObject that the DeploymentFacility method returned when it was invoked.
        Returns:
        the ProgressObject

      • setProgressObject

        public void setProgressObject​(javax.enterprise.deploy.spi.status.ProgressObject progressObject)
        Records the ProgressObject that the DeploymentFacility returned when its method was invoked.
        Parameters:
        progressObject - the ProgressObject provided by the DeploymentFacility method

      • getModuleID

        public String getModuleID()
        Reports the module ID for this instance of DeploymentFacilityModuleWork
        Returns:
        the module ID