org.wildfly.transaction.client.spi

Interface RemoteTransactionProvider

All Known Implementing Classes:

RemotingTransactionProvider

public interface RemoteTransactionProvider

A remote transaction transport provider.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
RemoteTransactionPeer	getPeerHandle(URI location) Get a handle for a specific peer.
default RemoteTransactionPeer	getPeerHandleForXa(URI location) Get a handle for a specific peer for an XA operation.
default <T> T	getProviderInterface(Class<T> clazz) Get the provider interface with the given type for this peer.
boolean	supportsScheme(String scheme) Determine whether the provider supports the given URI scheme.

Method Detail

getPeerHandle

RemoteTransactionPeer getPeerHandle(URI location)
                             throws SystemException

Get a handle for a specific peer.

Parameters:

location - the peer location

Returns:

the handle, or null if this provider does not support this location

Throws:

SystemException - if handle acquisition has failed

getPeerHandleForXa

default RemoteTransactionPeer getPeerHandleForXa(URI location)
                                          throws XAException

Get a handle for a specific peer for an XA operation. Identical to getPeerHandle(URI) except that an XAException is thrown in case of error instead of SystemException.

Parameters:

location - the peer location (not null)

Returns:

the handle, or null if this provider does not support this location

Throws:

XAException

supportsScheme

boolean supportsScheme(String scheme)

Determine whether the provider supports the given URI scheme.

Parameters:

scheme - the URI scheme (not null)

Returns:

true if the scheme is supported, false otherwise

getProviderInterface

default <T> T getProviderInterface(Class<T> clazz)

Get the provider interface with the given type for this peer.

Type Parameters:

T - the provider interface type

Parameters:

clazz - the provider interface type class (must not be null)

Returns:

the provider interface with the given type, or null if no such interface is supported