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

Class RepositoryClientImpl

java.lang.Object

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

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

All Implemented Interfaces:

RepositoryClient

public class RepositoryClientImpl
extends AbstractRepositoryClient

The actual client implementation. This class is loaded dynamically to allow us to check if the required jar files are present, to avoid NoClassDef errors. This class MUST not be used in a multithreaded context without synchronization!

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationProvider	_authenticationProvider
protected java.lang.String	_designStudioId
protected org.apache.http.impl.client.DefaultHttpClient	_httpClient
protected org.apache.http.params.HttpParams	_httpParams
static int	_TIMEOUT_MILLIS
protected java.lang.String	_url
static java.lang.String	USER_AGENT

Constructor Summary

Constructors

Constructor and Description
RepositoryClientImpl(AuthenticationProvider authenticationProvider)
RepositoryClientImpl(java.lang.String url, java.lang.String userName, java.lang.String password, ProxyServerConfiguration proxyServerConfiguration) Deprecated. use an {AuthenticationProvider} instead of username / password.

Method Summary

Modifier and Type	Method and Description
protected void	configureHttpClient(ProxyServerConfiguration proxyConf)
protected org.apache.http.HttpResponse	doSend(org.apache.http.client.methods.HttpPost postMethod, java.lang.String expectedContentType) Posts a request to a server, and gets the response stream.
AuthenticationProvider	getAuthenticationProvider()
protected java.util.List<NamedAuthSchemeProvider>	getAuthSchemes()
protected org.apache.http.Header	getHeader(org.apache.http.HttpMessage httpRequest, java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>	getInfo() Get information about the Management Console and the Repository API.
static int	getTimoutPropertyOrDefault()
java.lang.String	pingRepository() Ping the repository server
protected org.apache.http.protocol.HttpContext	prepareContext()
protected org.w3c.dom.Document	sendXML(org.w3c.dom.Document requestDocument) Sends the XML document to the repository.
protected void	validateResponse(org.apache.http.HttpResponse response, java.lang.String expectedResponse)

Methods inherited from class com.kapowtech.robosuite.api.java.repository.engine.AbstractRepositoryClient

addRoboServer, addRoboServer, computeChecksum, deleteConnector, deleteConnector, deleteFile, deleteFile, deleteFolder, deleteFolder, deleteResource, deleteResource, deleteRoboServer, deleteRobot, deleteRobot, deleteSnippet, deleteSnippet, deleteType, deleteType, deployConnector, deployConnector, deployLibrary, deployLibrary, deployResource, deployResource, deployRobot, deployRobot, deploySnippet, deploySnippet, deployType, deployType, doDeploy, getBytes, getCurrentDate, getFileInventory, getFolderInventory, getOAuthUserEntriesInProject, getProjectInventory, getProjects, getProjectsByUser, getRoboServerClusters, getRoboServerClusters, getRobotsByTag, getRobotSignature, getRobotsInProject, getSlimProjectInventory, moveFile, moveFile, newRequest, renameRobot, renameRobot, updateFile, updateFile

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, parseDocument

Field Detail

_TIMEOUT_MILLIS

public static final int _TIMEOUT_MILLIS

USER_AGENT

public static final java.lang.String USER_AGENT

See Also:

Constant Field Values

_httpParams

protected org.apache.http.params.HttpParams _httpParams

_url

protected java.lang.String _url

_authenticationProvider

protected AuthenticationProvider _authenticationProvider

_httpClient

protected org.apache.http.impl.client.DefaultHttpClient _httpClient

_designStudioId

protected java.lang.String _designStudioId

Constructor Detail

RepositoryClientImpl

public RepositoryClientImpl(java.lang.String url,
                            java.lang.String userName,
                            java.lang.String password,
                            ProxyServerConfiguration proxyServerConfiguration)
                     throws RepositoryClientException

Deprecated. use an {AuthenticationProvider} instead of username / password.

Parameters:

url - the repository's base url, e.g. https://example.com:8080/ManagementConsole/

userName - the username to use

password - the password to use

proxyServerConfiguration - proxyServer configuration or null

Throws:

RepositoryClientException - If we can't configure the HttpClient

RepositoryClientImpl

public RepositoryClientImpl(AuthenticationProvider authenticationProvider)
                     throws RepositoryClientException

Parameters:

authenticationProvider - The authentication method and credentials to use.

Throws:

RepositoryClientException - If we can't configure the HttpClient.

Method Detail

getTimoutPropertyOrDefault

public static int getTimoutPropertyOrDefault()

configureHttpClient

protected void configureHttpClient(ProxyServerConfiguration proxyConf)
                            throws RepositoryClientException

Throws:

RepositoryClientException

getAuthenticationProvider

public AuthenticationProvider getAuthenticationProvider()

Returns:

the authentication provider used to instantiate the connection to the Repository.

prepareContext

protected org.apache.http.protocol.HttpContext prepareContext()

getAuthSchemes

protected java.util.List<NamedAuthSchemeProvider> getAuthSchemes()

pingRepository

public java.lang.String pingRepository()
                                throws RepositoryClientException

Description copied from interface: RepositoryClient

Ping the repository server

Returns:

null if repository is ok, or an error string if something is wrong.

Throws:

RepositoryClientException - If a communication error occurs.

getInfo

public java.util.Map<java.lang.String,java.lang.String> getInfo()
                                                         throws RepositoryClientException

Description copied from interface: RepositoryClient

Get information about the Management Console and the Repository API.

Returns:

a mapping of

"application"

to the version of the Management Console containing major, minor and dot version, e.g., "9.5.0"

"repository"

to the ID of the latest DTD used by the Repository API, e.g., "-//Kapow Technologies//DTD Repository 1.5//EN"

"rql"

to the ID of the latest DTD used by the Robot Query Language API, e.g., "-//Kapow Technologies//DTD RoboSuite Robot Query Language 1.13//EN"

Throws:

RepositoryClientException - If any error occurs

sendXML

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

Sends the XML document to the repository.

Specified by:

sendXML in class AbstractRepositoryClient

Parameters:

requestDocument - the request document.

Returns:

the response document.

Throws:

RepositoryClientException - if an error occurs.

validateResponse

protected void validateResponse(org.apache.http.HttpResponse response,
                                java.lang.String expectedResponse)
                         throws RepositoryConnectionException

Throws:

RepositoryConnectionException

doSend

protected org.apache.http.HttpResponse doSend(org.apache.http.client.methods.HttpPost postMethod,
                                              java.lang.String expectedContentType)
                                       throws RepositoryConnectionException

Posts a request to a server, and gets the response stream.

Parameters:

postMethod - the postMethod, including headers, and body

expectedContentType - The content-type the client expects the server to return, if the content-type is different a RepositoryClientException is thrown

Returns:

the inputStream to the server response

Throws:

RepositoryConnectionException - if we can't connect to the server

getHeader

protected org.apache.http.Header getHeader(org.apache.http.HttpMessage httpRequest,
                                           java.lang.String name)