com.microsoft.azure.sdk.iot.device.hsm

Class HttpsHsmClient

java.lang.Object

com.microsoft.azure.sdk.iot.device.hsm.HttpsHsmClient

public class HttpsHsmClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
HttpsHsmClient(java.lang.String baseUrl, UnixDomainSocketChannel unixDomainSocketChannel) Client object for sending sign requests to an HSM unit

Method Summary

Modifier and Type	Method and Description
TrustBundleResponse	getTrustBundle(java.lang.String apiVersion) Retrieve a trust bundle from an hsm
SignResponse	sign(java.lang.String apiVersion, java.lang.String moduleName, SignRequest signRequest, java.lang.String generationId) Send a sign request to the HSM using the provided parameters and return the HSM's response

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpsHsmClient

public HttpsHsmClient(java.lang.String baseUrl,
                      UnixDomainSocketChannel unixDomainSocketChannel)
               throws java.net.URISyntaxException

Client object for sending sign requests to an HSM unit

Parameters:

baseUrl - The base url of the HSM

unixDomainSocketChannel - the implementation of the UnixDomainSocketChannel interface that will be used if any unix domain socket communication is required. May be null if no unix domain socket communication is required.

Throws:

java.net.URISyntaxException - if the provided base url cannot be converted to a URI

Method Detail

sign

public SignResponse sign(java.lang.String apiVersion,
                         java.lang.String moduleName,
                         SignRequest signRequest,
                         java.lang.String generationId)
                  throws TransportException,
                         java.io.UnsupportedEncodingException

Send a sign request to the HSM using the provided parameters and return the HSM's response

Parameters:

apiVersion - the api version to use

moduleName - The name of the module for which the sign request is requesting access to

signRequest - the request to send

generationId - the generation id

Returns:

The response from the HSM

Throws:

TransportException - If there was a problem communicating with the HSM

java.io.UnsupportedEncodingException

getTrustBundle

public TrustBundleResponse getTrustBundle(java.lang.String apiVersion)
                                   throws TransportException

Retrieve a trust bundle from an hsm

Parameters:

apiVersion - the api version to use

Returns:

the trust bundle response from the hsm, contains the certificates to be trusted

Throws:

TransportException - if the HSM cannot be reached