Apache CXF API

org.apache.cxf.ws.rm
Class RMManager

java.lang.Object
  extended by org.apache.cxf.ws.rm.RMManager

public class RMManager
extends Object


Field Summary
static String WSRM_ACKNOWLEDGEMENT_INTERVAL_PROPERTY
          Message contextual property giving WS-ReliableMessaging acknowledgement interval (Long).
static String WSRM_EXPONENTIAL_BACKOFF_PROPERTY
          Message contextual property giving WS-ReliableMessaging exponential backoff flag (Boolean).
static String WSRM_INACTIVITY_TIMEOUT_PROPERTY
          Message contextual property giving WS-ReliableMessaging inactivity timeout (Long).
static String WSRM_LAST_MESSAGE_PROPERTY
          Message contextual property giving the last message flag (Boolean).
static String WSRM_RETRANSMISSION_INTERVAL_PROPERTY
          Message contextual property giving WS-ReliableMessaging base retransmission interval (Long).
static String WSRM_VERSION_PROPERTY
          Message contextual property giving WS-ReliableMessaging namespace.
static String WSRM_WSA_VERSION_PROPERTY
          Message contextual property giving addressing namespace to be used by WS-RM implementation.
 
Constructor Summary
RMManager()
           
 
Method Summary
 void clientCreated(Client client)
           
 void clientDestroyed(Client client)
           
 BindingFaultFactory getBindingFaultFactory(Binding binding)
           
 Bus getBus()
           
 RMConfiguration getConfiguration()
          Get base configuration for manager.
 Destination getDestination(Message message)
           
 DestinationPolicyType getDestinationPolicy()
           
 RMConfiguration getEffectiveConfiguration(Message msg)
          Get configuration after applying policies.
 SequenceIdentifierGenerator getIdGenerator()
           
 RMEndpoint getReliableEndpoint(Message message)
           
 RetransmissionQueue getRetransmissionQueue()
           
 PhaseInterceptorChain getRetransmitChain(Message msg)
          Get interceptor chain for retransmitting a message.
 SourceSequence getSequence(Identifier inSeqId, Message message, AddressingProperties maps)
           
 Source getSource(Message message)
           
 SourcePolicyType getSourcePolicy()
           
 RMStore getStore()
           
 Timer getTimer()
           
 void init(Bus b)
           
 void initializeInterceptorChain(Message msg)
          Clones and saves the interceptor chain the first time this is called, so that it can be used for retransmission.
 void setBus(Bus b)
           
 void setConfiguration(RMConfiguration configuration)
           
 void setDeliveryAssurance(DeliveryAssuranceType dat)
           
 void setDestinationPolicy(DestinationPolicyType destinationPolicy)
           
 void setIdGenerator(SequenceIdentifierGenerator generator)
           
 void setRetransmissionQueue(RetransmissionQueue rq)
           
 void setRM10AddressingNamespace(RM10AddressingNamespaceType addrns)
           
 void setRMAssertion(RMAssertion rma)
           
 void setRMNamespace(String uri)
           
 void setSourcePolicy(SourcePolicyType sp)
           
 void setStore(RMStore s)
           
 void shutdown()
           
 void startServer(Server server)
           
 void stopServer(Server server)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WSRM_VERSION_PROPERTY

public static final String WSRM_VERSION_PROPERTY
Message contextual property giving WS-ReliableMessaging namespace.

See Also:
Constant Field Values

WSRM_WSA_VERSION_PROPERTY

public static final String WSRM_WSA_VERSION_PROPERTY
Message contextual property giving addressing namespace to be used by WS-RM implementation.

See Also:
Constant Field Values

WSRM_LAST_MESSAGE_PROPERTY

public static final String WSRM_LAST_MESSAGE_PROPERTY
Message contextual property giving the last message flag (Boolean).

See Also:
Constant Field Values

WSRM_INACTIVITY_TIMEOUT_PROPERTY

public static final String WSRM_INACTIVITY_TIMEOUT_PROPERTY
Message contextual property giving WS-ReliableMessaging inactivity timeout (Long).

See Also:
Constant Field Values

WSRM_RETRANSMISSION_INTERVAL_PROPERTY

public static final String WSRM_RETRANSMISSION_INTERVAL_PROPERTY
Message contextual property giving WS-ReliableMessaging base retransmission interval (Long).

See Also:
Constant Field Values

WSRM_EXPONENTIAL_BACKOFF_PROPERTY

public static final String WSRM_EXPONENTIAL_BACKOFF_PROPERTY
Message contextual property giving WS-ReliableMessaging exponential backoff flag (Boolean).

See Also:
Constant Field Values

WSRM_ACKNOWLEDGEMENT_INTERVAL_PROPERTY

public static final String WSRM_ACKNOWLEDGEMENT_INTERVAL_PROPERTY
Message contextual property giving WS-ReliableMessaging acknowledgement interval (Long).

See Also:
Constant Field Values
Constructor Detail

RMManager

public RMManager()
Method Detail

startServer

public void startServer(Server server)

stopServer

public void stopServer(Server server)

clientCreated

public void clientCreated(Client client)

clientDestroyed

public void clientDestroyed(Client client)

setRMNamespace

public void setRMNamespace(String uri)

setRM10AddressingNamespace

public void setRM10AddressingNamespace(RM10AddressingNamespaceType addrns)

getBus

public Bus getBus()

setBus

public void setBus(Bus b)

getStore

public RMStore getStore()

setStore

public void setStore(RMStore s)

getRetransmissionQueue

public RetransmissionQueue getRetransmissionQueue()

setRetransmissionQueue

public void setRetransmissionQueue(RetransmissionQueue rq)

getIdGenerator

public SequenceIdentifierGenerator getIdGenerator()

setIdGenerator

public void setIdGenerator(SequenceIdentifierGenerator generator)

getTimer

public Timer getTimer()

getBindingFaultFactory

public BindingFaultFactory getBindingFaultFactory(Binding binding)

setDeliveryAssurance

public void setDeliveryAssurance(DeliveryAssuranceType dat)
Parameters:
dat - The deliveryAssurance to set.

getDestinationPolicy

public DestinationPolicyType getDestinationPolicy()
Returns:
Returns the destinationPolicy.

setDestinationPolicy

public void setDestinationPolicy(DestinationPolicyType destinationPolicy)
Parameters:
destinationPolicy - The destinationPolicy to set.

getConfiguration

public RMConfiguration getConfiguration()
Get base configuration for manager. This needs to be modified by endpoint policies to get the effective configuration.

Returns:
configuration (non-null)

setConfiguration

public void setConfiguration(RMConfiguration configuration)
Parameters:
configuration - (non-null)

getEffectiveConfiguration

public RMConfiguration getEffectiveConfiguration(Message msg)
Get configuration after applying policies.

Parameters:
msg -
Returns:
configuration (non-null)

setRMAssertion

public void setRMAssertion(RMAssertion rma)
Parameters:
rma - The rmAssertion to set.

getSourcePolicy

public SourcePolicyType getSourcePolicy()
Returns:
Returns the sourcePolicy.

setSourcePolicy

public void setSourcePolicy(SourcePolicyType sp)
Parameters:
sp - The sourcePolicy to set.

getReliableEndpoint

public RMEndpoint getReliableEndpoint(Message message)
                               throws RMException
Throws:
RMException

getDestination

public Destination getDestination(Message message)
                           throws RMException
Throws:
RMException

getSource

public Source getSource(Message message)
                 throws RMException
Throws:
RMException

getSequence

public SourceSequence getSequence(Identifier inSeqId,
                                  Message message,
                                  AddressingProperties maps)
                           throws RMException
Throws:
RMException

shutdown

@PreDestroy
public void shutdown()

init

public void init(Bus b)

initializeInterceptorChain

public void initializeInterceptorChain(Message msg)
Clones and saves the interceptor chain the first time this is called, so that it can be used for retransmission. Calls after the first are ignored.

Parameters:
msg -

getRetransmitChain

public PhaseInterceptorChain getRetransmitChain(Message msg)
Get interceptor chain for retransmitting a message.

Returns:
chain (null if none set)

Apache CXF API

Apache CXF