Sonic ESB API

com.sonicsw.xq
Interface XQEnvelopeFactory


public interface XQEnvelopeFactory

An XQEnvelopeFactory is used to create XQEnvelopes.

See Also:
XQEnvelope

Method Summary
 XQEnvelope createDefaultEnvelope()
          Creates an envelope w/ no content destined for the default address.
 XQEnvelope createDefaultEnvelope(XQMessage message)
          Creates an envelope containing the specified message destined for the default address.
 XQEnvelope createFaultEnvelope()
          Creates an envelope w/ no content destined for the fault address.
 XQEnvelope createFaultEnvelope(XQMessage message)
          Creates an envelope containing the specified message destined for the fault address.
 XQEnvelope createSelfAddressedEnvelope()
          Creates an envelope w/ no content destined for the self address, to be sent to the originating service's own service method.
 XQEnvelope createSelfAddressedEnvelope(XQMessage message)
          Creates an envelope containing the specified message destined for the self address, to be sent to the originating service's own service method.
 XQEnvelope createTargetedEnvelope(XQAddress address)
          Creates an envelope w/ no message destined for the specified address.
 XQEnvelope createTargetedEnvelope(XQAddress address, XQMessage message)
          Creates an envelope containing the specified message destined for the specified address.
 

Method Detail

createDefaultEnvelope

XQEnvelope createDefaultEnvelope()
Creates an envelope w/ no content destined for the default address.

Returns:
the newly created XQEnvelope

createDefaultEnvelope

XQEnvelope createDefaultEnvelope(XQMessage message)
Creates an envelope containing the specified message destined for the default address.

Parameters:
message - an XQMessage to add to the envelope on creation
Returns:
the newly created XQEnvelope

createFaultEnvelope

XQEnvelope createFaultEnvelope()
Creates an envelope w/ no content destined for the fault address.

Returns:
the newly created XQEnvelope

createFaultEnvelope

XQEnvelope createFaultEnvelope(XQMessage message)
Creates an envelope containing the specified message destined for the fault address.

Parameters:
message - an XQMessage to add to the envelope on creation
Returns:
the newly created XQEnvelope

createTargetedEnvelope

XQEnvelope createTargetedEnvelope(XQAddress address)
Creates an envelope w/ no message destined for the specified address.

Parameters:
address - the XQAddress to set as the envelope's destination
Returns:
the newly created XQEnvelope

createTargetedEnvelope

XQEnvelope createTargetedEnvelope(XQAddress address,
                                  XQMessage message)
Creates an envelope containing the specified message destined for the specified address.

Parameters:
address - the XQAddress to set as the envelope's destination
message - an XQMessage to add to the envelope on creation
Returns:
the newly created XQEnvelope

createSelfAddressedEnvelope

XQEnvelope createSelfAddressedEnvelope()
Creates an envelope w/ no content destined for the self address, to be sent to the originating service's own service method.

Returns:
the newly created XQEnvelope

createSelfAddressedEnvelope

XQEnvelope createSelfAddressedEnvelope(XQMessage message)
Creates an envelope containing the specified message destined for the self address, to be sent to the originating service's own service method.

Parameters:
message - an XQMessage to add to the envelope on creation
Returns:
the newly created XQEnvelope

Sonic ESB API

Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
HTML formatted on 13-Mar-2012.