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 Details

  • Constructor Details

    • SaslOutcomeFrame

      public SaslOutcomeFrame(int channel, AMQPList body) throws Exception
      Constructs a SaslOutcomeFrame.
      Parameters:
      channel - the channel id
      body - the frame body
      Throws:
      Exception

    • SaslOutcomeFrame

      public SaslOutcomeFrame(int channel)
      Constructs a SaslOutcomeFrame.
      Parameters:
      channel - the channel id

  • Method Details

    • 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(DataOutput out) throws IOException
      Specified by:
      writeBody in class AMQPFrame
      Throws:
      IOException

    • getValueString

      public 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 String toString()
      Overrides:
      toString in class AMQPFrame