Package jetbrains.buildServer.tools.impl

Class CustomArchiveServerToolProvider

java.lang.Object

jetbrains.buildServer.tools.ServerToolProviderAdapter

jetbrains.buildServer.tools.impl.CustomArchiveServerToolProvider

All Implemented Interfaces:

TeamCityExtension, ServerToolProvider, PositionAware, PositionConstraintAware

public class CustomArchiveServerToolProvider
extends ServerToolProviderAdapter
implements PositionAware

Created by Evgeniy.Koshkin.

Constructor Summary

Constructors

Constructor	Description
CustomArchiveServerToolProvider(AgentPluginXmlParser agentPluginXmlParser, ArchiveExtractorManager archiveExtractorManager)

Method Summary

Modifier and Type	Method	Description
PositionConstraint	getConstraint()	Constraint to be respected during objects sorting.
String	getOrderId()	Returns object id that can be referenced by {PositionConstraint}
ToolType	getType()
GetPackageVersionResult	tryGetPackageVersion(File toolPackage)	Retrieve tool version if given package has valid tool package format.
void	unpackToolPackage(File toolPackage, File targetDirectory)	Unpack valid tool package to the target directory.

Methods inherited from class jetbrains.buildServer.tools.ServerToolProviderAdapter

fetchToolPackage, getAvailableToolVersions, getBundledToolVersions, getDefaultBundledVersionId, getDownloadableBundledToolVersions, normalizeToolPackageName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomArchiveServerToolProvider

public CustomArchiveServerToolProvider(@NotNull
                                       AgentPluginXmlParser agentPluginXmlParser,
                                       @NotNull
                                       ArchiveExtractorManager archiveExtractorManager)

Method Detail

getType

@NotNull
public ToolType getType()

Specified by:

getType in interface ServerToolProvider

tryGetPackageVersion

@NotNull
public GetPackageVersionResult tryGetPackageVersion(@NotNull
                                                    File toolPackage)

Description copied from interface: ServerToolProvider

Retrieve tool version if given package has valid tool package format.

Specified by:

tryGetPackageVersion in interface ServerToolProvider

Overrides:

tryGetPackageVersion in class ServerToolProviderAdapter

Parameters:

toolPackage - Package to inspect.

Returns:

Version of the tool or GetPackageVersionResult.error(String) if package format is unknown / invalid.

unpackToolPackage

public void unpackToolPackage(@NotNull
                              File toolPackage,
                              @NotNull
                              File targetDirectory)
                       throws ToolException

Description copied from interface: ServerToolProvider

Unpack valid tool package to the target directory. Form directory layout to use later on the agent.

Specified by:

unpackToolPackage in interface ServerToolProvider

Overrides:

unpackToolPackage in class ServerToolProviderAdapter

Parameters:

toolPackage - file with the tool package

targetDirectory - existing empty directory

Throws:

ToolException - if error occurs

getOrderId

@NotNull
public String getOrderId()

Description copied from interface: PositionAware

Returns object id that can be referenced by {PositionConstraint}

Specified by:

getOrderId in interface PositionAware

Returns:

object id

getConstraint

@NotNull
public PositionConstraint getConstraint()

Description copied from interface: PositionConstraintAware

Constraint to be respected during objects sorting.

Specified by:

getConstraint in interface PositionConstraintAware

Returns:

position constraint