Sonic ESB API

com.sonicsw.xq
Interface XQAddressFactory


public interface XQAddressFactory

The XQAddressFactory is used to create XQAddress objects. You can obtain a reference to the XQAddressFactory by invoking getAddressFactory() on an XQContext

See Also:
XQAddress

Method Summary
 XQAddress createAddress(java.lang.String name, int type)
          Create an new XQAddress with the specified name and type.
 XQAddress createAddress(java.lang.String name, java.lang.String type)
          Creates a new XQAddress.
 XQAddress createEndpointAddress(java.lang.String name)
          Create a new Endpoint XQAddress.
 XQProcessAddress createProcessAddress(java.lang.String name)
          Create a new XQProcessAddress.
 XQProcessAddress createProcessAddress(java.lang.String name, java.lang.String step)
          Create a new Process XQProcessAddress.
 XQAddress createServiceAddress(java.lang.String name)
          Create a new Service XQAddress.
 XQAddress getReplyToAddress()
          Get a reference to the singleton replyto address object.
 XQAddress getSelfAddress()
          Get a reference to the self address object.
 XQAddress parseAddress(java.lang.String address)
          Parse the input parameter and create a new XQAdress based on the type of address.
 

Method Detail

createAddress

XQAddress createAddress(java.lang.String name,
                        int type)
                        throws XQAddressNotFoundException
Create an new XQAddress with the specified name and type. Name must be non-null and type must be one of the values defined in XQConstants (XQConstants.ADDRESS_ENDPOINT, XQConstants.ADDRESS_SERVICE or XQConstants.ADDRESS_PROCESS)

Parameters:
name - The name of this address
type - The type of this address
Returns:
the address object
Throws:
XQAddressNotFoundException
See Also:
XQConstants

createAddress

XQAddress createAddress(java.lang.String name,
                        java.lang.String type)
                        throws XQAddressNotFoundException
Creates a new XQAddress. The type parameter must be one of "ENDPOINT", "SERVICE", "PROCESS" or "REPLY_TO".

Parameters:
name - The name of this address
type - The type of this address
Returns:
the address object
Throws:
XQAddressNotFoundException

createEndpointAddress

XQAddress createEndpointAddress(java.lang.String name)
                                throws XQAddressNotFoundException
Create a new Endpoint XQAddress.

Parameters:
name - The name of the Endpoint Address
Returns:
the address object
Throws:
XQAddressNotFoundException

createServiceAddress

XQAddress createServiceAddress(java.lang.String name)
                               throws XQAddressNotFoundException
Create a new Service XQAddress.

Parameters:
name - The name of the Service Address
Returns:
the address object
Throws:
XQAddressNotFoundException

createProcessAddress

XQProcessAddress createProcessAddress(java.lang.String name)
                                      throws XQAddressNotFoundException
Create a new XQProcessAddress.

Parameters:
name - The name of the Process
Returns:
the address object
Throws:
XQAddressNotFoundException

createProcessAddress

XQProcessAddress createProcessAddress(java.lang.String name,
                                      java.lang.String step)
                                      throws XQAddressNotFoundException
Create a new Process XQProcessAddress.

Parameters:
name - The name of the Process
step - The name of the itinerary step to send to
Returns:
the address object
Throws:
XQAddressNotFoundException

getReplyToAddress

XQAddress getReplyToAddress()
Get a reference to the singleton replyto address object. This XQAddress is initialized with name="REPLY_TO" and type ADDRESS_REPLY_TO


getSelfAddress

XQAddress getSelfAddress()
Get a reference to the self address object. This XQAddress is either a service address or an endpoint address.


parseAddress

XQAddress parseAddress(java.lang.String address)
Parse the input parameter and create a new XQAdress based on the type of address.


Sonic ESB API

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