001: /*
002: * BEGIN_HEADER - DO NOT EDIT
003: *
004: * The contents of this file are subject to the terms
005: * of the Common Development and Distribution License
006: * (the "License"). You may not use this file except
007: * in compliance with the License.
008: *
009: * You can obtain a copy of the license at
010: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
011: * See the License for the specific language governing
012: * permissions and limitations under the License.
013: *
014: * When distributing Covered Code, include this CDDL
015: * HEADER in each file and include the License file at
016: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
017: * If applicable add the following below this CDDL HEADER,
018: * with the fields enclosed by brackets "[]" replaced with
019: * your own identifying information: Portions Copyright
020: * [year] [name of copyright owner]
021: */
022:
023: /*
024: * @(#)DeliveryChannel.java
025: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026: *
027: * END_HEADER - DO NOT EDIT
028: */
029: package javax.jbi.messaging;
030:
031: import javax.jbi.servicedesc.ServiceEndpoint;
032:
033: import javax.xml.namespace.QName;
034:
035: /** Bi-directional communication channel used to interact with the Normalized
036: * Message Service.
037: *
038: * @author JSR208 Expert Group
039: */
040: public interface DeliveryChannel {
041: /** Closes the delivery channel, halting all message traffic.
042: * @throws MessagingException fatal error while closing channel.
043: */
044: void close() throws MessagingException;
045:
046: /** Create a message exchange factory. This factory will create exchange
047: * instances with all appropriate properties set to null.
048: * @return a message exchange factory
049: */
050: MessageExchangeFactory createExchangeFactory();
051:
052: /** Create a message exchange factory for the given interface name.
053: * @param interfaceName name of the interface for which all exchanges
054: * created by the returned factory will be set
055: * @return an exchange factory that will create exchanges for the given
056: * interface; must be non-null
057: */
058: MessageExchangeFactory createExchangeFactory(QName interfaceName);
059:
060: /** Create a message exchange factory for the given service name.
061: * @param serviceName name of the service for which all exchanges
062: * created by the returned factory will be set
063: * @return an exchange factory that will create exchanges for the given
064: * service; must be non-null
065: */
066: MessageExchangeFactory createExchangeFactoryForService(
067: QName serviceName);
068:
069: /** Create a message exchange factory for the given endpoint.
070: * @param endpoint endpoint for which all exchanges created by the
071: * returned factory will be set for
072: * @return an exchange factory that will create exchanges for the
073: * given endpoint
074: */
075: MessageExchangeFactory createExchangeFactory(
076: ServiceEndpoint endpoint);
077:
078: /** Blocking call used to service a MessageExchange instance which has
079: * been initiated by another component. This method supports concurrent
080: * invocation for multi-threaded environments.
081: * @return mesage exchange instance
082: * @throws MessagingException failed to accept
083: */
084: MessageExchange accept() throws MessagingException;
085:
086: /** Identical to accept(), but returns after specified interval even if
087: * a message exchange is unavailable.
088: * @param timeout time to wait in milliseconds
089: * @return mesage exchange instance or null if timeout is reached
090: * @throws MessagingException failed to accept
091: */
092: MessageExchange accept(long timeout) throws MessagingException;
093:
094: /** Routes a MessageExchange instance through the Normalized Message Service
095: * to the appropriate servicing component. This method supports concurrent
096: * invocation for multi-threaded environments.
097: * @param exchange message exchange to send
098: * @throws MessagingException unable to send exchange
099: */
100: void send(MessageExchange exchange) throws MessagingException;
101:
102: /** Routes a MessageExchange instance through the Normalized Message Service
103: * to the appropriate servicing component, blocking until the exchange is
104: * returned. This method supports concurrent invocation for multi-threaded
105: * environments.
106: * @param exchange message exchange to send
107: * @return true if the exchange has been processed and returned by the
108: * servicing component, false otherwise.
109: * @throws MessagingException unable to send exchange
110: */
111: boolean sendSync(MessageExchange exchange)
112: throws MessagingException;
113:
114: /** Routes a MessageExchange instance through the Normalized Message Service
115: * to the appropriate servicing component, blocking until the specified
116: * timeout is reached. This method supports concurrent invocation for
117: * multi-threaded environments.
118: * @param exchange message exchange to send
119: * @param timeout time to wait in milliseconds
120: * @return true if the exchange has been processed and returned by the
121: * servicing component, false in the case of timeout.
122: * @throws MessagingException unable to send exchange
123: */
124: boolean sendSync(MessageExchange exchange, long timeout)
125: throws MessagingException;
126: }
|