com.microsoft.azure.sdk.iot.provisioning.security

Class SecurityProviderX509

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.security.SecurityProvider

com.microsoft.azure.sdk.iot.provisioning.security.SecurityProviderX509

public abstract class SecurityProviderX509
extends SecurityProvider

Constructor Summary

Constructors

Constructor and Description
SecurityProviderX509()

Method Summary

Modifier and Type	Method and Description
abstract X509Certificate	getClientCertificate()
abstract String	getClientCertificateCommonName()
abstract Key	getClientPrivateKey()
abstract Collection<X509Certificate>	getIntermediateCertificatesChain()
String	getRegistrationId() Unique id required for registration
SSLContext	getSSLContext() Retrieves the SSL context loaded with trusted certs.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityProviderX509

public SecurityProviderX509()

Method Detail

getClientCertificateCommonName

public abstract String getClientCertificateCommonName()

getClientCertificate

public abstract X509Certificate getClientCertificate()

getClientPrivateKey

public abstract Key getClientPrivateKey()

getIntermediateCertificatesChain

public abstract Collection<X509Certificate> getIntermediateCertificatesChain()

getRegistrationId

public String getRegistrationId()
                         throws SecurityProviderException

Description copied from class: SecurityProvider

Unique id required for registration

Specified by:

getRegistrationId in class SecurityProvider

Returns:

Returns the registration Id used needed for the service

Throws:

SecurityProviderException - If registration id with the underlying implementation could not be retrieved

getSSLContext

public SSLContext getSSLContext()
                         throws SecurityProviderException

Description copied from class: SecurityProvider

Retrieves the SSL context loaded with trusted certs. In case of X509 SSL context shall be loaded with complete chain all the way till the leaf along with its private key.

Specified by:

getSSLContext in class SecurityProvider

Returns:

The SSLContext relevant to the flow

Throws:

SecurityProviderException - If ssl context could not be generated for any of the reason