com.sun.jbi.messaging

Class DeliveryChannelImpl

java.lang.Object

com.sun.jbi.messaging.DeliveryChannelImpl

All Implemented Interfaces:

ChannelStatistics, DeliveryChannel

public class DeliveryChannelImpl
extends Object
implements DeliveryChannel, ChannelStatistics

Implementation of DeliveryChannel interface.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REG_NOTIFICATION_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
MessageExchange	accept() Blocking call which samples the channel at a pre-determined interval for available exchanges.
MessageExchange	accept(long timeout)
RegisteredEndpoint	activateEndpoint(QName service, String endpoint) Activate an endpoint.
boolean	activeReference(MessageExchange me) Check if a MessageExchange is being tracked.
void	addServiceConnection(QName serviceLink, String endpointLink, QName service, String endpoint, String type)
void	close() Close the channel.
ServiceEndpoint	createEndpoint(QName service, String endpoint)
MessageExchange	createExchange(URI pattern, String id)
MessageExchangeFactory	createExchangeFactory() Create a message exchange factory.
MessageExchangeFactory	createExchangeFactory(QName interfaceName) Create a message exchange factory for the given interface name.
MessageExchangeFactory	createExchangeFactory(ServiceEndpoint endpoint) Create a message exchange factory for the given endpoint.
MessageExchangeFactory	createExchangeFactoryForService(QName serviceName) Create a message exchange factory for the given service name.
void	deactivateEndpoint(ServiceEndpoint ref) Used by a BC to deactivate an endpoint which it has registered.
void	deregisterExternalEndpoint(ServiceEndpoint externalEndpoint) Deregisters the specified external endpoint with the NMR.
ClassLoader	getClassLoader()
String[]	getConsumingEndpointNames()
ServiceEndpoint	getEndpoint(QName service, String name) Get the service description for the named endpoint, if any exists.
Document	getEndpointDescriptor(ServiceEndpoint endpoint) Uses the owner id of the reference to query the appopriate channel.
String[]	getEndpointNames()
ServiceEndpoint[]	getEndpoints()
ServiceEndpoint[]	getEndpoints(QName interfaceName) Queries the NMR for active endpoints that implement the given interface.
ServiceEndpoint[]	getEndpointsForService(QName service) Used by ComponentContext.getEndpointsForService().
EndpointStatistics	getEndpointStatistics(String name)
ServiceEndpoint[]	getExternalEndpoints(QName interfaceName) Queries the NMR for external endpoints that implement the specified interface name.
ServiceEndpoint[]	getExternalEndpointsForService(QName serviceName) Queries the NMR for external endpoints that are part of the specified service.
String	getName()
CompositeData	getStatistics()
boolean	isClosed()
boolean	isExchangeOkay(MessageExchange me)
boolean	isTransactional()
void	registerExternalEndpoint(ServiceEndpoint externalEndpoint) Registers the specified external endpoint with the NMR.
void	registerXAResource(XAResource resource) Register an XAResource
void	removeServiceConnection(QName serviceLink, String endpointLink, QName service, String endpoint)
ServiceEndpoint	resolveEndpointReference(DocumentFragment endpointReference) Resolves the specified endpoint reference into a service endpoint.
void	send(MessageExchange exchange) Defers routing to the message service.
boolean	sendLast(MessageExchange exchange) Defers routing to the message service.
boolean	sendSync(MessageExchange exchange)
boolean	sendSync(MessageExchange exchange, long timeout)
void	setEndpointListener(EndpointListener listener)
void	setExchangeIdGenerator(ExchangeIdGenerator generator)
void	setTimeoutListener(TimeoutListener timeout)
void	setTransactional(boolean transactional)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REG_NOTIFICATION_TYPE

public static final String REG_NOTIFICATION_TYPE

See Also:

Constant Field Values

Method Detail

accept

public MessageExchange accept()
                       throws MessagingException

Blocking call which samples the channel at a pre-determined interval for available exchanges.

Specified by:

accept in interface DeliveryChannel

Returns:

message exchange, or null if channel was interrupted.

Throws:

MessagingException - error while reading exchange.

accept

public MessageExchange accept(long timeout)
                       throws MessagingException

Specified by:

accept in interface DeliveryChannel

Throws:

MessagingException

send

public void send(MessageExchange exchange)
          throws MessagingException

Defers routing to the message service.

Specified by:

send in interface DeliveryChannel

Throws:

MessagingException

sendLast

public boolean sendLast(MessageExchange exchange)
                 throws MessagingException

Defers routing to the message service.

Throws:

MessagingException

sendSync

public boolean sendSync(MessageExchange exchange)
                 throws MessagingException

Specified by:

sendSync in interface DeliveryChannel

Throws:

MessagingException

sendSync

public boolean sendSync(MessageExchange exchange,
               long timeout)
                 throws MessagingException

Specified by:

sendSync in interface DeliveryChannel

Throws:

MessagingException

createExchangeFactory

public MessageExchangeFactory createExchangeFactory()

Create a message exchange factory. This factory will create exchange instances with all appropriate properties set to null.

Specified by:

createExchangeFactory in interface DeliveryChannel

Returns:

a message exchange factory

createExchangeFactory

public MessageExchangeFactory createExchangeFactory(QName interfaceName)

Create a message exchange factory for the given interface name.

Specified by:

createExchangeFactory in interface DeliveryChannel

Parameters:

interfaceName - name of the interface for which all exchanges created by the returned factory will be set

Returns:

name of the interface for which all exchanges created by the returned factory will be set

createExchangeFactoryForService

public MessageExchangeFactory createExchangeFactoryForService(QName serviceName)

Create a message exchange factory for the given service name.

Specified by:

createExchangeFactoryForService in interface DeliveryChannel

Parameters:

serviceName - name of the service for which all exchanges created by the returned factory will be set

Returns:

an exchange factory that will create exchanges for the given service; must be non-null

createExchangeFactory

public MessageExchangeFactory createExchangeFactory(ServiceEndpoint endpoint)

Create a message exchange factory for the given endpoint.

Specified by:

createExchangeFactory in interface DeliveryChannel

Parameters:

endpoint - endpoint for which all exchanges created by the returned factory will be set for

Returns:

an exchange factory that will create exchanges for the given endpoint

registerXAResource

public void registerXAResource(XAResource resource)

Register an XAResource

Parameters:

resource - to be added.

activateEndpoint

public RegisteredEndpoint activateEndpoint(QName service,
                                  String endpoint)
                                    throws MessagingException

Activate an endpoint.

Parameters:

service - QName of service

endpoint - NCName of endpoint

Returns:

activated endpoint

Throws:

MessagingException - failed to register endpoint

deactivateEndpoint

public void deactivateEndpoint(ServiceEndpoint ref)
                        throws MessagingException

Used by a BC to deactivate an endpoint which it has registered.

Parameters:

ref - endpoint reference

Throws:

MessagingException - failed to deactivate endpoint.

registerExternalEndpoint

public void registerExternalEndpoint(ServiceEndpoint externalEndpoint)
                              throws MessagingException

Registers the specified external endpoint with the NMR. This indicates to the NMR that the specified endpoint is used as a proxy for external service consumers to access an internal service by the same name.

Throws:

MessagingException

deregisterExternalEndpoint

public void deregisterExternalEndpoint(ServiceEndpoint externalEndpoint)
                                throws MessagingException

Deregisters the specified external endpoint with the NMR. This indicates to the NMR that external service consumers can no longer access the internal service by this name.

Throws:

MessagingException

getEndpoint

public ServiceEndpoint getEndpoint(QName service,
                          String name)

Get the service description for the named endpoint, if any exists.

Parameters:

service - the qualified name of the endpoint's service.

getEndpointDescriptor

public Document getEndpointDescriptor(ServiceEndpoint endpoint)
                               throws MessagingException

Uses the owner id of the reference to query the appopriate channel.

Throws:

MessagingException

getExternalEndpoints

public ServiceEndpoint[] getExternalEndpoints(QName interfaceName)

Queries the NMR for external endpoints that implement the specified interface name.

getEndpoints

public ServiceEndpoint[] getEndpoints(QName interfaceName)

Queries the NMR for active endpoints that implement the given interface. This will return the endpoints for all services and endpoints that implement the named interface (portType in WSDL 1.1). This method does NOT include external endpoints (those registered using registerExternalEndpoint(ServiceEndpoint)).

Parameters:

interfaceName - qualified name of interface/portType that is implemented by the endpoint

Returns:

ServiceEndpoint[] list of available endpoints for the specified interface name; potentially zero-length.

getEndpoints

public ServiceEndpoint[] getEndpoints()

getExternalEndpointsForService

public ServiceEndpoint[] getExternalEndpointsForService(QName serviceName)

Queries the NMR for external endpoints that are part of the specified service.

resolveEndpointReference

public ServiceEndpoint resolveEndpointReference(DocumentFragment endpointReference)

Resolves the specified endpoint reference into a service endpoint. This is called by the component when it has an endpoint reference that it needs to resolve into a service endpoint.

getEndpointsForService

public ServiceEndpoint[] getEndpointsForService(QName service)

Used by ComponentContext.getEndpointsForService().

addServiceConnection

public void addServiceConnection(QName serviceLink,
                        String endpointLink,
                        QName service,
                        String endpoint,
                        String type)
                          throws MessagingException

Throws:

MessagingException

removeServiceConnection

public void removeServiceConnection(QName serviceLink,
                           String endpointLink,
                           QName service,
                           String endpoint)

setTransactional

public void setTransactional(boolean transactional)

isTransactional

public final boolean isTransactional()

getClassLoader

public ClassLoader getClassLoader()

close

public void close()
           throws MessagingException

Close the channel.

Specified by:

close in interface DeliveryChannel

Throws:

MessagingException - failure during close.

isClosed

public boolean isClosed()

activeReference

public boolean activeReference(MessageExchange me)

Check if a MessageExchange is being tracked.

setEndpointListener

public void setEndpointListener(EndpointListener listener)

setTimeoutListener

public void setTimeoutListener(TimeoutListener timeout)

createExchange

public MessageExchange createExchange(URI pattern,
                             String id)
                               throws MessagingException

Throws:

MessagingException

createEndpoint

public ServiceEndpoint createEndpoint(QName service,
                             String endpoint)
                               throws MessagingException

Throws:

MessagingException

setExchangeIdGenerator

public void setExchangeIdGenerator(ExchangeIdGenerator generator)

isExchangeOkay

public boolean isExchangeOkay(MessageExchange me)

getName

public String getName()

Specified by:

getName in interface ChannelStatistics

getEndpointNames

public String[] getEndpointNames()

Specified by:

getEndpointNames in interface ChannelStatistics

getConsumingEndpointNames

public String[] getConsumingEndpointNames()

Specified by:

getConsumingEndpointNames in interface ChannelStatistics

getEndpointStatistics

public EndpointStatistics getEndpointStatistics(String name)

Specified by:

getEndpointStatistics in interface ChannelStatistics

getStatistics

public CompositeData getStatistics()

Specified by:

getStatistics in interface ChannelStatistics

toString

public String toString()

Overrides:

toString in class Object