com.oracle.webservices.oracle_internal_api.rm
Class OutboundDelivered

java.lang.Object
  extended by com.oracle.webservices.api.message.BasePropertySet
      extended by com.oracle.webservices.oracle_internal_api.rm.OutboundDelivered
All Implemented Interfaces:
PropertySet

public abstract class OutboundDelivered
extends BasePropertySet

OutboundDelivered is created by a user of client-side (i.e., RMS) RM.

It is passed as a PropertySet to com.oracle.webservices.api.disi.DispatcherRequest#request.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.oracle.webservices.api.message.BasePropertySet
BasePropertySet.Accessor, BasePropertySet.PropertyMap, BasePropertySet.PropertyMapEntry
 
Nested classes/interfaces inherited from interface com.oracle.webservices.api.message.PropertySet
PropertySet.Property
 
Field Summary
static String DELIVERED_PROPERTY
          Key for delivered property
static String MESSAGE_IDENTITY_PROPERTY
          Key for message identity property
 
Constructor Summary
OutboundDelivered()
           
 
Method Summary
abstract  Boolean getDelivered()
           
abstract  String getMessageIdentity()
           
protected  BasePropertySet.PropertyMap getPropertyMap()
          Map representing the Fields and Methods annotated with PropertySet.Property.
abstract  void setDelivered(Boolean accept)
          When the RMS receives an ACK from the RMD for the request message instance that contains this com.oracle.webserivces.api.message.Property, then the RMS will call #delivered(true).
 
Methods inherited from class com.oracle.webservices.api.message.BasePropertySet
asMap, containsKey, createEntrySet, createMapView, createView, get, mapAllowsAdditionalProperties, parse, put, remove, supports
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DELIVERED_PROPERTY

public static final String DELIVERED_PROPERTY
Key for delivered property

See Also:
getDelivered(), setDelivered(java.lang.Boolean), Constant Field Values

MESSAGE_IDENTITY_PROPERTY

public static final String MESSAGE_IDENTITY_PROPERTY
Key for message identity property

See Also:
getMessageIdentity(), Constant Field Values
Constructor Detail

OutboundDelivered

public OutboundDelivered()
Method Detail

getDelivered

public abstract Boolean getDelivered()
Returns:
The value set by setDelivered(java.lang.Boolean) or null if setDelivered(java.lang.Boolean) has not been called.
See Also:
DELIVERED_PROPERTY, setDelivered(java.lang.Boolean)

setDelivered

public abstract void setDelivered(Boolean accept)

When the RMS receives an ACK from the RMD for the request message instance that contains this com.oracle.webserivces.api.message.Property, then the RMS will call #delivered(true).

If max retries, timeouts or com.oracle.webservices.api.disi.ClientResponseTransport#fail is called with an non RMRetryException exception, then the RMS calls #delivered(false).

See Also:
DELIVERED_PROPERTY, getDelivered()

getMessageIdentity

public abstract String getMessageIdentity()
Returns:
The identity of the message.
Throws:
RuntimeException - if String is longer than 256 characters.
See Also:
MESSAGE_IDENTITY_PROPERTY

getPropertyMap

protected BasePropertySet.PropertyMap getPropertyMap()
Description copied from class: BasePropertySet
Map representing the Fields and Methods annotated with PropertySet.Property. Model of PropertySet class.

At the end of the derivation chain this method just needs to be implemented as:

 private static final PropertyMap model;
 static {
   model = parse(MyDerivedClass.class);
 }
 protected PropertyMap getPropertyMap() {
   return model;
 }
 

Specified by:
getPropertyMap in class BasePropertySet


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.