Package org.ow2.joram.mom.amqp.marshalling

Class AMQP.Queue.Declare

java.lang.Object

org.ow2.joram.mom.amqp.marshalling.AbstractMarshallingMethod

org.ow2.joram.mom.amqp.marshalling.AMQP.Queue.Declare

All Implemented Interfaces:

Serializable

Enclosing class:

AMQP.Queue

public static class AMQP.Queue.Declare
extends AbstractMarshallingMethod

This method creates or checks a queue. When creating a new queue the client can specify various properties that control the durability of the queue and its contents, and the level of sharing for the queue.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
Map	arguments	A set of arguments for the declaration.
boolean	autoDelete	If set, the queue is deleted when all consumers have finished using it.
boolean	durable	If set when creating a new queue, the queue will be marked as durable.
boolean	exclusive	Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes.
static int	INDEX
boolean	noWait
boolean	passive	If set, the server will reply with Declare-Ok if the queue already exists with the same name, and raise an error if not.
String	queue
int	reserved1
private static long	serialVersionUID

Fields inherited from class org.ow2.joram.mom.amqp.marshalling.AbstractMarshallingMethod

channelNumber

Constructor Summary

Constructors

Constructor	Description
Declare()
Declare(int reserved1, String queue, boolean passive, boolean durable, boolean exclusive, boolean autoDelete, boolean noWait, Map arguments)	This method creates or checks a queue.

Method Summary

Modifier and Type	Method	Description
int	getClassId()
String	getClassName()
int	getMethodId()
String	getMethodName()
void	readFrom(AMQPInputStream in)
String	toString()
void	writeTo(AMQPOutputStream out)

Methods inherited from class org.ow2.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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

reserved1

public int reserved1

queue

public String queue

passive

public boolean passive

If set, the server will reply with Declare-Ok if the queue already exists with the same name, and raise an error if not. The client can use this to check whether a queue exists without modifying the server state. When set, all other method fields except name and no-wait are ignored. A declare with both passive and no-wait has no effect. Arguments are compared for semantic equivalence.

durable

public boolean durable

If set when creating a new queue, the queue will be marked as durable. Durable queues remain active when a server restarts. Non-durable queues (transient queues) are purged if/when a server restarts. Note that durable queues do not necessarily hold persistent messages, although it does not make sense to send persistent messages to a transient queue.

exclusive

public boolean exclusive

Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes. Passive declaration of an exclusive queue by other connections are not allowed.

autoDelete

public boolean autoDelete

If set, the queue is deleted when all consumers have finished using it. The last consumer can be cancelled either explicitly or because its channel is closed. If there was no consumer ever on the queue, it won't be deleted. Applications can explicitly delete auto-delete queues using the Delete method as normal.

noWait

public boolean noWait

arguments

public Map arguments

A set of arguments for the declaration. The syntax and semantics of these arguments depends on the server implementation.

INDEX

public static final int INDEX

See Also:

Constant Field Values

Constructor Detail

Declare

public Declare(int reserved1,
               String queue,
               boolean passive,
               boolean durable,
               boolean exclusive,
               boolean autoDelete,
               boolean noWait,
               Map arguments)

This method creates or checks a queue. When creating a new queue the client can specify various properties that control the durability of the queue and its contents, and the level of sharing for the queue.

Declare

public Declare()

Method Detail

getMethodId

public int getMethodId()

Specified by:

getMethodId in class AbstractMarshallingMethod

getMethodName

public String getMethodName()

Specified by:

getMethodName in class AbstractMarshallingMethod

getClassId

public int getClassId()

Specified by:

getClassId in class AbstractMarshallingMethod

getClassName

public String getClassName()

Specified by:

getClassName in class AbstractMarshallingMethod

readFrom

public void readFrom(AMQPInputStream in)
              throws IOException,
                     SyntaxErrorException

Specified by:

readFrom in class AbstractMarshallingMethod

Throws:

IOException

SyntaxErrorException

writeTo

public void writeTo(AMQPOutputStream out)
             throws IOException

Specified by:

writeTo in class AbstractMarshallingMethod

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object