EnrollmentGroup Class

public EnrollmentGroup(String json)

CONSTRUCTOR

This constructor creates an instance of the enrollment group filling the class with the information provided in the JSON.

The following JSON is a sample of the EnrollmentGroup response, received from the provisioning service.

{
     "enrollmentGroupId":"validEnrollmentGroupId",
     "attestation":{
         "type":"x509",
         "signingCertificates":{
             "primary":{
                 "certificate":"[valid certificate]",
                 "info": {
                     "subjectName": "CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US",
                     "sha1Thumbprint": "0000000000000000000000000000000000",
                     "sha256Thumbprint": "validEnrollmentGroupId",
                     "issuerName": "CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US",
                     "notBeforeUtc": "2017-11-14T12:34:18Z",
                     "notAfterUtc": "2017-11-20T12:34:18Z",
                     "serialNumber": "000000000000000000",
                     "version": 3
                 }
             }
         }
     },
     "iotHubHostName":"ContosoIoTHub.azure-devices.net",
     "provisioningStatus":"enabled"
     "createdDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
     "lastUpdatedDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
     "etag": "\"00000000-0000-0000-0000-00000000000\""
 }

Parameters:

public EnrollmentGroup(String enrollmentGroupId, Attestation attestation)

CONSTRUCTOR

This constructor creates an instance of the enrollment group with the minimum set of information required by the provisioning service.

When serialized, an EnrollmentGroup will look like the following example:

{
     "enrollmentGroupId":"validEnrollmentGroupId",
     "attestation":{
         "type":"x509",
         "signingCertificates":{
             "primary":{
                 "certificate":"[valid certificate]"
             }
         }
     }
 }

Parameters:

public AllocationPolicy getAllocationPolicy()

Getter for the allocation policy.

Returns:

public Attestation getAttestation()

Getter for the attestation mechanism.

Returns:

Throws:

public DeviceCapabilities getCapabilities()

public Date getCreatedDateTimeUtc()

Getter for the createdDateTimeUtcDate.

Returns:

public CustomAllocationDefinition getCustomAllocationDefinition()

Getter for the custom allocation definition policy.

Returns:

public String getEnrollmentGroupId()

Getter for the enrollmentGroupId.

Returns:

public String getEtag()

Getter for the etag.

Returns:

public TwinState getInitialTwin()

Getter for the initialTwin.

Returns:

public String getIotHubHostName()

Getter for the iotHubHostName.

Returns:

public Collection getIotHubs()

Getter for the list of IoTHub names that the device can be allocated to..

Returns:

public Date getLastUpdatedDateTimeUtc()

Getter for the lastUpdatedDateTimeUtcDate.

Returns:

public ProvisioningStatus getProvisioningStatus()

Getter for the provisioningStatus.

Returns:

public ReprovisionPolicy getReprovisionPolicy()

Getter for the reprovision policy.

Returns:

public void setAllocationPolicy(AllocationPolicy allocationPolicy)

Setter for the allocation policy.

Parameters:

public void setAttestation(Attestation attestation)

Setter for the attestation.

Attestation mechanism is mandatory parameter that provides the mechanism type and the necessary certificates.

EnrollmentGroup only accept X509Attestation with the RootCertificates, or SymmetricKeyAttestation with Primary and Secondary Keys. You can create an X509Attestation by providing the .pem content to createFromRootCertificates(String primary, String secondary). You can create a SymmetricKeyAttestation by providing the Primary and Secondary Keys in Base64 format.

Parameters:

protected final void setAttestation(AttestationMechanism attestationMechanism)

Setter for the attestation.

Attestation mechanism is mandatory parameter that provides the mechanism type and the necessary keys/certificates

Parameters:

public final void setCapabilities(DeviceCapabilities capabilities)

Parameters:

protected final void setCreatedDateTimeUtc(String createdDateTimeUtc)

Setter for the createdDateTimeUtc.

This Date and Time is provided by the provisioning service. If the enrollmentGroup is not created yet, this string can represent an invalid Date. In this case, it will be ignored. Example of the expected format: "2016-06-01T21:22:43.7996883Z"

Parameters:

public void setCustomAllocationDefinition(CustomAllocationDefinition customAllocationDefinition)

Setter for the custom allocation definition policy.

Parameters:

protected final void setEnrollmentGroupId(String enrollmentGroupId)

Setter for the enrollmentGroupId.

A valid enrollment group Id shall follow this criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

Parameters:

public void setEtag(String etag)

Deprecated

Setter for the etag.

Parameters:

public final void setEtagFinal(String etag)

Setter for the etag.

Parameters:

public void setInitialTwin(TwinState initialTwin)

Setter for the initialTwin.

It provides a Twin precondition for the provisioned device.

Parameters:

public final void setInitialTwinFinal(TwinState initialTwin)

Setter for the initialTwin.

It provides a Twin precondition for the provisioned device.

Parameters:

public void setIotHubHostName(String iotHubHostName)

Setter for the iotHubHostName.

A valid iothub host name shall follow this criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. A valid host name shall have, at least 2 parts separated by '.'.

Parameters:

public final void setIotHubHostNameFinal(String iotHubHostName)

Setter for the iotHubHostName.

A valid iothub host name shall follow this criteria. A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. A valid host name shall have, at least 2 parts separated by '.'.

Parameters:

public void setIotHubs(Collection iotHubs)

Setter for the list of IotHubs available for allocation.

Parameters:

protected final void setLastUpdatedDateTimeUtc(String lastUpdatedDateTimeUtc)

Setter for the lastUpdatedDateTimeUtc.

This Date and Time is provided by the provisioning service. If the enrollmentGroup is not created yet, this string can represent an invalid Date. In this case, it will be ignored. Example of the expected format: "2016-06-01T21:22:43.7996883Z"

Parameters:

public void setProvisioningStatus(ProvisioningStatus provisioningStatus)

Deprecated

Setter for the provisioningStatus.

It provides a Status precondition for the provisioned device.

Parameters:

public final void setProvisioningStatusFinal(ProvisioningStatus provisioningStatus)

Setter for the provisioningStatus.

It provides a Status precondition for the provisioned device.

Parameters:

public void setReprovisionPolicy(ReprovisionPolicy reprovisionPolicy)

Setter for the reprovision policy.

Parameters:

public JsonElement toJsonElement()

Serializer

Creates a JsonElement, which the content represents the information in this class and its subclasses in a JSON format. This is useful if the caller will integrate this JSON with jsons from other classes to generate a consolidated JSON.

Overrides:

Returns: