SASLEnvelope (Qpid ProtonJ2 Parent 1.0.0-M11 API)

java.lang.Object
- org.apache.qpid.protonj2.engine.PerformativeEnvelope<SaslPerformative>
- - org.apache.qpid.protonj2.engine.SASLEnvelope

public class SASLEnvelope
extends PerformativeEnvelope<SaslPerformative>

Frame object containing a SASL performative

Field Summary

Fields
Modifier and Type Field Description

static byte SASL_FRAME_TYPE
The frame type marker used when decoding or encoding AMQP Header frames.

Constructor Summary

Constructors
Constructor	Description
`SASLEnvelope(SaslPerformative performative)`	Creates a new SASL envelope that wraps the given SASL performative.
`SASLEnvelope(SaslPerformative performative, ProtonBuffer payload)`	Creates a new SASL envelope that wraps the given SASL performative.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<E> void`	`invoke(SaslPerformative.SaslPerformativeHandler<E> handler, E context)`	Invoke the correct handler based on the SASL performative contained in this envelope.

Methods inherited from class org.apache.qpid.protonj2.engine.PerformativeEnvelope
getBody, getChannel, getFrameType, getPayload, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SASL_FRAME_TYPE
```
public static final byte SASL_FRAME_TYPE
```
    The frame type marker used when decoding or encoding AMQP Header frames.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SASLEnvelope
```
public SASLEnvelope(SaslPerformative performative)
```
    Creates a new SASL envelope that wraps the given SASL performative.
    
    Parameters:
    
    performative - The SASL performative to be wrapped.
  - SASLEnvelope
```
public SASLEnvelope(SaslPerformative performative,
                    ProtonBuffer payload)
```
    Creates a new SASL envelope that wraps the given SASL performative.
    
    Parameters:
    
    performative - The SASL performative to be wrapped.
    
    payload - The payload that accompanies the wrapped SASL performative.
- Method Detail
  - invoke
```
public <E> void invoke(SaslPerformative.SaslPerformativeHandler<E> handler,
                       E context)
```
    Invoke the correct handler based on the SASL performative contained in this envelope.
    
    Type Parameters:
    
    E - The type of the context object that accompanies the invocation.
    
    Parameters:
    
    handler - The AMQPHeader.HeaderHandler that should be invoked based on the performative type.
    
    context - The context value to provide when signaling the SASL handler.