227 строки
15 KiB
YAML
227 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider"
|
|
name: "IotHubAuthenticationProvider"
|
|
nameWithType: "IotHubAuthenticationProvider"
|
|
summary: "Base class for providing authentication for a Device Client or Module Client, including x509 and SAS based authentication."
|
|
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 abstract class **IotHubAuthenticationProvider**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.IotHubAuthenticationProvider(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)"
|
|
name: "IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)"
|
|
nameWithType: "IotHubAuthenticationProvider.IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)"
|
|
parameters:
|
|
- name: "hostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "gatewayHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "moduleId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId)"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.IotHubAuthenticationProvider(java.lang.String,java.lang.String,java.lang.String,java.lang.String,javax.net.ssl.SSLContext)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SSLContext sslContext)"
|
|
name: "IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SSLContext sslContext)"
|
|
nameWithType: "IotHubAuthenticationProvider.IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SSLContext sslContext)"
|
|
parameters:
|
|
- name: "hostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "gatewayHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "moduleId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "sslContext"
|
|
type: "<xref href=\"javax.net.ssl.SSLContext?alt=javax.net.ssl.SSLContext&text=SSLContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public IotHubAuthenticationProvider(String hostname, String gatewayHostname, String deviceId, String moduleId, SSLContext sslContext)"
|
|
fields:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.deviceId"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.deviceId"
|
|
name: "deviceId"
|
|
nameWithType: "IotHubAuthenticationProvider.deviceId"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String deviceId"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.gatewayHostname"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.gatewayHostname"
|
|
name: "gatewayHostname"
|
|
nameWithType: "IotHubAuthenticationProvider.gatewayHostname"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String gatewayHostname"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.hostname"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.hostname"
|
|
name: "hostname"
|
|
nameWithType: "IotHubAuthenticationProvider.hostname"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String hostname"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.iotHubSSLContext"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.iotHubSSLContext"
|
|
name: "iotHubSSLContext"
|
|
nameWithType: "IotHubAuthenticationProvider.iotHubSSLContext"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.auth.IotHubSSLContext?alt=com.microsoft.azure.sdk.iot.deps.auth.IotHubSSLContext&text=IotHubSSLContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected IotHubSSLContext iotHubSSLContext"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.iotHubTrustedCert"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.iotHubTrustedCert"
|
|
name: "iotHubTrustedCert"
|
|
nameWithType: "IotHubAuthenticationProvider.iotHubTrustedCert"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String iotHubTrustedCert"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.moduleId"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.moduleId"
|
|
name: "moduleId"
|
|
nameWithType: "IotHubAuthenticationProvider.moduleId"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String moduleId"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.pathToIotHubTrustedCert"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.pathToIotHubTrustedCert"
|
|
name: "pathToIotHubTrustedCert"
|
|
nameWithType: "IotHubAuthenticationProvider.pathToIotHubTrustedCert"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected String pathToIotHubTrustedCert"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.sslContextNeedsUpdate"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.sslContextNeedsUpdate"
|
|
name: "sslContextNeedsUpdate"
|
|
nameWithType: "IotHubAuthenticationProvider.sslContextNeedsUpdate"
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected boolean sslContextNeedsUpdate"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getDeviceId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getDeviceId()"
|
|
name: "getDeviceId()"
|
|
nameWithType: "IotHubAuthenticationProvider.getDeviceId()"
|
|
summary: "Get the device<wbr>Id"
|
|
syntax: "public String getDeviceId()"
|
|
desc: "Get the deviceId"
|
|
returns:
|
|
description: "the saved deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getGatewayHostname()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getGatewayHostname()"
|
|
name: "getGatewayHostname()"
|
|
nameWithType: "IotHubAuthenticationProvider.getGatewayHostname()"
|
|
summary: "Get the gateway<wbr>Hostname"
|
|
syntax: "public String getGatewayHostname()"
|
|
desc: "Get the gatewayHostname"
|
|
returns:
|
|
description: "the saved gatewayHostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getHostname()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getHostname()"
|
|
name: "getHostname()"
|
|
nameWithType: "IotHubAuthenticationProvider.getHostname()"
|
|
summary: "Get the hostname"
|
|
syntax: "public String getHostname()"
|
|
desc: "Get the hostname"
|
|
returns:
|
|
description: "the saved hostname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getIotHubTrustedCert()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getIotHubTrustedCert()"
|
|
name: "getIotHubTrustedCert()"
|
|
nameWithType: "IotHubAuthenticationProvider.getIotHubTrustedCert()"
|
|
syntax: "public String getIotHubTrustedCert()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getModuleId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getModuleId()"
|
|
name: "getModuleId()"
|
|
nameWithType: "IotHubAuthenticationProvider.getModuleId()"
|
|
summary: "Get the module id"
|
|
syntax: "public String getModuleId()"
|
|
desc: "Get the module id"
|
|
returns:
|
|
description: "the saved module id"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getPathToIotHubTrustedCert()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getPathToIotHubTrustedCert()"
|
|
name: "getPathToIotHubTrustedCert()"
|
|
nameWithType: "IotHubAuthenticationProvider.getPathToIotHubTrustedCert()"
|
|
syntax: "public String getPathToIotHubTrustedCert()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getSSLContext()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.getSSLContext()"
|
|
name: "getSSLContext()"
|
|
nameWithType: "IotHubAuthenticationProvider.getSSLContext()"
|
|
syntax: "public SSLContext getSSLContext()"
|
|
exceptions:
|
|
- type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
|
|
returns:
|
|
type: "<xref href=\"javax.net.ssl.SSLContext?alt=javax.net.ssl.SSLContext&text=SSLContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.setIotHubTrustedCert(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.setIotHubTrustedCert(String certificate)"
|
|
name: "setIotHubTrustedCert(String certificate)"
|
|
nameWithType: "IotHubAuthenticationProvider.setIotHubTrustedCert(String certificate)"
|
|
summary: "Setter for the user trusted certificate"
|
|
parameters:
|
|
- description: "valid user trusted certificate string"
|
|
name: "certificate"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setIotHubTrustedCert(String certificate)"
|
|
desc: "Setter for the user trusted certificate"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.setPathToIotHubTrustedCert(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.setPathToIotHubTrustedCert(String pathToCertificate)"
|
|
name: "setPathToIotHubTrustedCert(String pathToCertificate)"
|
|
nameWithType: "IotHubAuthenticationProvider.setPathToIotHubTrustedCert(String pathToCertificate)"
|
|
summary: "Setter for the providing trusted certificate."
|
|
parameters:
|
|
- description: "path to the certificate for one way authentication."
|
|
name: "pathToCertificate"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setPathToIotHubTrustedCert(String pathToCertificate)"
|
|
desc: "Setter for the providing trusted certificate."
|
|
- uid: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.setSSLContext(javax.net.ssl.SSLContext)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.auth.IotHubAuthenticationProvider.setSSLContext(SSLContext sslContext)"
|
|
name: "setSSLContext(SSLContext sslContext)"
|
|
nameWithType: "IotHubAuthenticationProvider.setSSLContext(SSLContext sslContext)"
|
|
parameters:
|
|
- name: "sslContext"
|
|
type: "<xref href=\"javax.net.ssl.SSLContext?alt=javax.net.ssl.SSLContext&text=SSLContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setSSLContext(SSLContext sslContext)"
|
|
type: "class"
|
|
desc: "Base class for providing authentication for a Device Client or Module Client, including x509 and SAS based authentication."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device.auth"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|