com.cryptshare.api

Class CryptshareConnection

java.lang.Object

com.cryptshare.api.CryptshareConnection

public class CryptshareConnection
extends java.lang.Object

Contains basic connection information and request data that is used to perform operations on the Cryptshare Server. It is meant to be (re)used for the creation of Client instances.

Constructor Summary

Constructors

Constructor and Description
CryptshareConnection(WebServiceUri serverUrl) Constructs a CryptshareConnection that connects to Cryptshare Server using the API as client product.
CryptshareConnection(WebServiceUri serviceUri, java.lang.String productId, java.lang.String productKey, java.lang.String clientVersion, int requiredLanguagePackMajorVersion) Constructs a CryptshareConnection that connects to Cryptshare Server using custom client product properties.
CryptshareConnection(WebServiceUri serviceUri, java.lang.String productId, java.lang.String productKey, java.lang.String clientVersion, int requiredLanguagePackMajorVersion, java.net.URI proxyUrl) Constructs a CryptshareConnection that connects to Cryptshare Server using custom client product properties, and a specified proxy server.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientPlatform() Returns the client platform description that is sent to the server.
java.lang.String	getClientVersion() Returns the client version information string that is sent to the server.
java.lang.String	getProductId() Returns the product ID that identifies the client product.
int	getRequiredLanguagePackMajorVersion() Returns the major version of the language packs that is required by current version of the requesting product.
WebServiceUri	getWebServiceUri() Returns the WebServiceUri that is used for the web service requests.
void	setClientPlatform(java.lang.String clientPlatform) Sets the client platform description that is sent to the server.
void	setClientVersion(java.lang.String clientVersion) Sets the client version information string that is sent to the server.
void	setProductId(java.lang.String productId) Sets the product ID that identifies the client product.
void	setProductKey(java.lang.String productKey) Sets the product key that identifies the client product.
void	setRequiredLanguagePackMajorVersion(int requiredLanguagePackMajorVersion) Sets the major version of the language packs that is required by current version of the requesting product.

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptshareConnection

public CryptshareConnection(WebServiceUri serverUrl)

Constructs a CryptshareConnection that connects to Cryptshare Server using the API as client product. No proxy is used.

Parameters:

serverUrl - The WebServiceUri that specifies the Cryptshare Server URL.

CryptshareConnection

public CryptshareConnection(WebServiceUri serviceUri,
                            java.lang.String productId,
                            java.lang.String productKey,
                            java.lang.String clientVersion,
                            int requiredLanguagePackMajorVersion)

Constructs a CryptshareConnection that connects to Cryptshare Server using custom client product properties. No proxy is used.

Parameters:

serviceUri - The WebServiceUri that specifies the Cryptshare Server URL.

productId - The ID of the Cryptshare product.

productKey - The key of the Cryptshare product.

clientVersion - The client version information string that is sent to the server.

requiredLanguagePackMajorVersion - The major language pack version that is required by the product.

CryptshareConnection

public CryptshareConnection(WebServiceUri serviceUri,
                            java.lang.String productId,
                            java.lang.String productKey,
                            java.lang.String clientVersion,
                            int requiredLanguagePackMajorVersion,
                            java.net.URI proxyUrl)

Constructs a CryptshareConnection that connects to Cryptshare Server using custom client product properties, and a specified proxy server.

Parameters:

serviceUri - The WebServiceUri that specifies the Cryptshare Server URL.

productId - The ID of the Cryptshare product.

productKey - The key of the Cryptshare product.

clientVersion - The client version information string that is sent to the server.

requiredLanguagePackMajorVersion - The major language pack version that is required by the product.

proxyUrl - the URI of the proxy server to use. If URI is null, the system proxy, if available, will be used.

Method Detail

getProductId

public java.lang.String getProductId()

Returns the product ID that identifies the client product.

Returns:

The product ID.

setProductId

public void setProductId(java.lang.String productId)

Sets the product ID that identifies the client product.

Parameters:

productId - The product ID.

setProductKey

public void setProductKey(java.lang.String productKey)

Sets the product key that identifies the client product.

Parameters:

productKey - The product key.

getClientVersion

public java.lang.String getClientVersion()

Returns the client version information string that is sent to the server.

Returns:

The client version.

setClientVersion

public void setClientVersion(java.lang.String clientVersion)

Sets the client version information string that is sent to the server.

Parameters:

clientVersion - The client version.

getClientPlatform

public java.lang.String getClientPlatform()

Returns the client platform description that is sent to the server.

Returns:

The client platform description.

setClientPlatform

public void setClientPlatform(java.lang.String clientPlatform)

Sets the client platform description that is sent to the server.

Parameters:

clientPlatform - The client platform description.

getRequiredLanguagePackMajorVersion

public int getRequiredLanguagePackMajorVersion()

Returns the major version of the language packs that is required by current version of the requesting product.

Returns:

The required language pack major version.

setRequiredLanguagePackMajorVersion

public void setRequiredLanguagePackMajorVersion(int requiredLanguagePackMajorVersion)

Sets the major version of the language packs that is required by current version of the requesting product.

Parameters:

requiredLanguagePackMajorVersion - The required language pack major version.

getWebServiceUri

public WebServiceUri getWebServiceUri()

Returns the WebServiceUri that is used for the web service requests.

Returns:

the web service URI