azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.sdk.iot...

116 строки
9.4 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl"
name: "SaslListenerImpl"
nameWithType: "SaslListenerImpl"
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 **SaslListenerImpl**</br> implements <xref href=\"org.apache.qpid.proton.engine.SaslListener?alt=org.apache.qpid.proton.engine.SaslListener&text=SaslListener\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.SaslListenerImpl(com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslHandler)"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.SaslListenerImpl(SaslHandler saslHandler)"
name: "SaslListenerImpl(SaslHandler saslHandler)"
nameWithType: "SaslListenerImpl.SaslListenerImpl(SaslHandler saslHandler)"
summary: "Sasl listener implementation that defers mechanism selection, init message payloads, and challenge handling to the provided sasl<wbr>Handler"
parameters:
- description: "The object that decides how to choose which mechanism to use and how to build message payloads"
name: "saslHandler"
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslHandler?alt=com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslHandler&text=SaslHandler\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SaslListenerImpl(SaslHandler saslHandler)"
desc: "Sasl listener implementation that defers mechanism selection, init message payloads, and challenge handling to the provided saslHandler"
methods:
- uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.getSavedException()"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.getSavedException()"
name: "getSavedException()"
nameWithType: "SaslListenerImpl.getSavedException()"
summary: "Returns an exception if the sasl negotiation encountered an exception, or null if it has not thrown any exceptions"
syntax: "public Exception getSavedException()"
desc: "Returns an exception if the sasl negotiation encountered an exception, or null if it has not thrown any exceptions"
returns:
description: "the exception the sasl negotiation encountered"
type: "<xref href=\"java.lang.Exception?alt=java.lang.Exception&text=Exception\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslChallenge(org.apache.qpid.proton.engine.Sasl,org.apache.qpid.proton.engine.Transport)"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslChallenge(Sasl sasl, Transport transport)"
name: "onSaslChallenge(Sasl sasl, Transport transport)"
nameWithType: "SaslListenerImpl.onSaslChallenge(Sasl sasl, Transport transport)"
parameters:
- description: "the Sasl object"
name: "sasl"
type: "<xref href=\"org.apache.qpid.proton.engine.Sasl?alt=org.apache.qpid.proton.engine.Sasl&text=Sasl\" data-throw-if-not-resolved=\"False\" />"
- description: "the related transport"
name: "transport"
type: "<xref href=\"org.apache.qpid.proton.engine.Transport?alt=org.apache.qpid.proton.engine.Transport&text=Transport\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void onSaslChallenge(Sasl sasl, Transport transport)"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslInit(org.apache.qpid.proton.engine.Sasl,org.apache.qpid.proton.engine.Transport)"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslInit(Sasl sasl, Transport transport)"
name: "onSaslInit(Sasl sasl, Transport transport)"
nameWithType: "SaslListenerImpl.onSaslInit(Sasl sasl, Transport transport)"
summary: "Does nothing."
parameters:
- name: "sasl"
type: "<xref href=\"org.apache.qpid.proton.engine.Sasl?alt=org.apache.qpid.proton.engine.Sasl&text=Sasl\" data-throw-if-not-resolved=\"False\" />"
- name: "transport"
type: "<xref href=\"org.apache.qpid.proton.engine.Transport?alt=org.apache.qpid.proton.engine.Transport&text=Transport\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void onSaslInit(Sasl sasl, Transport transport)"
desc: "Does nothing. This implementation is for clients only, not servers"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslMechanisms(org.apache.qpid.proton.engine.Sasl,org.apache.qpid.proton.engine.Transport)"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslMechanisms(Sasl sasl, Transport transport)"
name: "onSaslMechanisms(Sasl sasl, Transport transport)"
nameWithType: "SaslListenerImpl.onSaslMechanisms(Sasl sasl, Transport transport)"
summary: "This event is fired when the service advertises some sasl authentication mechanisms."
parameters:
- description: "the Sasl object"
name: "sasl"
type: "<xref href=\"org.apache.qpid.proton.engine.Sasl?alt=org.apache.qpid.proton.engine.Sasl&text=Sasl\" data-throw-if-not-resolved=\"False\" />"
- description: "the related transport"
name: "transport"
type: "<xref href=\"org.apache.qpid.proton.engine.Transport?alt=org.apache.qpid.proton.engine.Transport&text=Transport\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void onSaslMechanisms(Sasl sasl, Transport transport)"
desc: "This event is fired when the service advertises some sasl authentication mechanisms. This method sends the init message in response."
- uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslOutcome(org.apache.qpid.proton.engine.Sasl,org.apache.qpid.proton.engine.Transport)"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslOutcome(Sasl sasl, Transport transport)"
name: "onSaslOutcome(Sasl sasl, Transport transport)"
nameWithType: "SaslListenerImpl.onSaslOutcome(Sasl sasl, Transport transport)"
summary: "This event is fired when Sasl negotiation finishes."
parameters:
- description: "the Sasl object"
name: "sasl"
type: "<xref href=\"org.apache.qpid.proton.engine.Sasl?alt=org.apache.qpid.proton.engine.Sasl&text=Sasl\" data-throw-if-not-resolved=\"False\" />"
- description: "the related transport"
name: "transport"
type: "<xref href=\"org.apache.qpid.proton.engine.Transport?alt=org.apache.qpid.proton.engine.Transport&text=Transport\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void onSaslOutcome(Sasl sasl, Transport transport)"
desc: "This event is fired when Sasl negotiation finishes. It passes the results to the handler for any further processing"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslResponse(org.apache.qpid.proton.engine.Sasl,org.apache.qpid.proton.engine.Transport)"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.amqp.SaslListenerImpl.onSaslResponse(Sasl sasl, Transport transport)"
name: "onSaslResponse(Sasl sasl, Transport transport)"
nameWithType: "SaslListenerImpl.onSaslResponse(Sasl sasl, Transport transport)"
summary: "Does nothing."
parameters:
- name: "sasl"
type: "<xref href=\"org.apache.qpid.proton.engine.Sasl?alt=org.apache.qpid.proton.engine.Sasl&text=Sasl\" data-throw-if-not-resolved=\"False\" />"
- name: "transport"
type: "<xref href=\"org.apache.qpid.proton.engine.Transport?alt=org.apache.qpid.proton.engine.Transport&text=Transport\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void onSaslResponse(Sasl sasl, Transport transport)"
desc: "Does nothing. This implementation is for clients only, not servers"
type: "class"
implements:
- "<xref href=\"org.apache.qpid.proton.engine.SaslListener?alt=org.apache.qpid.proton.engine.SaslListener&text=SaslListener\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.azure.sdk.iot.deps.transport.amqp"
artifact: com.microsoft.azure.sdk.iot:iot-deps:0.12.0