Package jetbrains.buildServer.agent.server

Class XmlRpcAgentFileManager

java.lang.Object

jetbrains.buildServer.agent.server.XmlRpcAgentFileManager

All Implemented Interfaces:

FileManagerExtensionHolder, LowLevelAgentFileManager

public class XmlRpcAgentFileManager
extends Object
implements LowLevelAgentFileManager, FileManagerExtensionHolder

XML-RPC file manager handler.

Since:

6.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Field Summary

Fields inherited from interface jetbrains.buildServer.agentServer.LowLevelAgentFileManager

HANDLER

Constructor Summary

Constructors

Constructor	Description
XmlRpcAgentFileManager(BuildAgentConfiguration configuration, ServerCommandsHandlersRegistry serverCommandsHandlersRegistry, ServerFileUploader uploader)

Method Summary

Modifier and Type	Method	Description
void	addHandler(String root, CustomFileHandler handler)	Adds the custom handler
void	removeHandler(String root)	Removes the custom handler
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlRpcAgentFileManager

public XmlRpcAgentFileManager(@NotNull
                              BuildAgentConfiguration configuration,
                              @NotNull
                              ServerCommandsHandlersRegistry serverCommandsHandlersRegistry,
                              @NotNull
                              ServerFileUploader uploader)

Method Detail

requestFile

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

Description copied from interface: LowLevelAgentFileManager

Requests a file or a directory from the agent.

Specified by:

requestFile in interface LowLevelAgentFileManager

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

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

Description copied from interface: LowLevelAgentFileManager

Requests a file or a directory from the agent.

Specified by:

requestFile in interface LowLevelAgentFileManager

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

public String requestDirectoryStructureFast(@NotNull
                                            String fileName)

Description copied from interface: LowLevelAgentFileManager

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

Specified by:

requestDirectoryStructureFast in interface LowLevelAgentFileManager

Parameters:

fileName - the requested file

Returns:

serialized directory structure

addHandler

public void addHandler(@NotNull
                       String root,
                       @NotNull
                       CustomFileHandler handler)

Description copied from interface: FileManagerExtensionHolder

Adds the custom handler

Specified by:

addHandler in interface FileManagerExtensionHolder

Parameters:

root - the root (should start with a '#')

handler - the handler

removeHandler

public void removeHandler(@NotNull
                          String root)

Description copied from interface: FileManagerExtensionHolder

Removes the custom handler

Specified by:

removeHandler in interface FileManagerExtensionHolder

Parameters:

root - the root