DistributedQueue (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.blueprint.jms.DistributedDestination
- - oracle.fmwplatform.envspec.model.blueprint.jms.DistributedQueue

```
public class DistributedQueue
extends DistributedDestination
```
A DistributedQueue is a WebLogic JMS Distributed Queue.

Since:

12.2.2.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JMS_DISTRIBUTED_QUEUE_MEMBER_TOKEN` The alias token used in the alias' WLST path for replacing with the Distributed Queue Member name.
`static String`	`JMS_DISTRIBUTED_QUEUE_TOKEN` The alias token used in the alias' WLST path for replacing with the Distributed Queue name.
`protected List<DistributedQueueMember>`	`members`

Fields inherited from class oracle.fmwplatform.envspec.model.blueprint.jms.DistributedDestination
id, jndiName, loadBalancingPolicy, localJndiName, name, notes, safExportPolicy, unitOfOrderRouting

Constructor Summary

Constructors
Constructor and Description

DistributedQueue()

Constructors
Constructor and Description
`DistributedQueue()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addMember(DistributedQueueMember member)` Add a member to the distributed queue.
`Integer`	`getForwardDelay()` Get the forwarding delay.
`DistributedQueueMember`	`getMember(String id)` Get the specified member of the distributed queue.
`List<DistributedQueueMember>`	`getMembers()` Get the list of members of the distributed queue.
`Boolean`	`getResetDeliveryCountOnForward()` Get whether or not to reset the delivery count when forwarding a message.
`DistributedQueue`	`setForwardDelay(Integer forwardDelay)` Set the forwarding delay.
`DistributedQueue`	`setId(String id)` Set the id.
`DistributedQueue`	`setJndiName(String jndiName)` Set the JNDI name.
`DistributedQueue`	`setLoadBalancingPolicy(LoadBalancingPolicy loadBalancingPolicy)` Set the load-balancing policy.
`DistributedQueue`	`setLocalJndiName(String localJndiName)` Set the local JNDI name.
`DistributedQueue`	`setName(String name)` Set the name.
`DistributedQueue`	`setNotes(String notes)` Set the notes.
`DistributedQueue`	`setResetDeliveryCountOnForward(Boolean resetDeliveryCountOnForward)` Set whether or not to reset the delivery count when forwarding a message.
`DistributedQueue`	`setSafExportPolicy(SAFExportPolicy safExportPolicy)` Set the SAF export policy.
`DistributedQueue`	`setUnitOfOrderRouting(UnitOfOrderRouting unitOfOrderRouting)` Set the unit of order routing setting.
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

Methods inherited from class oracle.fmwplatform.envspec.model.blueprint.jms.DistributedDestination
getId, getJndiName, getLoadBalancingPolicy, getLocalJndiName, getName, getNotes, getSafExportPolicy, getUnitOfOrderRouting

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

- Field Detail
  - JMS_DISTRIBUTED_QUEUE_TOKEN
```
public static final String JMS_DISTRIBUTED_QUEUE_TOKEN
```
    The alias token used in the alias' WLST path for replacing with the Distributed Queue name.
    
    See Also:
    
    Constant Field Values
  - JMS_DISTRIBUTED_QUEUE_MEMBER_TOKEN
```
public static final String JMS_DISTRIBUTED_QUEUE_MEMBER_TOKEN
```
    The alias token used in the alias' WLST path for replacing with the Distributed Queue Member name.
    
    See Also:
    
    Constant Field Values
  - members
```
protected List<DistributedQueueMember> members
```
- Constructor Detail
  - DistributedQueue
```
public DistributedQueue()
```
- Method Detail
  - getForwardDelay
```
public Integer getForwardDelay()
```
    Get the forwarding delay.
    
    Returns:
    
    the forwarding delay
  - setForwardDelay
```
public DistributedQueue setForwardDelay(Integer forwardDelay)
```
    Set the forwarding delay.
    
    Parameters:
    
    forwardDelay - the new value
    
    Returns:
    
    the current DistributedQueue object
  - getResetDeliveryCountOnForward
```
public Boolean getResetDeliveryCountOnForward()
```
    Get whether or not to reset the delivery count when forwarding a message.
    
    Returns:
    
    whether or not to reset the delivery count when forwarding a message
  - setResetDeliveryCountOnForward
```
public DistributedQueue setResetDeliveryCountOnForward(Boolean resetDeliveryCountOnForward)
```
    Set whether or not to reset the delivery count when forwarding a message.
    
    Parameters:
    
    resetDeliveryCountOnForward - the new value
    
    Returns:
    
    the current DistributedQueue object
  - setId
```
public DistributedQueue setId(String id)
```
    Set the id.
    
    Overrides:
    
    setId in class DistributedDestination
    
    Parameters:
    
    id - the new id
    
    Returns:
    
    the current DistributedDestination object
  - setJndiName
```
public DistributedQueue setJndiName(String jndiName)
```
    Set the JNDI name.
    
    Overrides:
    
    setJndiName in class DistributedDestination
    
    Parameters:
    
    jndiName - the new JNDI name
    
    Returns:
    
    the current DistributedDestination object
  - setLoadBalancingPolicy
```
public DistributedQueue setLoadBalancingPolicy(LoadBalancingPolicy loadBalancingPolicy)
```
    Set the load-balancing policy.
    
    Overrides:
    
    setLoadBalancingPolicy in class DistributedDestination
    
    Parameters:
    
    loadBalancingPolicy - the new load-balancing policy
    
    Returns:
    
    the current DistributedDestination object
  - setLocalJndiName
```
public DistributedQueue setLocalJndiName(String localJndiName)
```
    Set the local JNDI name.
    
    Overrides:
    
    setLocalJndiName in class DistributedDestination
    
    Parameters:
    
    localJndiName - the new local JNDI name
    
    Returns:
    
    the current DistributedDestination object
  - setName
```
public DistributedQueue setName(String name)
```
    Set the name.
    
    Overrides:
    
    setName in class DistributedDestination
    
    Parameters:
    
    name - the new name
    
    Returns:
    
    the current DistributedDestination object
  - setNotes
```
public DistributedQueue setNotes(String notes)
```
    Set the notes.
    
    Overrides:
    
    setNotes in class DistributedDestination
    
    Parameters:
    
    notes - the new notes
    
    Returns:
    
    the current DistributedDestination object
  - setSafExportPolicy
```
public DistributedQueue setSafExportPolicy(SAFExportPolicy safExportPolicy)
```
    Set the SAF export policy.
    
    Overrides:
    
    setSafExportPolicy in class DistributedDestination
    
    Parameters:
    
    safExportPolicy - the new SAF export policy
    
    Returns:
    
    the current DistributedDestination object
  - setUnitOfOrderRouting
```
public DistributedQueue setUnitOfOrderRouting(UnitOfOrderRouting unitOfOrderRouting)
```
    Set the unit of order routing setting.
    
    Overrides:
    
    setUnitOfOrderRouting in class DistributedDestination
    
    Parameters:
    
    unitOfOrderRouting - the new value
    
    Returns:
    
    the current DistributedDestination object
  - addMember
```
public boolean addMember(DistributedQueueMember member)
```
    Add a member to the distributed queue.
    
    Parameters:
    
    member - the member to add
    
    Returns:
    
    whether or not the member was added
  - getMember
```
public DistributedQueueMember getMember(String id)
```
    Get the specified member of the distributed queue.
    
    Parameters:
    
    id - the member id
    
    Returns:
    
    the specified member or null, if the member was not found
  - getMembers
```
public List<DistributedQueueMember> getMembers()
```
    Get the list of members of the distributed queue.
    
    Returns:
    
    the list of members
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Overrides:
    
    toXmlCompactString in class DistributedDestination
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toXmlString in class DistributedDestination
    
    Returns:
    
    a string representation of the object in XML format
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Overrides:
    
    toJsonCompactString in class DistributedDestination
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Overrides:
    
    toJsonString in class DistributedDestination
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Overrides:
    
    toCompactString in class DistributedDestination
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class DistributedDestination
    
    Returns:
    
    a string representation of the object in XML format

Class DistributedQueue

Field Summary

Fields inherited from class oracle.fmwplatform.envspec.model.blueprint.jms.DistributedDestination

Constructor Summary

Method Summary

Methods inherited from class oracle.fmwplatform.envspec.model.blueprint.jms.DistributedDestination

Methods inherited from class java.lang.Object

Field Detail

JMS_DISTRIBUTED_QUEUE_TOKEN

JMS_DISTRIBUTED_QUEUE_MEMBER_TOKEN

members

Constructor Detail

DistributedQueue

Method Detail

getForwardDelay

setForwardDelay

getResetDeliveryCountOnForward

setResetDeliveryCountOnForward

setId

setJndiName

setLoadBalancingPolicy

setLocalJndiName

setName

setNotes

setSafExportPolicy

setUnitOfOrderRouting

addMember

getMember

getMembers

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString