com.pmease.quickbuild
Interface RemoteService


public interface RemoteService

QuickBuild remote interface

Author:
robin shine

Method Summary
 void createLabelOnBuild(java.lang.Long buildId, java.lang.String labelName)
          Create a label on specified build.
 BuildFacade getBuild(java.lang.Long configurationId, java.lang.String buildVersion)
          Get specified build from specified configuration.
 BuildFacade getBuildByLabel(java.lang.Long configurationId, java.lang.String labelName)
          Get build by specified label inside specified configuration.
 ConfigurationFacade getConfiguration(java.lang.String configurationHierarchyName)
          Get configuration by specified name
 BuildFacade getLastBuild(java.lang.Long configurationId)
          Get last build from specified configuration.
 BuildFacade getLastSuccessBuild(java.lang.Long configurationId)
          Get last successful build from specified configuration.
 BuildFacade getLatestBuild(java.lang.Long configurationId)
          Get latest build from specified configuration.
 boolean isLooping(java.lang.Long configurationId, java.util.List traversedConfigurationGuids)
          Check if there is a looping dependency.
 java.util.List listFiles(java.lang.Long buildId, java.lang.String directory, java.lang.String pattern)
          List all files matching specified pattern under specified directory of specified build.
 void triggerBuild(java.lang.Long configurationId, BuildSettingFacade buildSetting)
          Trigger build in specified configuration with specified build settings.
 BuildFacade triggerDependent(java.lang.Long configurationId, DependentContext dependentContext)
          Trigger dependent build in specified configuration with specified triggering context.
 

Method Detail

getConfiguration

public ConfigurationFacade getConfiguration(java.lang.String configurationHierarchyName)
Get configuration by specified name

Parameters:
configurationHierarchyName - specify configuration name
Returns:
null if not exist

triggerBuild

public void triggerBuild(java.lang.Long configurationId,
                         BuildSettingFacade buildSetting)
Trigger build in specified configuration with specified build settings.

Parameters:
configurationId - specify identifier of the configuration
buildSetting - specify build settings

triggerDependent

public BuildFacade triggerDependent(java.lang.Long configurationId,
                                    DependentContext dependentContext)
Trigger dependent build in specified configuration with specified triggering context.

Parameters:
configurationId - specify configuration identifier
dependentContext - specify dependent context
Returns:
should not be null

getLatestBuild

public BuildFacade getLatestBuild(java.lang.Long configurationId)
Get latest build from specified configuration. Latest build is the most recent build, the status may be successful, failed, or running.

Parameters:
configurationId - specify configuration identifier
Returns:
null if latest build does not exist

getLastBuild

public BuildFacade getLastBuild(java.lang.Long configurationId)
Get last build from specified configuration. Last build means the latest finished build. The status should only be successful or failed.

Parameters:
configurationId - specify configuration identifier
Returns:
null if last build does not exist

getLastSuccessBuild

public BuildFacade getLastSuccessBuild(java.lang.Long configurationId)
Get last successful build from specified configuration.

Parameters:
configurationId - specify configuration identifier
Returns:
null if last successful build does not exist

getBuild

public BuildFacade getBuild(java.lang.Long configurationId,
                            java.lang.String buildVersion)
Get specified build from specified configuration.

Parameters:
configurationId - specify configuration
buildVersion - specify build version
Returns:
null if specified build version not exist

getBuildByLabel

public BuildFacade getBuildByLabel(java.lang.Long configurationId,
                                   java.lang.String labelName)
Get build by specified label inside specified configuration.

Parameters:
configurationId - specify configuration identifier this label belongs to
labelName - specify the label name
Returns:
null if specified build label does not exist

createLabelOnBuild

public void createLabelOnBuild(java.lang.Long buildId,
                               java.lang.String labelName)
Create a label on specified build.

Parameters:
buildId - specify identifier of the build
labelName - specify the label name

isLooping

public boolean isLooping(java.lang.Long configurationId,
                         java.util.List traversedConfigurationGuids)
Check if there is a looping dependency.

Parameters:
configurationId -
traversedConfigurationGuids -
Returns:

listFiles

public java.util.List listFiles(java.lang.Long buildId,
                                java.lang.String directory,
                                java.lang.String pattern)
List all files matching specified pattern under specified directory of specified build.

Parameters:
buildId - specify build identifier
directory - specify directory relative to publish directory of specified build. "/" means publish directory itself
Returns:
recursive list of files under this directory matching specifie pattern. Element is of type RemoteFile. null means specified directory does not exist.


Copyright © 2005 PMEase Inc. All Rights Reserved.