Package jetbrains.buildServer.agentServer

Interface LowLevelAgentFileManager

All Known Implementing Classes:

XmlRpcAgentFileManager

public interface LowLevelAgentFileManager

Represents a low-level interface for requesting the files from agent. TeamCity plugins are not expected to use this interface.

Since:

6.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Field Summary

Fields

Modifier and Type	Field	Description
static String	HANDLER

Method Summary

Modifier and Type	Method	Description
String	requestDirectoryStructureFast(String fileName)	Requests the directory structure from the agent.
boolean	requestFile(String sessionId, String publicKey, String fileName)	Requests a file or a directory from the agent.
boolean	requestFile(String sessionId, String publicKey, String fileName, String nodeId)	Requests a file or a directory from the agent.

Field Detail

HANDLER

static final String HANDLER

See Also:

Constant Field Values

Method Detail

requestFile

boolean requestFile(@NotNull
                    String sessionId,
                    @NotNull
                    String publicKey,
                    @NotNull
                    String fileName)

Requests a file or a directory from the agent.

Parameters:

sessionId - session id (generated by server)

publicKey - public key data (generated by server)

fileName - the requested file

Returns:

true if the request was received, false otherwise

requestFile

boolean requestFile(@NotNull
                    String sessionId,
                    @NotNull
                    String publicKey,
                    @NotNull
                    String fileName,
                    @NotNull
                    String nodeId)

Requests a file or a directory from the agent.

Parameters:

sessionId - session id (generated by server)

publicKey - public key data (generated by server)

fileName - the requested file

nodeId - id of the node requesting the information

Returns:

true if the request was received, false otherwise

requestDirectoryStructureFast

@Nullable
String requestDirectoryStructureFast(@NotNull
                                     String fileName)

Requests the directory structure from the agent. Serialized result is returned in this call (that's why method is "fast").

Parameters:

fileName - the requested file

Returns:

serialized directory structure