Package org.wildfly.transaction.client.spi

Interface RemoteTransactionProvider

All Superinterfaces:

TransactionProvider

All Known Implementing Classes:

RemotingRemoteTransactionProvider

public interface RemoteTransactionProvider
extends TransactionProvider

A remote transaction transport provider.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method	Description
RemoteTransactionPeer	getPeerHandle(URI location, SSLContext sslContext, org.wildfly.security.auth.client.AuthenticationConfiguration authenticationConfiguration)	Get a handle for a specific peer.
default RemoteTransactionPeer	getPeerHandleForXa(URI location, SSLContext sslContext, org.wildfly.security.auth.client.AuthenticationConfiguration authenticationConfiguration)	Get a handle for a specific peer for an XA operation.
boolean	supportsScheme(String scheme)	Determine whether the provider supports the given URI scheme.

Method Detail

getPeerHandle

RemoteTransactionPeer getPeerHandle(URI location,
                                    SSLContext sslContext,
                                    org.wildfly.security.auth.client.AuthenticationConfiguration authenticationConfiguration)
                             throws jakarta.transaction.SystemException

Get a handle for a specific peer.

Parameters:

location - the peer location

sslContext - the sticky SSL context to use (may be null)

authenticationConfiguration - the sticky authentication configuration to use (may be null)

Returns:

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

Throws:

jakarta.transaction.SystemException - if handle acquisition has failed

getPeerHandleForXa

default RemoteTransactionPeer getPeerHandleForXa(URI location,
                                                 SSLContext sslContext,
                                                 org.wildfly.security.auth.client.AuthenticationConfiguration authenticationConfiguration)
                                          throws XAException

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

Parameters:

location - the peer location (not null)

sslContext - the sticky SSL context to use (may be null)

authenticationConfiguration - the sticky authentication configuration to use (may be 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