AMQDestination (Qpid AMQP 0-x JMS Client 0.32 API)

java.lang.Object
- org.apache.qpid.client.AMQDestination

All Implemented Interfaces:

Externalizable, Serializable, javax.jms.Destination, Referenceable

Direct Known Subclasses:

AMQAnyDestination, AMQHeadersExchange, AMQQueue, AMQTopic, AMQUndefinedDestination
```
public abstract class AMQDestination
extends Object
implements javax.jms.Destination, Referenceable, Externalizable
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AMQDestination.AddressOption

static class AMQDestination.Binding

static class AMQDestination.DestSyntax

Nested Classes
Modifier and Type	Class and Description
`static class`	`AMQDestination.AddressOption`
`static class`	`AMQDestination.Binding`
`static class`	`AMQDestination.DestSyntax`

Field Summary

Fields
Modifier and Type Field and Description

static int QUEUE_TYPE

static int TOPIC_TYPE

static int UNKNOWN_TYPE

Fields
Modifier and Type	Field and Description
`static int`	`QUEUE_TYPE`
`static int`	`TOPIC_TYPE`
`static int`	`UNKNOWN_TYPE`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AMQDestination()`
`protected`	`AMQDestination(Address address)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString destinationName)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString routingKey, AMQShortString queueName)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString routingKey, AMQShortString queueName, AMQShortString[] bindingKeys)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString routingKey, boolean isExclusive, boolean isAutoDelete, AMQShortString queueName)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString routingKey, boolean isExclusive, boolean isAutoDelete, AMQShortString queueName, AMQShortString[] bindingKeys)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString routingKey, boolean isExclusive, boolean isAutoDelete, AMQShortString queueName, boolean isDurable)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString routingKey, boolean isExclusive, boolean isAutoDelete, AMQShortString queueName, boolean isDurable, AMQShortString[] bindingKeys)`
`protected`	`AMQDestination(AMQShortString exchangeName, AMQShortString exchangeClass, AMQShortString routingKey, boolean isExclusive, boolean isAutoDelete, AMQShortString queueName, boolean isDurable, AMQShortString[] bindingKeys, boolean browseOnly)`
`protected`	`AMQDestination(BindingURL binding)`
`protected`	`AMQDestination(String str)`

Method Summary

Methods
Modifier and Type	Method and Description
`AMQDestination`	`copyDestination()`
`static javax.jms.Destination`	`createDestination(BindingURL binding)`
`static javax.jms.Destination`	`createDestination(String str, boolean useNodeTypeForDestinationType)`
`boolean`	`equals(Object o)`
`Address`	`getAddress()`
`String`	`getAddressName()`
`int`	`getAddressType()`
`protected AddressHelper`	`getAddrHelper()`
`AMQShortString`	`getAMQQueueName()`
`AMQDestination.AddressOption`	`getAssert()`
`AMQShortString[]`	`getBindingKeys()`
`Map<String,Object>`	`getConsumerArguments()`
`AMQDestination.AddressOption`	`getCreate()`
`static AMQDestination.DestSyntax`	`getDefaultDestSyntax()`
`AMQDestination.AddressOption`	`getDelete()`
`String`	`getDestinationString()`
`AMQDestination.DestSyntax`	`getDestSyntax()`
`static AMQDestination.DestSyntax`	`getDestType(String str)`
`AMQShortString`	`getEncodedName()`
`AMQShortString`	`getExchangeClass()`
`AMQShortString`	`getExchangeName()`
`protected void`	`getInfoFromBindingURL(BindingURL binding)`
`Link`	`getLink()`
`protected String`	`getName()`
`Node`	`getNode()`
`String`	`getQueueName()`
`Reference`	`getReference()`
`RejectBehaviour`	`getRejectBehaviour()` This option is only applicable for 0-8/0-9/0-9-1 protocols connection
`AMQShortString`	`getRoutingKey()`
`String`	`getSubject()`
`int`	`hashCode()`
`boolean`	`isAddressResolved()`
`boolean`	`isAutoDelete()`
`boolean`	`isBrowseOnly()`
`boolean`	`isCheckedForQueueBinding()`
`boolean`	`isDurable()`
`boolean`	`isExchangeAutoDelete()`
`boolean`	`isExchangeDurable()`
`boolean`	`isExchangeExistsChecked()`
`boolean`	`isExchangeInternal()`
`boolean`	`isExclusive()`
`abstract boolean`	`isNameRequired()`
`boolean`	`isQueue()`
`boolean`	`isResolvedAfter(long time)`
`boolean`	`isTopic()`
`boolean`	`neverDeclare()`
`protected void`	`parseDestinationString(String str)`
`void`	`readExternal(ObjectInput in)`
`protected void`	`setAddress(Address addr)`
`void`	`setAddressName(String name)`
`void`	`setAddressResolved(long addressResolved)`
`void`	`setAddressType(int addressType)`
`protected void`	`setAddrHelper(AddressHelper addrHelper)`
`void`	`setAssert(AMQDestination.AddressOption option)`
`protected void`	`setAutoDelete(boolean b)`
`void`	`setCheckedForQueueBinding(boolean checkedForQueueBinding)`
`void`	`setCreate(AMQDestination.AddressOption option)`
`void`	`setDelete(AMQDestination.AddressOption option)`
`void`	`setDestinationString(String str)`
`protected void`	`setDestSyntax(AMQDestination.DestSyntax syntax)`
`protected void`	`setDurable(boolean b)`
`void`	`setExchangeClass(AMQShortString type)`
`void`	`setExchangeExistsChecked(boolean exchangeExistsChecked)`
`void`	`setExchangeName(AMQShortString name)`
`protected void`	`setExclusive(boolean exclusive)`
`void`	`setLink(Link link)`
`protected void`	`setName(String name)`
`void`	`setNode(Node node)`
`void`	`setQueueName(AMQShortString queueName)`
`void`	`setRoutingKey(AMQShortString rk)`
`void`	`setSubject(String subject)`
`static String`	`stripSyntaxPrefix(String str)`
`String`	`toString()`
`String`	`toURL()`
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- QUEUE_TYPE
```
public static final int QUEUE_TYPE
```
  See Also:
  Constant Field Values
- TOPIC_TYPE
```
public static final int TOPIC_TYPE
```
  See Also:
  Constant Field Values
- UNKNOWN_TYPE
```
public static final int UNKNOWN_TYPE
```
  See Also:
  Constant Field Values

Constructor Detail

AMQDestination
```
protected AMQDestination()
```

AMQDestination

protected AMQDestination(Address address)

AMQDestination

protected AMQDestination(String str)
                  throws URISyntaxException

Throws:: URISyntaxException

AMQDestination

protected AMQDestination(BindingURL binding)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString routingKey,
              AMQShortString queueName)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString routingKey,
              AMQShortString queueName,
              AMQShortString[] bindingKeys)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString destinationName)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString routingKey,
              boolean isExclusive,
              boolean isAutoDelete,
              AMQShortString queueName)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString routingKey,
              boolean isExclusive,
              boolean isAutoDelete,
              AMQShortString queueName,
              AMQShortString[] bindingKeys)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString routingKey,
              boolean isExclusive,
              boolean isAutoDelete,
              AMQShortString queueName,
              boolean isDurable)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString routingKey,
              boolean isExclusive,
              boolean isAutoDelete,
              AMQShortString queueName,
              boolean isDurable,
              AMQShortString[] bindingKeys)

AMQDestination

protected AMQDestination(AMQShortString exchangeName,
              AMQShortString exchangeClass,
              AMQShortString routingKey,
              boolean isExclusive,
              boolean isAutoDelete,
              AMQShortString queueName,
              boolean isDurable,
              AMQShortString[] bindingKeys,
              boolean browseOnly)

Method Detail

setExclusive

protected void setExclusive(boolean exclusive)

getAddrHelper

protected AddressHelper getAddrHelper()

setAddrHelper

protected void setAddrHelper(AddressHelper addrHelper)

getName
```
protected String getName()
```

setName
```
protected void setName(String name)
```

neverDeclare
```
public boolean neverDeclare()
```

getDefaultDestSyntax

public static AMQDestination.DestSyntax getDefaultDestSyntax()

getDestType

public static AMQDestination.DestSyntax getDestType(String str)

stripSyntaxPrefix

public static String stripSyntaxPrefix(String str)

parseDestinationString

protected void parseDestinationString(String str)
                               throws URISyntaxException

Throws:: URISyntaxException

getInfoFromBindingURL

protected void getInfoFromBindingURL(BindingURL binding)

setDestinationString

public void setDestinationString(String str)
                          throws Exception

Throws:: Exception

getDestinationString
```
public String getDestinationString()
```

getDestSyntax

public AMQDestination.DestSyntax getDestSyntax()

setDestSyntax

protected void setDestSyntax(AMQDestination.DestSyntax syntax)

getEncodedName

public AMQShortString getEncodedName()

isDurable
```
public boolean isDurable()
```

getExchangeName

public AMQShortString getExchangeName()

getExchangeClass

public AMQShortString getExchangeClass()

isExchangeDurable
```
public boolean isExchangeDurable()
```

isExchangeAutoDelete
```
public boolean isExchangeAutoDelete()
```

isExchangeInternal
```
public boolean isExchangeInternal()
```

isTopic
```
public boolean isTopic()
```

isQueue
```
public boolean isQueue()
```

getQueueName
```
public String getQueueName()
```

getAMQQueueName

public AMQShortString getAMQQueueName()

setQueueName

public void setQueueName(AMQShortString queueName)

getRoutingKey
```
public AMQShortString getRoutingKey()
```

getBindingKeys

public AMQShortString[] getBindingKeys()

isExclusive
```
public boolean isExclusive()
```

isAutoDelete
```
public boolean isAutoDelete()
```

isNameRequired

public abstract boolean isNameRequired()

toString
```
public String toString()
```
Overrides:

toString in class Object

isCheckedForQueueBinding

public boolean isCheckedForQueueBinding()

setCheckedForQueueBinding

public void setCheckedForQueueBinding(boolean checkedForQueueBinding)

isExchangeExistsChecked

public boolean isExchangeExistsChecked()

setExchangeExistsChecked

public void setExchangeExistsChecked(boolean exchangeExistsChecked)

toURL
```
public String toURL()
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getConsumerArguments

public Map<String,Object> getConsumerArguments()

getReference

public Reference getReference()
                       throws NamingException

Specified by:: getReference in interface Referenceable
Throws:: NamingException

createDestination

public static javax.jms.Destination createDestination(BindingURL binding)

createDestination

public static javax.jms.Destination createDestination(String str,
                                      boolean useNodeTypeForDestinationType)
                                               throws URISyntaxException

Throws:: URISyntaxException

getAddress
```
public Address getAddress()
```

setAddress

protected void setAddress(Address addr)

getAddressType
```
public int getAddressType()
```

setAddressType

public void setAddressType(int addressType)

getAddressName
```
public String getAddressName()
```

setAddressName

public void setAddressName(String name)

getSubject
```
public String getSubject()
```

setSubject

public void setSubject(String subject)

getCreate

public AMQDestination.AddressOption getCreate()

setCreate

public void setCreate(AMQDestination.AddressOption option)

getAssert

public AMQDestination.AddressOption getAssert()

setAssert

public void setAssert(AMQDestination.AddressOption option)

getDelete

public AMQDestination.AddressOption getDelete()

setDelete

public void setDelete(AMQDestination.AddressOption option)

getNode
```
public Node getNode()
```

setNode
```
public void setNode(Node node)
```

getLink
```
public Link getLink()
```

setLink
```
public void setLink(Link link)
```

setExchangeName

public void setExchangeName(AMQShortString name)

setExchangeClass

public void setExchangeClass(AMQShortString type)

setRoutingKey

public void setRoutingKey(AMQShortString rk)

isAddressResolved
```
public boolean isAddressResolved()
```

setAddressResolved

public void setAddressResolved(long addressResolved)

isBrowseOnly
```
public boolean isBrowseOnly()
```

copyDestination

public AMQDestination copyDestination()

setAutoDelete

protected void setAutoDelete(boolean b)

setDurable
```
protected void setDurable(boolean b)
```

isResolvedAfter

public boolean isResolvedAfter(long time)

getRejectBehaviour
```
public RejectBehaviour getRejectBehaviour()
```
This option is only applicable for 0-8/0-9/0-9-1 protocols connection
It tells the client to delegate the requeue/DLQ decision to the server .If this option is not specified, the messages won't be moved to the DLQ (or dropped) when delivery count exceeds the maximum.

Returns:
destination reject behaviour

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable
Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable
Throws:: IOException; ClassNotFoundException

Class AMQDestination

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUEUE_TYPE

TOPIC_TYPE

UNKNOWN_TYPE

Constructor Detail

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

AMQDestination

Method Detail

setExclusive

getAddrHelper

setAddrHelper

getName

setName

neverDeclare

getDefaultDestSyntax

getDestType

stripSyntaxPrefix

parseDestinationString

getInfoFromBindingURL

setDestinationString

getDestinationString

getDestSyntax

setDestSyntax

getEncodedName

isDurable

getExchangeName

getExchangeClass

isExchangeDurable

isExchangeAutoDelete

isExchangeInternal

isTopic

isQueue

getQueueName

getAMQQueueName

setQueueName

getRoutingKey

getBindingKeys

isExclusive

isAutoDelete

isNameRequired

toString

isCheckedForQueueBinding

setCheckedForQueueBinding

isExchangeExistsChecked

setExchangeExistsChecked

toURL

equals

hashCode

getConsumerArguments

getReference

createDestination

createDestination

getAddress

setAddress

getAddressType

setAddressType

getAddressName

setAddressName

getSubject

setSubject

getCreate

setCreate

getAssert

setAssert