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

Class SecurityProvider

java.lang.Object

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

Direct Known Subclasses:

SecurityProviderSymmetricKey, SecurityProviderTpm, SecurityProviderX509

public abstract class SecurityProvider
extends Object

Constructor Summary

Constructors

Constructor and Description
SecurityProvider()

Method Summary

Modifier and Type	Method and Description
abstract 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

SecurityProvider

public SecurityProvider()

Method Detail

getRegistrationId

public abstract String getRegistrationId()
                                  throws SecurityProviderException

Unique id required for registration

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

Retrieves the SSL context loaded with trusted certs. This default implementation loads the trusted certificates from your device's trusted root certification authorities certificate store. Implementations of SecurityProviderX509 must override this function so that it returns an SSLContext instance with the required private key and public certificates loaded into it as well as the default trusted certificates saved in your device's trusted root certification authorities certificate store.

Returns:

The SSLContext instance.

Throws:

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