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

Class SaslChallengeFrame

java.lang.Object

com.swiftmq.amqp.v100.transport.AMQPFrame

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

All Implemented Interfaces:

SaslFrameIF, FrameIF, Writable

public class SaslChallengeFrame
extends AMQPFrame
implements SaslFrameIF

Send the SASL challenge data as defined by the SASL specification.

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
SaslChallengeFrame(int channel)	Constructs a SaslChallengeFrame.
SaslChallengeFrame(int channel, AMQPList body)	Constructs a SaslChallengeFrame.

Method Summary

Modifier and Type	Method	Description
void	accept(SaslFrameVisitor visitor)	Accept method for a SaslFrame visitor.
AMQPBinary	getChallenge()	Returns the mandatory Challenge field.
int	getPredictedSize()	Returns the predicted size of this SaslChallengeFrame.
java.lang.String	getValueString()	Returns a value representation of this SaslChallengeFrame.
void	setChallenge(AMQPBinary challenge)	Sets the mandatory Challenge 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

SaslChallengeFrame

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

Constructs a SaslChallengeFrame.

Parameters:

channel - the channel id

body - the frame body

Throws:

java.lang.Exception

SaslChallengeFrame

public SaslChallengeFrame(int channel)

Constructs a SaslChallengeFrame.

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

getChallenge

public AMQPBinary getChallenge()

Returns the mandatory Challenge field.

Returns:

Challenge

setChallenge

public void setChallenge(AMQPBinary challenge)

Sets the mandatory Challenge field.

Challenge information, a block of opaque binary data passed to the security mechanism.

Parameters:

challenge - Challenge

getPredictedSize

public int getPredictedSize()

Returns the predicted size of this SaslChallengeFrame. 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 SaslChallengeFrame.

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