com.microsoft.azure.sdk.iot.service.auth

Class AuthenticationMechanism

java.lang.Object

com.microsoft.azure.sdk.iot.service.auth.AuthenticationMechanism

public class AuthenticationMechanism
extends Object

Authentication mechanism, used to store the device symmetric key.

Constructor Summary

Constructors

Constructor and Description
AuthenticationMechanism(AuthenticationType authenticationType) Constructor that is used for certificate authority authentication.
AuthenticationMechanism(String primaryThumbprint, String secondaryThumbprint) Constructor that saves a thumbprint used for self signed authentication
AuthenticationMechanism(SymmetricKey symmetricKey) Constructor that saves a symmetric key used for SAS authentication

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
AuthenticationType	getAuthenticationType() Getter for authentication type.
String	getPrimaryThumbprint() Returns the primary thumbprint
String	getSecondaryThumbprint() Returns the secondary thumbprint
SymmetricKey	getSymmetricKey() Getter for symmetric key.
void	setAuthenticationType(AuthenticationType type) Setter for the authentication type of this object
void	setPrimaryThumbprint(String primaryThumbprint) Setter for the primary thumbprint
void	setSecondaryThumbprint(String secondaryThumbprint) Setter for the secondary thumbprint
void	setSymmetricKey(SymmetricKey symmetricKey) Setter for symmetric key.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationMechanism

public AuthenticationMechanism(SymmetricKey symmetricKey)
                        throws IllegalArgumentException

Constructor that saves a symmetric key used for SAS authentication

Parameters:

symmetricKey - the key to use for authentication

Throws:

IllegalArgumentException - if the provided symmetricKey is null

AuthenticationMechanism

public AuthenticationMechanism(String primaryThumbprint,
                               String secondaryThumbprint)

Constructor that saves a thumbprint used for self signed authentication

Parameters:

primaryThumbprint - the primary thumbprint to use for authentication

secondaryThumbprint - the secondary thumbprint to use for authentication

AuthenticationMechanism

public AuthenticationMechanism(AuthenticationType authenticationType)

Constructor that is used for certificate authority authentication. Necessary keys will be generated automatically, and can be overwritten later as well.

Parameters:

authenticationType - the type of authentication for this to use.

Method Detail

getSymmetricKey

public SymmetricKey getSymmetricKey()

Getter for symmetric key.

Returns:

The symmetric key.

getPrimaryThumbprint

public String getPrimaryThumbprint()

Returns the primary thumbprint

Returns:

the primary thumbprint. It may be null

getSecondaryThumbprint

public String getSecondaryThumbprint()

Returns the secondary thumbprint

Returns:

the secondary thumbprint. It may be null

setSymmetricKey

public void setSymmetricKey(SymmetricKey symmetricKey)
                     throws IllegalArgumentException

Setter for symmetric key.

Parameters:

symmetricKey - the symmetric key to set

Throws:

IllegalArgumentException - if the provided symmetricKey is null

setPrimaryThumbprint

public void setPrimaryThumbprint(String primaryThumbprint)

Setter for the primary thumbprint

Parameters:

primaryThumbprint - the value to set

setSecondaryThumbprint

public void setSecondaryThumbprint(String secondaryThumbprint)

Setter for the secondary thumbprint

Parameters:

secondaryThumbprint - the value to set

getAuthenticationType

public AuthenticationType getAuthenticationType()

Getter for authentication type.

Returns:

The authentication type.

setAuthenticationType

public void setAuthenticationType(AuthenticationType type)
                           throws IllegalArgumentException

Setter for the authentication type of this object

Parameters:

type - the type of authentication to set

Throws:

IllegalArgumentException - if the provided type is null

equals

public boolean equals(Object other)

Overrides:

equals in class Object