com.kapowtech.robosuite.api.java.repository.engine

Class AbstractRepositoryClient

java.lang.Object

com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

All Implemented Interfaces:

RepositoryClient

Direct Known Subclasses:

RepositoryClientImpl

public abstract class AbstractRepositoryClient
extends java.lang.Object
implements RepositoryClient

The abstract client doesn't specify how the data is transported to the repository, which allow us to mock this part for tests.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRepositoryClient() Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	deleteConnector(java.lang.String projectName, java.lang.String connectorName, boolean silent) Deletes a connector from the repository
void	deleteConnector(java.lang.String projectName, java.lang.String connectorName, boolean silent, AdditionalInfo additionalInfo) Deletes a connector from the repository
void	deleteFile(RepositoryFile file) Delete a RepositoryFile
void	deleteFile(RepositoryFile file, AdditionalInfo additionalInfo)
void	deleteFolder(java.lang.String projectName, java.lang.String folderPath) Delete a folder
void	deleteFolder(java.lang.String projectName, java.lang.String folderPath, AdditionalInfo additionalInfo) Delete a folder
void	deleteResource(java.lang.String projectName, java.lang.String resourceName, boolean silent) Deletes a resource from the repository
void	deleteResource(java.lang.String projectName, java.lang.String resourceName, boolean silent, AdditionalInfo additionalInfo) Deletes a resource from the repository
void	deleteRobot(java.lang.String projectName, java.lang.String robotName, boolean silent) Deletes a robot from the repository.
void	deleteRobot(java.lang.String projectName, java.lang.String robotName, boolean silent, AdditionalInfo additionalInfo) Deletes a robot from the repository.
void	deleteSnippet(java.lang.String projectName, java.lang.String snippetName, boolean silent) Deletes a Snippet from the repository
void	deleteSnippet(java.lang.String projectName, java.lang.String snippetName, boolean silent, AdditionalInfo additionalInfo) Deletes a Snippet from the repository
void	deleteType(java.lang.String projectName, java.lang.String typeName, boolean silent) Deletes a type from the repository
void	deleteType(java.lang.String projectName, java.lang.String typeName, boolean silent, AdditionalInfo additionalInfo) Deletes a type from the repository
void	deployConnector(java.lang.String projectName, java.lang.String connectorName, byte[] connectorBytes, boolean failIfExists) Deploys a connector in a repository.
void	deployConnector(java.lang.String projectName, java.lang.String connectorName, byte[] connectorBytes, boolean failIfExists, AdditionalInfo additionalInfo) Deploys a connector in a repository.
void	deployResource(java.lang.String projectName, java.lang.String resourceName, byte[] resourceBytes, boolean failIfExists) Deploys a resource in a repository.
void	deployResource(java.lang.String projectName, java.lang.String resourceName, byte[] resourceBytes, boolean failIfExists, AdditionalInfo additionalInfo) Deploys a resource in a repository.
void	deployRobot(java.lang.String projectName, java.lang.String robotName, byte[] robotBytes, boolean failIfExists) Deploys a robot in a repository.
void	deployRobot(java.lang.String projectName, java.lang.String robotName, byte[] robotBytes, boolean failIfExists, AdditionalInfo additionalInfo) Deploys a robot in a repository.
void	deploySnippet(java.lang.String projectName, java.lang.String name, byte[] snippetBytes, boolean failIfExists) Deploys a snippet to a repository.
void	deploySnippet(java.lang.String projectName, java.lang.String name, byte[] snippetBytes, boolean failIfExists, AdditionalInfo additionalInfo) Deploys a snippet to a repository.
void	deployType(java.lang.String projectName, java.lang.String typeName, byte[] typeBytes, boolean failIfExists) Deploys a type to a repository.
void	deployType(java.lang.String projectName, java.lang.String typeName, byte[] typeBytes, boolean failIfExists, AdditionalInfo additionalInfo) Deploys a type to a repository.
protected void	doDeploy(java.lang.String projectName, java.lang.String fileName, byte[] bytes, boolean failIfExists, java.lang.String fileType, AdditionalInfo additionalInfo) Deploys a resource/robot or type in a repository.
byte[]	getBytes(RepositoryFile file) Get bytes for a given RepositoryFile.
java.util.Date	getCurrentDate() Gets the current date of Management Console with format: yyyy-MM-dd HH:mm:ss.SSS Example: 2014-10-09 12:33:14.608
RepositoryFolder	getFileInventory(java.lang.String projectName, java.lang.String folderPath, java.lang.String fileName, RepositoryFile.Type fileType) Gets the file and the referenced files from the management console.
RepositoryFolder	getFolderInventory(java.lang.String projectName, java.lang.String folderPath) Retrieves the folders and files of the sub folder in the specified project from the repository.
OAuthUserEntry[]	getOAuthUserEntriesInProject(java.lang.String projectName) Retrieves the OAuth User Entries in a given project.
RepositoryFolder	getProjectInventory(java.lang.String projectName) Retrieves the folders and files of the entire project from the repository.
Project[]	getProjects() Retrieves the projects available in the repository.
Project[]	getProjectsByUser(java.lang.String userName, java.lang.String role) Retrieves the projects available for the current user in the repository.
java.util.Collection<Robot>	getRobotsByTag(java.lang.String projectName, java.lang.String tags) A request for robots with a specified tag.
RobotSignature	getRobotSignature(java.lang.String projectName, java.lang.String robotName) Returns the robot signature for a given robot
Robot[]	getRobotsInProject(java.lang.String projectName) Retrieves the robots in a given project.
RepositoryFolder	getSlimProjectInventory(java.lang.String projectName) Retrieves the folders and files of the entire project from the repository, but does not resolve dependencies between objects.
void	moveFile(RepositoryFile sourceFile, java.lang.String destFolderPath) Move repository file to a new folder.
void	moveFile(RepositoryFile sourceFile, java.lang.String destFolderPath, AdditionalInfo additionalInfo) Move repository file to a new folder.
static org.w3c.dom.Document	newRequest() Private helper method that creates a new DOM Document.
void	renameRobot(RepositoryFile robotFile, java.lang.String newName) Rename a robot file.
void	renameRobot(RepositoryFile robotFile, java.lang.String newName, AdditionalInfo additionalInfo)
protected abstract org.w3c.dom.Document	sendXML(org.w3c.dom.Document requestDocument) Sends the XML document to the repository.
void	updateFile(RepositoryFile file, byte[] bytes) Update existing repository file with new bytes.
void	updateFile(RepositoryFile file, byte[] bytes, AdditionalInfo additionalInfo)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kapowtech.robosuite.api.java.repository.engine.RepositoryClient

createDocument, getAuthenticationProvider, getInfo, parseDocument, pingRepository

Constructor Detail

AbstractRepositoryClient

protected AbstractRepositoryClient()

Creates a new instance

Method Detail

getProjects

public Project[] getProjects()
                      throws RepositoryClientException

Retrieves the projects available in the repository.

Specified by:

getProjects in interface RepositoryClient

Returns:

The array of projects.

Throws:

RepositoryClientException - If an error occurs.

getProjectsByUser

public Project[] getProjectsByUser(java.lang.String userName,
                                   java.lang.String role)
                            throws RepositoryClientException

Retrieves the projects available for the current user in the repository.

Specified by:

getProjectsByUser in interface RepositoryClient

Parameters:

userName - name of the user

role - role of the user (kappletAdministrator or kappletUser)

Returns:

The array of projects.

Throws:

RepositoryClientException - If an error occurs.

getRobotsInProject

public Robot[] getRobotsInProject(java.lang.String projectName)
                           throws RepositoryClientException

Retrieves the robots in a given project.

Specified by:

getRobotsInProject in interface RepositoryClient

Parameters:

projectName - The name of the project.

Returns:

The array of executable robots.

Throws:

RepositoryClientException - If the project doesn't exist or if an error occurs.

getOAuthUserEntriesInProject

public OAuthUserEntry[] getOAuthUserEntriesInProject(java.lang.String projectName)
                                              throws RepositoryClientException

Retrieves the OAuth User Entries in a given project.

Specified by:

getOAuthUserEntriesInProject in interface RepositoryClient

Parameters:

projectName - The name of the project.

Returns:

The array of executable robots.

Throws:

RepositoryClientException - If the project doesn't exist or if an error occurs.

getCurrentDate

public java.util.Date getCurrentDate()
                              throws RepositoryClientException

Gets the current date of Management Console with format: yyyy-MM-dd HH:mm:ss.SSS Example: 2014-10-09 12:33:14.608

Specified by:

getCurrentDate in interface RepositoryClient

Returns:

Current date.

Throws:

RepositoryClientException - If any error occurs.

getBytes

public byte[] getBytes(RepositoryFile file)
                throws FileMismatchWarningException,
                       java.io.FileNotFoundException,
                       RepositoryClientException

Get bytes for a given RepositoryFile. If either of the fields lastModified, lastModifiedBy or checksum does not match between the RepositoryFile and the version stored in the repository, a RepositoryClientException will be thrown. This may occur if the file has been changed or deleted in the repository since the RepositoryFile was fetched.

Specified by:

getBytes in interface RepositoryClient

Parameters:

file - Repository file. Can be robot, type, snippet and resource.

Returns:

Array of bytes.

Throws:

FileMismatchWarningException - When the lastModified, lastModifiedBy or the checksum in the parameter does not match the file on the server. The file is still downloaded, and contained in the exception.

java.io.FileNotFoundException - If the file is no longer found in the repository.

RepositoryClientException - If any other error occurs.

getSlimProjectInventory

public RepositoryFolder getSlimProjectInventory(java.lang.String projectName)
                                         throws java.io.FileNotFoundException,
                                                RepositoryClientException

Retrieves the folders and files of the entire project from the repository, but does not resolve dependencies between objects.

Parameters:

projectName - The name of the project.

Returns:

repository folder The root repository folder.

Throws:

java.io.FileNotFoundException - If the project is no longer found in the repository.

RepositoryClientException - If any other error occurs.

getProjectInventory

public RepositoryFolder getProjectInventory(java.lang.String projectName)
                                     throws java.io.FileNotFoundException,
                                            RepositoryClientException

Retrieves the folders and files of the entire project from the repository.

Specified by:

getProjectInventory in interface RepositoryClient

Parameters:

projectName - The name of the project.

Returns:

repository folder The root repository folder.

Throws:

java.io.FileNotFoundException - If the project is no longer found in the repository.

RepositoryClientException - If any other error occurs.

getFolderInventory

public RepositoryFolder getFolderInventory(java.lang.String projectName,
                                           java.lang.String folderPath)
                                    throws java.io.FileNotFoundException,
                                           RepositoryClientException

Retrieves the folders and files of the sub folder in the specified project from the repository.

Specified by:

getFolderInventory in interface RepositoryClient

Parameters:

projectName - The name of the project

folderPath - The path to the top sub folder to get inventory from.

Returns:

RepositoryFolder A repository folder.

Throws:

java.io.FileNotFoundException - If the folder is no longer found in the repository.

RepositoryClientException - If any other error occurs.

getFileInventory

public RepositoryFolder getFileInventory(java.lang.String projectName,
                                         java.lang.String folderPath,
                                         java.lang.String fileName,
                                         RepositoryFile.Type fileType)
                                  throws java.io.FileNotFoundException,
                                         RepositoryClientException

Gets the file and the referenced files from the management console. Remark, the file inventory is wrapped in a RepositoryFolder, to get references.

Specified by:

getFileInventory in interface RepositoryClient

Parameters:

projectName - The name of the project.

folderPath - The path to the top sub folder to get inventory from.

fileName - The name of the file to get inventory of. Without extension.

fileType - The type of the file to get inventory of.

Returns:

RepositoryFolder A repository folder

Throws:

java.io.FileNotFoundException - If the file is no longer found in the repository.

RepositoryClientException - If any other error occurs.

getRobotSignature

public RobotSignature getRobotSignature(java.lang.String projectName,
                                        java.lang.String robotName)
                                 throws RepositoryClientException

Returns the robot signature for a given robot

Specified by:

getRobotSignature in interface RepositoryClient

Parameters:

projectName - The name of the project.

robotName - The name of the robot. If the name doesn't contain the forwards slash "/", robot will be detected from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the robot file will be detected from the specified location in the folder tree.

Returns:

RobotSignature the Robot Signature object

Throws:

RepositoryClientException - if the robot or project doesn't exist or an error occurs

updateFile

public void updateFile(RepositoryFile file,
                       byte[] bytes)
                throws java.io.FileNotFoundException,
                       RepositoryClientException

Update existing repository file with new bytes.

Specified by:

updateFile in interface RepositoryClient

Parameters:

file - The repository file.

bytes - The byte array for replacing the existing.

Throws:

java.io.FileNotFoundException - If the file is no longer found in the repository.

RepositoryClientException - If either of the fields lastModified, lastModifiedBy, path or checksum does not match between the RepositoryFile and the version stored in the repository, a RepositoryClientException will be thrown. This may occur if the file has been changed or deleted in the repository since the RepositoryFile was fetched.

updateFile

public void updateFile(RepositoryFile file,
                       byte[] bytes,
                       AdditionalInfo additionalInfo)
                throws java.io.FileNotFoundException,
                       RepositoryClientException

Specified by:

updateFile in interface RepositoryClient

Throws:

java.io.FileNotFoundException

RepositoryClientException

deployRobot

public void deployRobot(java.lang.String projectName,
                        java.lang.String robotName,
                        byte[] robotBytes,
                        boolean failIfExists)
                 throws FileAlreadyExistsException,
                        RepositoryClientException

Deploys a robot in a repository.

Specified by:

deployRobot in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

robotName - The name of the robot. If the name does not contain a forward slash "/" then the robot file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the robot file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

robotBytes - the robot file as bytes

failIfExists - true if an exception should be thrown if the robot already exists, or false to override any existing robot by that name

Throws:

FileAlreadyExistsException - If failIfExists was true and the robot already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deployRobot

public void deployRobot(java.lang.String projectName,
                        java.lang.String robotName,
                        byte[] robotBytes,
                        boolean failIfExists,
                        AdditionalInfo additionalInfo)
                 throws FileAlreadyExistsException,
                        RepositoryClientException

Deploys a robot in a repository.

Specified by:

deployRobot in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

robotName - The name of the robot. If the name does not contain a forward slash "/" then the robot file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the robot file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

robotBytes - the robot file as bytes

failIfExists - true if an exception should be thrown if the robot already exists, or false to override any existing robot by that name

additionalInfo - version control information

Throws:

FileAlreadyExistsException - If failIfExists was true and the robot already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deployType

public void deployType(java.lang.String projectName,
                       java.lang.String typeName,
                       byte[] typeBytes,
                       boolean failIfExists)
                throws FileAlreadyExistsException,
                       RepositoryClientException

Deploys a type to a repository.

Specified by:

deployType in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

typeName - The name of the type. If the name does not contain a forward slash "/" then the type file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the type file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

typeBytes - the type file as bytes

failIfExists - true if an exception should be thrown if the type already exists, or false to override any existing type by that name

Throws:

FileAlreadyExistsException - If failIfExists was true and the type already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deployType

public void deployType(java.lang.String projectName,
                       java.lang.String typeName,
                       byte[] typeBytes,
                       boolean failIfExists,
                       AdditionalInfo additionalInfo)
                throws FileAlreadyExistsException,
                       RepositoryClientException

Deploys a type to a repository.

Specified by:

deployType in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

typeName - The name of the type. If the name does not contain a forward slash "/" then the type file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the type file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

typeBytes - the type file as bytes

failIfExists - true if an exception should be thrown if the type already exists, or false to override any existing type by that name

additionalInfo - version control information

Throws:

FileAlreadyExistsException - If failIfExists was true and the type already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deploySnippet

public void deploySnippet(java.lang.String projectName,
                          java.lang.String name,
                          byte[] snippetBytes,
                          boolean failIfExists)
                   throws FileAlreadyExistsException,
                          RepositoryClientException

Deploys a snippet to a repository.

Specified by:

deploySnippet in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

name - The name of the snippet. If the name does not contain a forward slash "/" then the snippet file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the snippet file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

snippetBytes - the type file as bytes

failIfExists - true if an exception should be thrown if the type already exists, or false to override any existing type by that name.

Throws:

FileAlreadyExistsException - If failIfExists was true and the type already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deploySnippet

public void deploySnippet(java.lang.String projectName,
                          java.lang.String name,
                          byte[] snippetBytes,
                          boolean failIfExists,
                          AdditionalInfo additionalInfo)
                   throws FileAlreadyExistsException,
                          RepositoryClientException

Deploys a snippet to a repository.

Specified by:

deploySnippet in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

name - The name of the snippet. If the name does not contain a forward slash "/" then the snippet file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the snippet file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

snippetBytes - the type file as bytes

failIfExists - true if an exception should be thrown if the type already exists, or false to override any existing type by that name.

additionalInfo - version control information

Throws:

FileAlreadyExistsException - If failIfExists was true and the type already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deployResource

public void deployResource(java.lang.String projectName,
                           java.lang.String resourceName,
                           byte[] resourceBytes,
                           boolean failIfExists)
                    throws FileAlreadyExistsException,
                           RepositoryClientException

Deploys a resource in a repository.

Specified by:

deployResource in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

resourceName - The name of the resource. If the name does not contain a forward slash "/" then the resource file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the resource file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

resourceBytes - the resource file as bytes

failIfExists - true if an exception should be thrown if the resource already exists, or false to override any existing resource by that name.

Throws:

FileAlreadyExistsException - If failIfExists was true and the resource already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deployResource

public void deployResource(java.lang.String projectName,
                           java.lang.String resourceName,
                           byte[] resourceBytes,
                           boolean failIfExists,
                           AdditionalInfo additionalInfo)
                    throws FileAlreadyExistsException,
                           RepositoryClientException

Deploys a resource in a repository.

Specified by:

deployResource in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

resourceName - The name of the resource. If the name does not contain a forward slash "/" then the resource file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the resource file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

resourceBytes - the resource file as bytes

failIfExists - true if an exception should be thrown if the resource already exists, or false to override any existing resource by that name.

additionalInfo - version control information

Throws:

FileAlreadyExistsException - If failIfExists was true and the resource already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deployConnector

public void deployConnector(java.lang.String projectName,
                            java.lang.String connectorName,
                            byte[] connectorBytes,
                            boolean failIfExists)
                     throws FileAlreadyExistsException,
                            RepositoryClientException

Deploys a connector in a repository.

Specified by:

deployConnector in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

connectorName - The name of the connector. If the name does not contain a forward slash "/" then the connector file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the connector file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

connectorBytes - the connector file as bytes

failIfExists - true if an exception should be thrown if the connector already exists, or false to override any existing connector by that name.

Throws:

FileAlreadyExistsException - If failIfExists was true and the connector already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deployConnector

public void deployConnector(java.lang.String projectName,
                            java.lang.String connectorName,
                            byte[] connectorBytes,
                            boolean failIfExists,
                            AdditionalInfo additionalInfo)
                     throws FileAlreadyExistsException,
                            RepositoryClientException

Deploys a connector in a repository.

Specified by:

deployConnector in interface RepositoryClient

Parameters:

projectName - The name of the project to deploy in.

connectorName - The name of the connector. If the name does not contain a forward slash "/" then the connector file is placed in the root folder. If the name contains one or more forward slashes, then the name is treated as a path name and the connector file is placed in folder specified by the path. If the folders referred to in the path do not exist, they are created.

connectorBytes - the connector file as bytes

failIfExists - true if an exception should be thrown if the connector already exists, or false to override any existing connector by that name.

additionalInfo - version control information

Throws:

FileAlreadyExistsException - If failIfExists was true and the connector already exists this exception will be thrown.

RepositoryClientException - If the project doesn't exist or an error occurs.

deleteRobot

public void deleteRobot(java.lang.String projectName,
                        java.lang.String robotName,
                        boolean silent)
                 throws java.io.FileNotFoundException,
                        RepositoryClientException

Deletes a robot from the repository.

Specified by:

deleteRobot in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from.

robotName - The name of the robot to delete. If the name doesn't contain the forwards slash "/", robot will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the robot file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the robot didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteRobot

public void deleteRobot(java.lang.String projectName,
                        java.lang.String robotName,
                        boolean silent,
                        AdditionalInfo additionalInfo)
                 throws java.io.FileNotFoundException,
                        RepositoryClientException

Deletes a robot from the repository.

Specified by:

deleteRobot in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from.

robotName - The name of the robot to delete. If the name doesn't contain the forwards slash "/", robot will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the robot file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the robot didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteType

public void deleteType(java.lang.String projectName,
                       java.lang.String typeName,
                       boolean silent)
                throws java.io.FileNotFoundException,
                       RepositoryClientException

Deletes a type from the repository

Specified by:

deleteType in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from.

typeName - The name of the type to delete. If the name doesn't contain the forwards slash "/", type will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the type file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the type didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteType

public void deleteType(java.lang.String projectName,
                       java.lang.String typeName,
                       boolean silent,
                       AdditionalInfo additionalInfo)
                throws java.io.FileNotFoundException,
                       RepositoryClientException

Deletes a type from the repository

Specified by:

deleteType in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from.

typeName - The name of the type to delete. If the name doesn't contain the forwards slash "/", type will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the type file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the type didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteSnippet

public void deleteSnippet(java.lang.String projectName,
                          java.lang.String snippetName,
                          boolean silent)
                   throws java.io.FileNotFoundException,
                          RepositoryClientException

Deletes a Snippet from the repository

Specified by:

deleteSnippet in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from.

snippetName - The name of the snippet to delete. If the name doesn't contain the forwards slash "/", snippet will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the snippet file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the snippet didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteSnippet

public void deleteSnippet(java.lang.String projectName,
                          java.lang.String snippetName,
                          boolean silent,
                          AdditionalInfo additionalInfo)
                   throws java.io.FileNotFoundException,
                          RepositoryClientException

Deletes a Snippet from the repository

Specified by:

deleteSnippet in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from.

snippetName - The name of the snippet to delete. If the name doesn't contain the forwards slash "/", snippet will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the snippet file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the snippet didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteResource

public void deleteResource(java.lang.String projectName,
                           java.lang.String resourceName,
                           boolean silent)
                    throws java.io.FileNotFoundException,
                           RepositoryClientException

Deletes a resource from the repository

Specified by:

deleteResource in interface RepositoryClient

Parameters:

projectName - the project to delete the robot from

resourceName - The name of the resource to delete. If the name doesn't contain the forwards slash "/", resource will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the resource file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the resource didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteResource

public void deleteResource(java.lang.String projectName,
                           java.lang.String resourceName,
                           boolean silent,
                           AdditionalInfo additionalInfo)
                    throws java.io.FileNotFoundException,
                           RepositoryClientException

Deletes a resource from the repository

Specified by:

deleteResource in interface RepositoryClient

Parameters:

projectName - the project to delete the robot from

resourceName - The name of the resource to delete. If the name doesn't contain the forwards slash "/", resource will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the resource file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the resource didn't exist.

additionalInfo - The additional info to user while deleting the resource

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteConnector

public void deleteConnector(java.lang.String projectName,
                            java.lang.String connectorName,
                            boolean silent)
                     throws java.io.FileNotFoundException,
                            RepositoryClientException

Deletes a connector from the repository

Specified by:

deleteConnector in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from

connectorName - The name of the connector to delete. If the name doesn't contain the forwards slash "/", connector will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the connector file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the connector didn't exist.

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteConnector

public void deleteConnector(java.lang.String projectName,
                            java.lang.String connectorName,
                            boolean silent,
                            AdditionalInfo additionalInfo)
                     throws java.io.FileNotFoundException,
                            RepositoryClientException

Deletes a connector from the repository

Specified by:

deleteConnector in interface RepositoryClient

Parameters:

projectName - The project to delete the robot from

connectorName - The name of the connector to delete. If the name doesn't contain the forwards slash "/", connector will be deleted from the root folder. If the name contains one or more forward slashes, then it is treated as a path name and the connector file will be deleted from the specified location in the folder tree.

silent - If no exception should be raised if the connector didn't exist.

additionalInfo - The additional info to user while deleting the connector

Throws:

java.io.FileNotFoundException - If the file to delete was not found, and silent was false.

RepositoryClientException - If any other error occurs.

deleteFile

public void deleteFile(RepositoryFile file)
                throws java.io.FileNotFoundException,
                       RepositoryClientException

Delete a RepositoryFile

Specified by:

deleteFile in interface RepositoryClient

Parameters:

file - The repository file.

Throws:

java.io.FileNotFoundException - If the file is no longer found in the repository.

RepositoryClientException - If either of the fields lastModified, lastModifiedBy, path or checksum does not match between the RepositoryFile and the version stored in the repository, a RepositoryClientException will be thrown. This may occur if the file has been changed or deleted in the repository since the RepositoryFile was fetched.

deleteFile

public void deleteFile(RepositoryFile file,
                       AdditionalInfo additionalInfo)
                throws java.io.FileNotFoundException,
                       RepositoryClientException

Specified by:

deleteFile in interface RepositoryClient

Throws:

java.io.FileNotFoundException

RepositoryClientException

deleteFolder

public void deleteFolder(java.lang.String projectName,
                         java.lang.String folderPath)
                  throws java.io.FileNotFoundException,
                         RepositoryClientException

Delete a folder

Specified by:

deleteFolder in interface RepositoryClient

Parameters:

projectName - The name of the project.

folderPath - The path of the folder includes the folder name.

Throws:

java.io.FileNotFoundException - If the folder is no longer found in the repository.

RepositoryClientException - If the folder is not empty or other error occurs.

deleteFolder

public void deleteFolder(java.lang.String projectName,
                         java.lang.String folderPath,
                         AdditionalInfo additionalInfo)
                  throws java.io.FileNotFoundException,
                         RepositoryClientException

Delete a folder

Specified by:

deleteFolder in interface RepositoryClient

Parameters:

projectName - The name of the project.

folderPath - The path of the folder includes the folder name.

additionalInfo - information about the deletion

Throws:

java.io.FileNotFoundException - If the folder is no longer found in the repository.

RepositoryClientException - If the folder is not empty or other error occurs.

doDeploy

protected void doDeploy(java.lang.String projectName,
                        java.lang.String fileName,
                        byte[] bytes,
                        boolean failIfExists,
                        java.lang.String fileType,
                        AdditionalInfo additionalInfo)
                 throws FileAlreadyExistsException,
                        RepositoryClientException

Deploys a resource/robot or type in a repository.

Parameters:

projectName - the name of the project to deploy in

fileName - the name of the file

bytes - the resource file as bytes

failIfExists - true if an exception should be thrown if the resource already exists, or false to override any existing resource by that name

fileType - the deployment operation

additionalInfo - Additional information for changes send to the repository

Throws:

FileAlreadyExistsException - if failIfExists was true and the resource already exists this exception will be thrown

RepositoryClientException - if the project doesn't exist or an error occurs

sendXML

protected abstract org.w3c.dom.Document sendXML(org.w3c.dom.Document requestDocument)
                                         throws RepositoryClientException

Sends the XML document to the repository.

Parameters:

requestDocument - the request document.

Returns:

the response document.

Throws:

RepositoryClientException - if an error occurs.

newRequest

public static org.w3c.dom.Document newRequest()
                                       throws com.kapowtech.robosuite.api.java.util.XMLParserException

Private helper method that creates a new DOM Document.

Returns:

the document.

Throws:

com.kapowtech.robosuite.api.java.util.XMLParserException - if the document cannot be created.

moveFile

public void moveFile(RepositoryFile sourceFile,
                     java.lang.String destFolderPath)
              throws FileAlreadyExistsException,
                     java.io.FileNotFoundException,
                     RepositoryClientException

Move repository file to a new folder.

Specified by:

moveFile in interface RepositoryClient

Parameters:

sourceFile - The repository file.

destFolderPath - The destination folder path separated by forward slash "/". An empty string "" indicates root folder.

Throws:

FileAlreadyExistsException - If the destination folder already has same type of repository file with same name as the sourceFile.

java.io.FileNotFoundException - If the file is no longer found in the repository.

RepositoryClientException - If either of the fields lastModified, lastModifiedBy, path or checksum does not match between the source file and the version stored in the repository, a RepositoryClientException will be thrown. This may occur if the file has been changed or deleted in the repository since the RepositoryFile was fetched.

moveFile

public void moveFile(RepositoryFile sourceFile,
                     java.lang.String destFolderPath,
                     AdditionalInfo additionalInfo)
              throws FileAlreadyExistsException,
                     java.io.FileNotFoundException,
                     RepositoryClientException

Move repository file to a new folder.

Parameters:

sourceFile - The repository file.

destFolderPath - The destination folder path separated by forward slash "/". An empty string "" indicates root folder.

additionalInfo - contains additional information for the Management Console.

Throws:

FileAlreadyExistsException - If the destination folder already has same type of repository file with same name as the sourceFile.

java.io.FileNotFoundException - If the file is no longer found in the repository.

RepositoryClientException - If either of the fields lastModified, lastModifiedBy, path or checksum does not match between the source file and the version stored in the repository, a RepositoryClientException will be thrown. This may occur if the file has been changed or deleted in the repository since the RepositoryFile was fetched.

renameRobot

public void renameRobot(RepositoryFile robotFile,
                        java.lang.String newName)
                 throws FileAlreadyExistsException,
                        java.io.FileNotFoundException,
                        RepositoryClientException

Rename a robot file.

Specified by:

renameRobot in interface RepositoryClient

Parameters:

robotFile - The robot repository file.

newName - The new name.

Throws:

FileAlreadyExistsException - If there is already a robot file with same name under the same folder.

java.io.FileNotFoundException - If the file is no longer found in the repository.

RepositoryClientException - If either of the fields lastModified, lastModifiedBy, path or checksum does not match between the robot file and the version stored in the repository, a RepositoryClientException will be thrown. This may occur if the file has been changed or deleted in the repository since the RepositoryFile was fetched.

renameRobot

public void renameRobot(RepositoryFile robotFile,
                        java.lang.String newName,
                        AdditionalInfo additionalInfo)
                 throws FileAlreadyExistsException,
                        java.io.FileNotFoundException,
                        RepositoryClientException

Throws:

FileAlreadyExistsException

java.io.FileNotFoundException

RepositoryClientException

getRobotsByTag

public java.util.Collection<Robot> getRobotsByTag(java.lang.String projectName,
                                                  java.lang.String tags)
                                           throws RepositoryClientException

Description copied from interface: RepositoryClient

A request for robots with a specified tag. If no tag is specified in request then the method works like RepositoryClient.getRobotsInProject(String).

Specified by:

getRobotsByTag in interface RepositoryClient

Parameters:

projectName - project name

tags - one tag name or a part of it

Returns:

collection of robots form the project with at least one tag containing the specified tag

Throws:

RepositoryClientException - if something goes wrong with the client