Joram 5.2.1

org.objectweb.joram.mom.amqp.marshalling
Class AMQP.Access.Request

java.lang.Object
  extended by org.objectweb.joram.mom.amqp.marshalling.AbstractMarshallingMethod
      extended by org.objectweb.joram.mom.amqp.marshalling.AMQP.Access.Request
All Implemented Interfaces:
FrameBuilder
Enclosing class:
AMQP.Access

public static class AMQP.Access.Request
extends AbstractMarshallingMethod

This method requests an access ticket for an access realm. The server responds by granting the access ticket. If the client does not have access rights to the requested realm this causes a connection exception. Access tickets are a per-channel resource.


Field Summary
 boolean active
          Request message active access to the specified access realm.
 boolean exclusive
          Request exclusive access to the realm, meaning that this will be the only channel that uses the realm's resources.
static int INDEX
           
 boolean passive
          Request message passive access to the specified access realm.
 boolean read
          Request read access to the specified access realm.
 java.lang.String realm
          Specifies the name of the realm to which the client is requesting access.
 boolean write
          Request write access to the specified access realm.
 
Fields inherited from class org.objectweb.joram.mom.amqp.marshalling.AbstractMarshallingMethod
logger, NULL_METHOD_ID
 
Constructor Summary
AMQP.Access.Request()
           
AMQP.Access.Request(java.lang.String realm, boolean exclusive, boolean passive, boolean active, boolean write, boolean read)
          This method requests an access ticket for an access realm.
 
Method Summary
 int getClassId()
           
 java.lang.String getClassName()
           
 int getMethodId()
           
 java.lang.String getMethodName()
           
 void readFrom(AMQPInputStream in)
           
 java.lang.String toString()
           
 void writeTo(AMQPOutputStream out)
           
 
Methods inherited from class org.objectweb.joram.mom.amqp.marshalling.AbstractMarshallingMethod
read, toFrame
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

realm

public java.lang.String realm
Specifies the name of the realm to which the client is requesting access. The realm is a configured server-side object that collects a set of resources (exchanges, queues, etc.). If the channel has already requested an access ticket onto this realm, the previous ticket is destroyed and a new ticket is created with the requested access rights, if allowed.


exclusive

public boolean exclusive
Request exclusive access to the realm, meaning that this will be the only channel that uses the realm's resources.


passive

public boolean passive
Request message passive access to the specified access realm. Passive access lets a client get information about resources in the realm but not to make any changes to them.


active

public boolean active
Request message active access to the specified access realm. Active access lets a client get create and delete resources in the realm.


write

public boolean write
Request write access to the specified access realm. Write access lets a client publish messages to all exchanges in the realm.


read

public boolean read
Request read access to the specified access realm. Read access lets a client consume messages from queues in the realm.


INDEX

public static final int INDEX
See Also:
Constant Field Values
Constructor Detail

AMQP.Access.Request

public AMQP.Access.Request(java.lang.String realm,
                           boolean exclusive,
                           boolean passive,
                           boolean active,
                           boolean write,
                           boolean read)
This method requests an access ticket for an access realm. The server responds by granting the access ticket. If the client does not have access rights to the requested realm this causes a connection exception. Access tickets are a per-channel resource.


AMQP.Access.Request

public AMQP.Access.Request()
Method Detail

getMethodId

public int getMethodId()
Specified by:
getMethodId in class AbstractMarshallingMethod

getMethodName

public java.lang.String getMethodName()
Specified by:
getMethodName in class AbstractMarshallingMethod

getClassId

public int getClassId()
Specified by:
getClassId in class AbstractMarshallingMethod

getClassName

public java.lang.String getClassName()
Specified by:
getClassName in class AbstractMarshallingMethod

readFrom

public void readFrom(AMQPInputStream in)
              throws java.io.IOException
Specified by:
readFrom in class AbstractMarshallingMethod
Throws:
java.io.IOException

writeTo

public void writeTo(AMQPOutputStream out)
             throws java.io.IOException
Specified by:
writeTo in class AbstractMarshallingMethod
Throws:
java.io.IOException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Joram 5.2.1

Copyright © 2005 Scalagent - All rights reserved