Package com.sun.xml.ws.api.tx.at

Class TransactionalFeature

java.lang.Object

jakarta.xml.ws.WebServiceFeature

com.sun.xml.ws.api.tx.at.TransactionalFeature

public class TransactionalFeature
extends jakarta.xml.ws.WebServiceFeature

This feature represents the use of WS-AT with a web service.

The following describes the affects of this feature with respect to being enabled or disabled:

• ENABLED: In this Mode, WS-AT will be enabled.
• DISABLED: In this Mode, WS-AT will be disabled

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID	Constant value identifying the TransactionalFeature

Fields inherited from class jakarta.xml.ws.WebServiceFeature

enabled

Constructor Summary

Constructors

Constructor	Description
TransactionalFeature()	Create an TransactionalFeature.
TransactionalFeature(boolean enabled)	Create an TransactionalFeature
TransactionalFeature(boolean enabled, Transactional.TransactionFlowType value, Transactional.Version version)

Method Summary

Modifier and Type	Method	Description
Map<String,Boolean>	getEnabledMap()
Transactional.TransactionFlowType	getFlowType()	Returns the default Transaction flow type for all operations.
Transactional.TransactionFlowType	getFlowType(String operationName)	Returns the Transaction flow type for a given operation.
Map<String,Transactional.TransactionFlowType>	getFlowTypeMap()	return a map listing the Transactional flow options for operations.
String	getID()
Transactional.Version	getVersion()	Returns the version of WS-AT to be used.
boolean	isEnabled(String operationName)	Returns true if WS-AT is enabled on the given operation.
boolean	isExplicitMode()	Transactional Feature has two modes, explicit Mode or implicit Mode.
void	setEnabled(boolean enabled)	Enable/disable this feature at port level
void	setEnabled(String operationName, boolean enabled)	Enable/disable this feature on a given operation
void	setExplicitMode(boolean explicitMode)	Change the Transactional Feature mode
void	setFlowType(Transactional.TransactionFlowType flowType)	Set the default Transaction flow type for all operations.
void	setFlowType(String operationName, Transactional.TransactionFlowType flowType)	Set the Transaction flow type for a given wsdl:operation.
void	setVersion(Transactional.Version version)	Set the version of WS-AT to be used.

Methods inherited from class jakarta.xml.ws.WebServiceFeature

isEnabled

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

Constant value identifying the TransactionalFeature

See Also:

Constant Field Values

Constructor Detail

TransactionalFeature

public TransactionalFeature(boolean enabled,
                            Transactional.TransactionFlowType value,
                            Transactional.Version version)

TransactionalFeature

public TransactionalFeature()

Create an TransactionalFeature. The instance created will be enabled.

TransactionalFeature

public TransactionalFeature(boolean enabled)

Create an TransactionalFeature

Parameters:

enabled - specifies whether this feature should be enabled or not.

Method Detail

getFlowType

public Transactional.TransactionFlowType getFlowType()

Returns the default Transaction flow type for all operations.

Returns:

Transactional.TransactionFlowType

getFlowType

public Transactional.TransactionFlowType getFlowType(String operationName)

Returns the Transaction flow type for a given operation.

Returns:

Transactional.TransactionFlowType

setFlowType

public void setFlowType(Transactional.TransactionFlowType flowType)

Set the default Transaction flow type for all operations.

Parameters:

flowType -

setFlowType

public void setFlowType(String operationName,
                        Transactional.TransactionFlowType flowType)

Set the Transaction flow type for a given wsdl:operation.

Parameters:

operationName - the local part of wsdl:opration

flowType - Transaction flow type

getID

public String getID()

Specified by:

getID in class jakarta.xml.ws.WebServiceFeature

setEnabled

public void setEnabled(boolean enabled)

Enable/disable this feature at port level

Parameters:

enabled -

setEnabled

public void setEnabled(String operationName,
                       boolean enabled)

Enable/disable this feature on a given operation

Parameters:

operationName - the local part of operation.

enabled -

isEnabled

public boolean isEnabled(String operationName)

Returns true if WS-AT is enabled on the given operation.

Parameters:

operationName - the local part of wsdl:operation

Returns:

true if and only if the WS-AT is enabled on the given operation.

getVersion

public Transactional.Version getVersion()

Returns the version of WS-AT to be used.

Returns:

Transactional.Version

setVersion

public void setVersion(Transactional.Version version)

Set the version of WS-AT to be used.

Parameters:

version - the version of WS-AT to be used.

getFlowTypeMap

public Map<String,Transactional.TransactionFlowType> getFlowTypeMap()

return a map listing the Transactional flow options for operations.

Returns:

a mapping listing the Transactional flow options explicit on operations.

getEnabledMap

public Map<String,Boolean> getEnabledMap()

Returns:

a mapping listing the transactional enabled attributes explicitly set on operations.

isExplicitMode

public boolean isExplicitMode()

Transactional Feature has two modes, explicit Mode or implicit Mode. In the implicit Mode, the Transactional Feature can be enabled at port level and be inherited or override at operation level. In the explicit Mode, transactional flow option can only specified and enabled at operation level. the default is explicit Mode.

Returns:

whether this Transactional Feature is in explicit mode.

setExplicitMode

public void setExplicitMode(boolean explicitMode)

Change the Transactional Feature mode

Parameters:

explicitMode - whether set to explicit Mode.