-
Notifications
You must be signed in to change notification settings - Fork 255
/
com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.yml
61 lines (61 loc) · 7.26 KB
/
com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo"
name: "X509CertificateWithInfo"
nameWithType: "X509CertificateWithInfo"
summary: "Representation of a single Device Provisioning Service X509 Certificate with its info."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **X509CertificateWithInfo**"
constructors:
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.X509CertificateWithInfo(com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo)"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.X509CertificateWithInfo(X509CertificateWithInfo x509CertificateWithInfo)"
name: "X509CertificateWithInfo(X509CertificateWithInfo x509CertificateWithInfo)"
nameWithType: "X509CertificateWithInfo.X509CertificateWithInfo(X509CertificateWithInfo x509CertificateWithInfo)"
summary: "Constructor \\[COPY\\]"
parameters:
- description: "the original <code>X509CertificateWithInfo</code> to copy."
name: "x509CertificateWithInfo"
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo&text=X509CertificateWithInfo\" data-throw-if-not-resolved=\"False\" />"
syntax: "public X509CertificateWithInfo(X509CertificateWithInfo x509CertificateWithInfo)"
desc: "Constructor \\[COPY\\]\n\nCreates a new instance of the X509CertificateWithInfo copping the content of the provided one."
methods:
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.getCertificate()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.getCertificate()"
name: "getCertificate()"
nameWithType: "X509CertificateWithInfo.getCertificate()"
summary: "Getter for the certificate."
syntax: "public String getCertificate()"
desc: "Getter for the certificate."
returns:
description: "the <code>String</code> with the stored certificate. It can be <code>null</code>."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.getInfo()"
fullName: "com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateWithInfo.getInfo()"
name: "getInfo()"
nameWithType: "X509CertificateWithInfo.getInfo()"
summary: "Getter for the info."
syntax: "public X509CertificateInfo getInfo()"
desc: "Getter for the info."
returns:
description: "the <code>String</code> with the stored info. It can be <code>null</code>."
type: "<xref href=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateInfo?alt=com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateInfo&text=X509CertificateInfo\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Representation of a single Device Provisioning Service X509 Certificate with its info.\n\nthis class creates a representation of an X509 certificate that can contains the certificate, the info of the certificate or both.\n\nTo create this class, users must provide the certificate as a `String`, from a **.pem** or **.cert** files.\n\nThe following JSON is an example of the result of this class.\n\n```java\n{\n \"certificate\": \"-----BEGIN CERTIFICATE-----\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\n\" +\n \"-----END CERTIFICATE-----\\n\";\n }\n```\n\nAfter send an X509 certificate to the provisioning service, it will return the <xref uid=\"com.microsoft.azure.sdk.iot.provisioning.service.configs.X509CertificateInfo\" data-throw-if-not-resolved=\"false\" data-raw-source=\"X509CertificateInfo\"></xref>. User can get this info from this class,\n\nThe following JSON is an example what info the provisioning service will return for X509.\n\n```java\n{\n \"info\": {\n \"subjectName\": \"CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US\",\n \"sha1Thumbprint\": \"0000000000000000000000000000000000\",\n \"sha256Thumbprint\": \"validEnrollmentGroupId\",\n \"issuerName\": \"CN=ROOT_00000000-0000-0000-0000-000000000000, OU=Azure IoT, O=MSFT, C=US\",\n \"notBeforeUtc\": \"2017-11-14T12:34:18Z\",\n \"notAfterUtc\": \"2017-11-20T12:34:18Z\",\n \"serialNumber\": \"000000000000000000\",\n \"version\": 3\n }\n }\n```"
metadata: {}
package: "com.microsoft.azure.sdk.iot.provisioning.service.configs"
artifact: com.microsoft.azure.sdk.iot.provisioning:provisioning-service-client:1.7.0