Package jetbrains.buildServer.serverSide.impl.agent

Class AgentFileManagerImpl

java.lang.Object

jetbrains.buildServer.serverSide.impl.agent.AgentFileManagerImpl

All Implemented Interfaces:

AgentFileManagerCallback, SAgentFileManager

public class AgentFileManagerImpl
extends Object
implements SAgentFileManager, AgentFileManagerCallback

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.agent.SAgentFileManager

SAgentFileManager.Callback

Constructor Summary

Constructors

Constructor	Description
AgentFileManagerImpl(BuildAgentManager buildAgentManager, AgentFileManagerCache cache, XStreamHolder xStreamHolder)

Method Summary

Modifier and Type	Method	Description
void	error(String sessionId, String error)
RemoteFileStructure	requestDirectoryStructure(String agentName, String directoryName)	Performs a synchronous request on agent agentName and returns the remote structure of the directory directoryName (or possibly a file).
void	requestForFile(String agentName, String fileName, boolean lookupInCache, SAgentFileManager.Callback callback)	Performs asynchronous request to the agent agentName for a fileName file (or directory).
void	success(String sessionId, org.springframework.web.multipart.MultipartFile data, boolean archived)

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentFileManagerImpl

public AgentFileManagerImpl(@NotNull
                            BuildAgentManager buildAgentManager,
                            @NotNull
                            AgentFileManagerCache cache,
                            @NotNull
                            XStreamHolder xStreamHolder)

Method Detail

requestForFile

public void requestForFile(@NotNull
                           String agentName,
                           @NotNull
                           String fileName,
                           boolean lookupInCache,
                           @NotNull
                           SAgentFileManager.Callback callback)

Description copied from interface: SAgentFileManager

Performs asynchronous request to the agent agentName for a fileName file (or directory). The caller is notified about the result via callback. In case of success the caller is provided with the local copy of the requested file.

The fileName supports several useful macros: "#home", "#work", "#temp", "#logs", "#plugins", "#lib", "#update", "#conf", and "#cache", each referring to a specific agent directory. These macros are to be used to specify the root of the requested file (or directory).

Examples:

• "#logs" - full logs directory
• "#work/directory.map" - a "directory.map" file inside agent working directory
• "#plugins/ant/lib" - full "lib" directory of the Ant plugin

Current limitations:

• you can use only slash separator ('/' instead of '\')
• wildcards "?" and "*" are not supported

By default all transferred data is encrypted.

Specified by:

requestForFile in interface SAgentFileManager

Parameters:

agentName - the name of agent to request to

fileName - file (or directory) name in the format above

lookupInCache - if set to true, server will try to use cached data

callback - the callback

error

public void error(@NotNull
                  String sessionId,
                  @NotNull
                  String error)

Specified by:

error in interface AgentFileManagerCallback

success

public void success(@NotNull
                    String sessionId,
                    @NotNull
                    org.springframework.web.multipart.MultipartFile data,
                    boolean archived)

Specified by:

success in interface AgentFileManagerCallback

requestDirectoryStructure

@Nullable
public RemoteFileStructure requestDirectoryStructure(@NotNull
                                                     String agentName,
                                                     @NotNull
                                                     String directoryName)

Description copied from interface: SAgentFileManager

Performs a synchronous request on agent agentName and returns the remote structure of the directory directoryName (or possibly a file). Method returns null in case of error.

The directoryName format is the same as in SAgentFileManager.requestForFile(String, String, boolean, Callback).

Specified by:

requestDirectoryStructure in interface SAgentFileManager

Parameters:

agentName - the name of agent to request to

directoryName - directory (or file) name

Returns:

the directory structure, or null