org.azyva.dragom.model.plugin

Interface RemoteBuilderPlugin.RemoteBuildHandle

Enclosing interface:

RemoteBuilderPlugin

public static interface RemoteBuilderPlugin.RemoteBuildHandle

Represents a remote build and allows obtaining its status and interacting with it.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RemoteBuilderPlugin.RemoteBuildHandle.RemoteBuildStatus Possible remote build statuses.

Method Summary

Modifier and Type	Method and Description
String	getCannotBuildRemotelyReason() Returns the reason why the build cannot be performed remotely.
String	getLocation()
void	getLog(Writer writerLog) Writes the log of the build in the provided Writer.
ModuleVersion	getModuleVersion()
RemoteBuilderPlugin.RemoteBuildHandle.RemoteBuildStatus	getRemoteBuildStatus() Returns the RemoteBuilderPlugin.RemoteBuildHandle.RemoteBuildStatus.
boolean	isSuccess() Indicates the build was successful, as opposed to a failure.
void	waitCompleted() Blocks until the remote build is completed.

Method Detail

getModuleVersion

ModuleVersion getModuleVersion()

Returns:

ModuleVersion associated with the remote build.

getLocation

String getLocation()

Returns:

Human-readable description of the location where the remote build executes. For example, this can include the URL of a job build in Jenkins.

getRemoteBuildStatus

RemoteBuilderPlugin.RemoteBuildHandle.RemoteBuildStatus getRemoteBuildStatus()

Returns the RemoteBuilderPlugin.RemoteBuildHandle.RemoteBuildStatus.

If the last known status of the build is such that it can change, this method should query the remote build system for the new status.

However, if the last known status of the build is RemoteBuilderPlugin.RemoteBuildHandle.RemoteBuildStatus.CANNOT_BUILD_REMOTELY or RemoteBuilderPlugin.RemoteBuildHandle.RemoteBuildStatus.COMPLETED, it is expected to be returned immediately without wasting time querying the remote build system.

Returns:

RemoteBuildStatus.

getCannotBuildRemotelyReason

String getCannotBuildRemotelyReason()

Returns the reason why the build cannot be performed remotely.

Can only be called if getRemoteBuildStatus returned RemoteBuildStatus.CANNOT_BUILD_REMOTELY.

Returns:

See description.

waitCompleted

void waitCompleted()

Blocks until the remote build is completed.

isSuccess

boolean isSuccess()

Indicates the build was successful, as opposed to a failure.

If the build is not completed, this method blocks until it is.

Returns:

Indicates the build was successful.

getLog

void getLog(Writer writerLog)

Writes the log of the build in the provided Writer.

If the build is not completed, this method blocks until it is.

Parameters:

writerLog - Writer.