Package org.rundeck.app.components.jobs

Interface JobDefinitionComponent

  • public interface JobDefinitionComponent
    extension for importing job definitions

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void didDeleteJob​(java.lang.Object job, com.dtolabs.rundeck.core.authorization.AuthContext authContext)
      The indicated job was deleted
      java.util.Map exportCanonicalMap​(java.util.Map jobDataMap)
      Return modified canonical Job Map
      default java.util.Map exportCanonicalMap​(java.util.Map jobDataMap, java.lang.Object associate)
      Return modified canonical Job Map
      java.util.Map exportXMap​(java.util.Map jobXMap)
      Return modified Xmap
      default UISection getInputLocation()  
      default java.util.List<Property> getInputProperties()  
      default java.util.Map<java.lang.String,​java.lang.String> getInputPropertyValues​(java.lang.Object job, java.lang.Object associate)  
      java.lang.String getName()  
      java.lang.Object importCanonicalMap​(java.lang.Object job, java.util.Map jobDataMap)
      Import job map data, if necessary return a temporary object associated with the Job
      java.util.Map importXMap​(java.util.Map jobXMap, java.util.Map partialMap)
      convert imported Xmap to canonical map form, this method should modify the partialMap if ncessary
      void persist​(java.lang.Object job, java.lang.Object associate, com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext)
      Persist the changes for the associated object for the job
      java.lang.Object updateJob​(java.lang.Object job, java.lang.Object imported, java.lang.Object associate, java.util.Map params)
      Update a job given the imported definition or web parameters
      default Validator.Report validateImported​(java.lang.Object job, java.lang.Object associate)
      Validate the associated object for the job, the default validation will apply normal Property validation to the value return from getInputPropertyValues(Object, Object)
      void wasPersisted​(java.lang.Object job, java.lang.Object associate, com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext)
      Callback after persist for the job completes
      void willDeleteJob​(java.lang.Object job, com.dtolabs.rundeck.core.authorization.AuthContext authContext)
      The indicated job will be deleted

    • Method Detail

      • getName

        java.lang.String getName()
        Returns:
        a unique name to associated imported objects temporarily

      • exportCanonicalMap

        java.util.Map exportCanonicalMap​(java.util.Map jobDataMap)
        Return modified canonical Job Map
        Parameters:
        jobDataMap - source canonical job map
        Returns:
        modified canonical job map

      • exportCanonicalMap

        default java.util.Map exportCanonicalMap​(java.util.Map jobDataMap,
                                         java.lang.Object associate)
        Return modified canonical Job Map
        Parameters:
        jobDataMap - source canonical job map
        Returns:
        modified canonical job map

      • exportXMap

        java.util.Map exportXMap​(java.util.Map jobXMap)
        Return modified Xmap
        Parameters:
        jobXMap - source xmap
        Returns:
        modified xmap

      • importXMap

        java.util.Map importXMap​(java.util.Map jobXMap,
                         java.util.Map partialMap)
        convert imported Xmap to canonical map form, this method should modify the partialMap if ncessary
        Parameters:
        jobXMap - the input Xmap data
        partialMap - basic canonical map already created from Xmap
        Returns:
        new map data (or null)

      • importCanonicalMap

        java.lang.Object importCanonicalMap​(java.lang.Object job,
                                    java.util.Map jobDataMap)
        Import job map data, if necessary return a temporary object associated with the Job
        Parameters:
        job - the defined job item
        jobDataMap - final canonical job data map
        Returns:
        associated object

      • updateJob

        java.lang.Object updateJob​(java.lang.Object job,
                           java.lang.Object imported,
                           java.lang.Object associate,
                           java.util.Map params)
        Update a job given the imported definition or web parameters
        Parameters:
        job - job to update, may be a new job
        imported - imported job definition to apply to update job, may be null
        associate - associated object created via importCanonicalMap(Object, Map), may be null
        params - web parameters
        Returns:

      • validateImported

        default Validator.Report validateImported​(java.lang.Object job,
                                          java.lang.Object associate)
        Validate the associated object for the job, the default validation will apply normal Property validation to the value return from getInputPropertyValues(Object, Object)
        Parameters:
        job - job
        associate - associated object
        Returns:
        validation report, or null when no inputProperties are defined. null indicates valid

      • persist

        void persist​(java.lang.Object job,
             java.lang.Object associate,
             com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext)
        Persist the changes for the associated object for the job
        Parameters:
        job - the job
        associate - associated object
        authContext - auth context

      • wasPersisted

        void wasPersisted​(java.lang.Object job,
                  java.lang.Object associate,
                  com.dtolabs.rundeck.core.authorization.UserAndRolesAuthContext authContext)
        Callback after persist for the job completes
        Parameters:
        job - the job
        associate - associated object
        authContext - auth context

      • willDeleteJob

        void willDeleteJob​(java.lang.Object job,
                   com.dtolabs.rundeck.core.authorization.AuthContext authContext)
        The indicated job will be deleted
        Parameters:
        job -
        authContext -

      • didDeleteJob

        void didDeleteJob​(java.lang.Object job,
                  com.dtolabs.rundeck.core.authorization.AuthContext authContext)
        The indicated job was deleted
        Parameters:
        job -
        authContext -

      • getInputLocation

        default UISection getInputLocation()
        Returns:
        UI Location for any input properties on the Job Edit page

      • getInputProperties

        default java.util.List<Property> getInputProperties()
        Returns:
        list of input properties for job editor

      • getInputPropertyValues

        default java.util.Map<java.lang.String,​java.lang.String> getInputPropertyValues​(java.lang.Object job,
                                                                                      java.lang.Object associate)
        Parameters:
        job -
        Returns:
        Map of property values for the input properties for the component