org.jboss.jbossts.star.util

Class TxSupport

java.lang.Object

org.jboss.jbossts.star.util.TxSupport

public class TxSupport
extends Object

Various utilities for sending HTTP messages

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_READ_TIMEOUT
protected static org.jboss.logging.Logger	log
static String	TX_CONTEXT context root
static String	TX_PATH Transaction Coordinator resource path
static String	TX_SEGMENT transaction-manager URI
static String	TXN_MGR_URL
static String	URI_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
TxSupport()
TxSupport(int readTimeout)
TxSupport(String txnMgr)
TxSupport(String txnMgr, int readTimeout)

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	addLink(StringBuilder linkHeader, String linkName, StringBuilder hrefPrefix, boolean first)
StringBuilder	addLink2(StringBuilder linkHeader, String linkName, String href, boolean first)
static void	addLinkHeader(javax.ws.rs.core.Response.ResponseBuilder response, javax.ws.rs.core.UriInfo info, String title, String name, String... pathComponents)
static String	buildURI(javax.ws.rs.core.UriBuilder builder, String... pathComponents)
String	commitTx()
static Map<String,String>	decodeLinkHeader(String linkHeader)
String	enlistParticipant(String participantLinkHeader)
String	enlistParticipant(String enlistUri, String participantLinkHeader)
String	enlistTestResource(String pUrl, boolean vParticipant)
void	enlistVolatileParticipant(String enlistUri, String participantLinkHeader)
static String	extractUri(javax.ws.rs.core.UriInfo info, String... paths)
String	getBody()
String	getContentType()
String	getDurableParticipantEnlistmentURI()
static int	getIntValue(String content, String name, int defValue)
String	getLink(String linkName)
int	getStatus()
static String	getStatus(String statusContent)
static String	getStringValue(String content, String name)
String	getTerminatorURI()
CoordinatorElement	getTransactionInfo()
CoordinatorElement	getTransactionInfo(String uri)
TransactionManagerElement	getTransactionManagerInfo()
Collection<String>	getTransactions()
Collection<String>	getTransactions(String mediaType)
TransactionStatisticsElement	getTransactionStatistics() Obtain statistical information such as the number of transactions that have committed and aborted.
String	getTxnUri()
static URI	getUri(javax.ws.rs.core.UriInfo info, int npaths, String... paths)
static javax.ws.rs.core.UriBuilder	getUriBuilder(javax.ws.rs.core.UriInfo info, int npaths, String... paths)
String	getVolatileParticipantEnlistmentURI()
String	httpRequest(int[] expect, String url, String method, String mediaType)
String	httpRequest(int[] expect, String url, String method, String mediaType, String content)
String	httpRequest(int[] expect, String url, String method, String mediaType, String content, Map<String,String> linkHeaders)
String	httpRequest(int[] expect, String url, String method, String mediaType, String content, Map<String,String> linkHeaders, Map<String,String> reqHeaders)
String	makeTwoPhaseAwareParticipantLinkHeader(String baseURI, boolean vParticipant, String uid1, String uid2) Constructs the participant-resource and participant-terminator URIs for participants in the format: "/{uid1}/{uid2}/participant" and "/{uid1}/{uid2}/terminator" and optionally "/{uid1}/{uid2}/volatile" If uid1 is null then the "{uid1}/" is not included and similarly if uid2 is null.
String	makeTwoPhaseAwareParticipantLinkHeader(String participantHref, String terminatorHref)
String	makeTwoPhaseAwareParticipantLinkHeader(String baseURI, String uid1, String uid2)
String	makeTwoPhaseParticipantLinkHeader(HashMap<String,String> links)
String	makeTwoPhaseUnAwareParticipantLinkHeader(String baseURI, boolean vParticipant, String uid1, String uid2, boolean commitOnePhase) Constructs the participant-resource and participant-terminator URIs for participants in the format: "/{uid1}/{uid2}/participant" and "/{uid1}/{uid2}/terminate" If uid1 is null then the "{uid1}/" is not included and similarly if uid2 is null.
String	makeTwoPhaseUnAwareParticipantLinkHeader(String participantHref, String prepareHref, String commitHref, String rollbackHref, String vParticipantHref)
String	markTxRollbackOnly()
static void	matchNames(Map<String,String> pairs, String content, String splitChars) Parse a string for name=value pairs TODO java.util.Scanner might be more efficient
void	refreshTransactionHeaders(Map<String,String> linkHeaders)
String	rollbackTx()
static void	setLinkHeader(javax.ws.rs.core.Response.ResponseBuilder builder, org.jboss.resteasy.spi.Link link)
static void	setLinkHeader(javax.ws.rs.core.Response.ResponseBuilder builder, String title, String rel, String href, String type)
static void	setTxnMgrUrl(String txnMgrUrl)
TxSupport	startTx()
TxSupport	startTx(long milliseconds)
static String	toContent(String property, String status)
static String	toStatusContent(String status)
static TxStatus	toTxStatus(String statusContent)
int	txCount()
String	txStatus() Get the status of the current transacton
String	txStatus(String mediaType)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.jboss.logging.Logger log

TX_CONTEXT

public static final String TX_CONTEXT

context root

TX_PATH

public static final String TX_PATH

Transaction Coordinator resource path

See Also:

Constant Field Values

TX_SEGMENT

public static final String TX_SEGMENT

transaction-manager URI

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

TXN_MGR_URL

public static String TXN_MGR_URL

URI_SEPARATOR

public static final String URI_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

TxSupport

public TxSupport(String txnMgr,
         int readTimeout)

TxSupport

public TxSupport(String txnMgr)

TxSupport

public TxSupport()

TxSupport

public TxSupport(int readTimeout)

Method Detail

setTxnMgrUrl

public static void setTxnMgrUrl(String txnMgrUrl)

addLinkHeader

public static void addLinkHeader(javax.ws.rs.core.Response.ResponseBuilder response,
                 javax.ws.rs.core.UriInfo info,
                 String title,
                 String name,
                 String... pathComponents)

setLinkHeader

public static void setLinkHeader(javax.ws.rs.core.Response.ResponseBuilder builder,
                 String title,
                 String rel,
                 String href,
                 String type)

setLinkHeader

public static void setLinkHeader(javax.ws.rs.core.Response.ResponseBuilder builder,
                 org.jboss.resteasy.spi.Link link)

getTransactions

public Collection<String> getTransactions()
                                   throws HttpResponseException

Throws:

HttpResponseException

getTransactions

public Collection<String> getTransactions(String mediaType)
                                   throws HttpResponseException

Throws:

HttpResponseException

txCount

public int txCount()
            throws HttpResponseException

Throws:

HttpResponseException

startTx

public TxSupport startTx()
                  throws HttpResponseException

Throws:

HttpResponseException

startTx

public TxSupport startTx(long milliseconds)
                  throws HttpResponseException

Throws:

HttpResponseException

commitTx

public String commitTx()
                throws HttpResponseException

Throws:

HttpResponseException

rollbackTx

public String rollbackTx()
                  throws HttpResponseException

Throws:

HttpResponseException

markTxRollbackOnly

public String markTxRollbackOnly()
                          throws HttpResponseException

Throws:

HttpResponseException

txStatus

public String txStatus()
                throws HttpResponseException

Get the status of the current transacton

Returns:

the transaction status expressed in the default media type (@see TxMediaType#TX_STATUS_MEDIA_TYPE)

Throws:

HttpResponseException

txStatus

public String txStatus(String mediaType)
                throws HttpResponseException

Throws:

HttpResponseException

getTxnUri

public String getTxnUri()

getTerminatorURI

public String getTerminatorURI()

getDurableParticipantEnlistmentURI

public String getDurableParticipantEnlistmentURI()

getVolatileParticipantEnlistmentURI

public String getVolatileParticipantEnlistmentURI()

getBody

public String getBody()

getStatus

public int getStatus()

getContentType

public String getContentType()

refreshTransactionHeaders

public void refreshTransactionHeaders(Map<String,String> linkHeaders)
                               throws HttpResponseException

Throws:

HttpResponseException

enlistTestResource

public String enlistTestResource(String pUrl,
                        boolean vParticipant)
                          throws HttpResponseException

Throws:

HttpResponseException

decodeLinkHeader

public static Map<String,String> decodeLinkHeader(String linkHeader)

addLink

public StringBuilder addLink(StringBuilder linkHeader,
                    String linkName,
                    StringBuilder hrefPrefix,
                    boolean first)

addLink2

public StringBuilder addLink2(StringBuilder linkHeader,
                     String linkName,
                     String href,
                     boolean first)

makeTwoPhaseAwareParticipantLinkHeader

public String makeTwoPhaseAwareParticipantLinkHeader(String baseURI,
                                            boolean vParticipant,
                                            String uid1,
                                            String uid2)

Constructs the participant-resource and participant-terminator URIs for participants in the format: "/{uid1}/{uid2}/participant" and "/{uid1}/{uid2}/terminator" and optionally "/{uid1}/{uid2}/volatile" If uid1 is null then the "{uid1}/" is not included and similarly if uid2 is null.

Parameters:

baseURI - the (full) uri prefix

vParticipant - if true also construct a link header for participation in the volatile protocol

uid1 - a string which together with baseURI and possibly uid2 produce a unique id

uid2 - a string which together with baseURI and possibly uid1 produce a unique id

Returns:

link header value

makeTwoPhaseAwareParticipantLinkHeader

public String makeTwoPhaseAwareParticipantLinkHeader(String baseURI,
                                            String uid1,
                                            String uid2)

makeTwoPhaseAwareParticipantLinkHeader

public String makeTwoPhaseAwareParticipantLinkHeader(String participantHref,
                                            String terminatorHref)

makeTwoPhaseUnAwareParticipantLinkHeader

public String makeTwoPhaseUnAwareParticipantLinkHeader(String baseURI,
                                              boolean vParticipant,
                                              String uid1,
                                              String uid2,
                                              boolean commitOnePhase)

Constructs the participant-resource and participant-terminator URIs for participants in the format: "/{uid1}/{uid2}/participant" and "/{uid1}/{uid2}/terminate" If uid1 is null then the "{uid1}/" is not included and similarly if uid2 is null.

Parameters:

baseURI - the (full) uri prefix

vParticipant - if true also construct a link header for participation in the volatile protocol

uid1 - a string which together with baseURI and possibly uid2 produce a unique id

uid2 - a string which together with baseURI and possibly uid1 produce a unique id

commitOnePhase - if true generate a commit-one-phase link header

Returns:

link header value

makeTwoPhaseUnAwareParticipantLinkHeader

public String makeTwoPhaseUnAwareParticipantLinkHeader(String participantHref,
                                              String prepareHref,
                                              String commitHref,
                                              String rollbackHref,
                                              String vParticipantHref)

makeTwoPhaseParticipantLinkHeader

public String makeTwoPhaseParticipantLinkHeader(HashMap<String,String> links)

enlistParticipant

public String enlistParticipant(String participantLinkHeader)

enlistParticipant

public String enlistParticipant(String enlistUri,
                       String participantLinkHeader)

Parameters:

enlistUri - the URI for enlisting participants with a transaction manager

participantLinkHeader - link header for the participant to identify itself to the coordinator

Returns:

participant recovery URI

enlistVolatileParticipant

public void enlistVolatileParticipant(String enlistUri,
                             String participantLinkHeader)

httpRequest

public String httpRequest(int[] expect,
                 String url,
                 String method,
                 String mediaType)
                   throws HttpResponseException

Throws:

HttpResponseException

httpRequest

public String httpRequest(int[] expect,
                 String url,
                 String method,
                 String mediaType,
                 String content)
                   throws HttpResponseException

Throws:

HttpResponseException

httpRequest

public String httpRequest(int[] expect,
                 String url,
                 String method,
                 String mediaType,
                 String content,
                 Map<String,String> linkHeaders)
                   throws HttpResponseException

Throws:

HttpResponseException

httpRequest

public String httpRequest(int[] expect,
                 String url,
                 String method,
                 String mediaType,
                 String content,
                 Map<String,String> linkHeaders,
                 Map<String,String> reqHeaders)
                   throws HttpResponseException

Throws:

HttpResponseException

matchNames

public static void matchNames(Map<String,String> pairs,
              String content,
              String splitChars)

Parse a string for name=value pairs TODO java.util.Scanner might be more efficient

Parameters:

pairs - the name value pairs contained in content

content - a string containing name=value substrings

getStringValue

public static String getStringValue(String content,
                    String name)

getIntValue

public static int getIntValue(String content,
              String name,
              int defValue)

getUriBuilder

public static javax.ws.rs.core.UriBuilder getUriBuilder(javax.ws.rs.core.UriInfo info,
                                        int npaths,
                                        String... paths)

getUri

public static URI getUri(javax.ws.rs.core.UriInfo info,
         int npaths,
         String... paths)

extractUri

public static String extractUri(javax.ws.rs.core.UriInfo info,
                String... paths)

buildURI

public static String buildURI(javax.ws.rs.core.UriBuilder builder,
              String... pathComponents)

toTxStatus

public static TxStatus toTxStatus(String statusContent)

getStatus

public static String getStatus(String statusContent)

toContent

public static String toContent(String property,
               String status)

toStatusContent

public static String toStatusContent(String status)

getLink

public String getLink(String linkName)

getTransactionStatistics

public TransactionStatisticsElement getTransactionStatistics()
                                                      throws JAXBException

Obtain statistical information such as the number of transactions that have committed and aborted.

Returns:

transaction statistics

Throws:

JAXBException - if JAXB cannot convert an XML representation of the statistics into a JAXB object

getTransactionInfo

public CoordinatorElement getTransactionInfo()
                                      throws JAXBException

Throws:

JAXBException

getTransactionInfo

public CoordinatorElement getTransactionInfo(String uri)
                                      throws JAXBException

Throws:

JAXBException

getTransactionManagerInfo

public TransactionManagerElement getTransactionManagerInfo()
                                                    throws JAXBException

Throws:

JAXBException