Package com.swiftmq.amqp.v100.generated.security.sasl

Class SaslOutcomeFrame

java.lang.Object

com.swiftmq.amqp.v100.transport.AMQPFrame

com.swiftmq.amqp.v100.generated.security.sasl.SaslOutcomeFrame

All Implemented Interfaces:

SaslFrameIF, FrameIF, Writable

public class SaslOutcomeFrame
extends AMQPFrame
implements SaslFrameIF

This frame indicates the outcome of the SASL dialog. Upon successful completion of the SASL dialog the security layer has been established, and the peers must exchange protocol headers to either start a nested security layer, or to establish the AMQP connection.

Version:

AMQP Version v100. Generation Date: Wed Apr 18 14:09:32 CEST 2012

Author:

IIT Software GmbH, Bremen/Germany, (c) 2012, All Rights Reserved

Field Summary

Fields

Modifier and Type	Field	Description
AMQPDescribedConstructor	codeConstructor
static long	DESCRIPTOR_CODE
static java.lang.String	DESCRIPTOR_NAME
AMQPDescribedConstructor	nameConstructor

Fields inherited from class com.swiftmq.amqp.v100.transport.AMQPFrame

HEADER_SIZE, TYPE_CODE_AMQP_FRAME, TYPE_CODE_SASL_FRAME

Constructor Summary

Constructors

Constructor	Description
SaslOutcomeFrame(int channel)	Constructs a SaslOutcomeFrame.
SaslOutcomeFrame(int channel, AMQPList body)	Constructs a SaslOutcomeFrame.

Method Summary

Modifier and Type	Method	Description
void	accept(SaslFrameVisitor visitor)	Accept method for a SaslFrame visitor.
AMQPBinary	getAdditionalData()	Returns the optional AdditionalData field.
SaslCode	getMycode()	Returns the mandatory Mycode field.
int	getPredictedSize()	Returns the predicted size of this SaslOutcomeFrame.
java.lang.String	getValueString()	Returns a value representation of this SaslOutcomeFrame.
void	setAdditionalData(AMQPBinary additionalData)	Sets the optional AdditionalData field.
void	setMycode(SaslCode mycode)	Sets the mandatory Mycode field.
java.lang.String	toString()
protected void	writeBody(java.io.DataOutput out)

Methods inherited from class com.swiftmq.amqp.v100.transport.AMQPFrame

accept, addMorePayload, getCallback, getChannel, getMorePayloads, getPayload, getPayloadLength, getSemaphore, setCallback, setChannel, setPayload, setSemaphore, setTypeCode, writeContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DESCRIPTOR_NAME

public static java.lang.String DESCRIPTOR_NAME

DESCRIPTOR_CODE

public static long DESCRIPTOR_CODE

codeConstructor

public AMQPDescribedConstructor codeConstructor

nameConstructor

public AMQPDescribedConstructor nameConstructor

Constructor Detail

SaslOutcomeFrame

public SaslOutcomeFrame(int channel,
                        AMQPList body)
                 throws java.lang.Exception

Constructs a SaslOutcomeFrame.

Parameters:

channel - the channel id

body - the frame body

Throws:

java.lang.Exception

SaslOutcomeFrame

public SaslOutcomeFrame(int channel)

Constructs a SaslOutcomeFrame.

Parameters:

channel - the channel id

Method Detail

accept

public void accept(SaslFrameVisitor visitor)

Accept method for a SaslFrame visitor.

Specified by:

accept in interface SaslFrameIF

Overrides:

accept in class AMQPFrame

Parameters:

visitor - SaslFrame visitor

getMycode

public SaslCode getMycode()

Returns the mandatory Mycode field.

Returns:

Mycode

setMycode

public void setMycode(SaslCode mycode)

Sets the mandatory Mycode field.

A reply-code indicating the outcome of the SASL dialog.

Parameters:

mycode - Mycode

getAdditionalData

public AMQPBinary getAdditionalData()

Returns the optional AdditionalData field.

Returns:

AdditionalData

setAdditionalData

public void setAdditionalData(AMQPBinary additionalData)

Sets the optional AdditionalData field.

The additional-data field carries additional data on successful authentication outcome as specified by the SASL specification [ RFC4422 ]. If the authentication is unsuccessful, this field is not set.

Parameters:

additionalData - AdditionalData

getPredictedSize

public int getPredictedSize()

Returns the predicted size of this SaslOutcomeFrame. The predicted size may be greater than the actual size but it can never be less.

Specified by:

getPredictedSize in interface FrameIF

Specified by:

getPredictedSize in interface SaslFrameIF

Overrides:

getPredictedSize in class AMQPFrame

Returns:

predicted size

writeBody

protected void writeBody(java.io.DataOutput out)
                  throws java.io.IOException

Specified by:

writeBody in class AMQPFrame

Throws:

java.io.IOException

getValueString

public java.lang.String getValueString()

Returns a value representation of this SaslOutcomeFrame.

Specified by:

getValueString in interface FrameIF

Specified by:

getValueString in interface SaslFrameIF

Overrides:

getValueString in class AMQPFrame

Returns:

value representation

toString

public java.lang.String toString()

Overrides:

toString in class AMQPFrame