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 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 Details

  • Constructor Details

    • 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 Details

    • 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.

    • 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 WebServiceFeature

    • setEnabled

      public void setEnabled(boolean enabled)
      Enable/disable this feature at port level

    • setEnabled

      public void setEnabled(String operationName, boolean enabled)
      Enable/disable this feature on a given operation
      Parameters:
      operationName - the local part of operation.

    • 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.