Package com.aquima.interactions.ds.studio.r17

Class AquimaStudioClient

java.lang.Object

com.aquima.interactions.ds.studio.r17.AquimaStudioClient

public class AquimaStudioClient
extends Object

Class to connect to studio's exposed management webservice to retrieve application data. This client implementation can be used to connect to Studio versions 17+

Since:

17.1

Constructor Summary

Constructors

Constructor	Description
AquimaStudioClient(ISoapConnection soapConnection)	Construct an instance of the Aquima studio client .

Method Summary

Modifier and Type	Method	Description
String[]	getBrancheNames(String repositoryName)
String	getCurrentIdentity()	Get the current id of the user that connects to the management service.
String	getLicenseKey()	Get the license key from studio.
IResource	getProjectExport(String repository, String branch, String name)
String[]	getProjectNames(String repositoryName, String branchName)
String[]	getRepositoryNames()

Methods inherited from class java.lang.Object

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

Constructor Details

AquimaStudioClient

public AquimaStudioClient(ISoapConnection soapConnection)

Construct an instance of the Aquima studio client .

Parameters:

soapConnection - Connection class to connect to Studio's manangement service.

Method Details

getProjectExport

public IResource getProjectExport(String repository,
 String branch,
 String name)
                           throws IOException

Throws:

IOException

getCurrentIdentity

public String getCurrentIdentity()
                          throws IOException

Get the current id of the user that connects to the management service.

Returns:

String containing the current user id.

Throws:

XmlParseException - Is thrown when the webservice response could not be parsed.

IOException - Is thrown when an error occurs connecting to the webservice.

AuthenticationFailureException - When authentication failed for the current user.

getLicenseKey

public String getLicenseKey()
                     throws IOException

Get the license key from studio.

Returns:

String containing license key

Throws:

XmlParseException - Is thrown when the webservice response could not be parsed.

IOException - Is thrown when an error occurs connecting to the webservice.

AuthenticationFailureException - When authentication failed for the current user.

getRepositoryNames

public String[] getRepositoryNames()

getBrancheNames

public String[] getBrancheNames(String repositoryName)

getProjectNames

public String[] getProjectNames(String repositoryName,
 String branchName)