Package org.jboss.jbossts.xts.environment

Class WSCEnvironmentBean

java.lang.Object
org.jboss.jbossts.xts.environment.WSCEnvironmentBean
public class WSCEnvironmentBean extends Object
bean storing WS-C implementation configuration values derived from the xts properties file, system property settings and, in case we are running inside JBossAS the xts bean.xml file

  • Field Details

  • Constructor Details

    • WSCEnvironmentBean

      public WSCEnvironmentBean()

  • Method Details

    • getInitialTransportPeriod

      public int getInitialTransportPeriod()
      Returns initial time to wait before resending a coordination protocol message. This is increased gradually, doubling every two resends up to the maximum value
      Returns:
      initial time to wait before resending a coordination protocol message.

    • setInitialTransportPeriod

      public void setInitialTransportPeriod(int initialTransportPeriod)
      Sets initial time to wait before resending a coordination protocol message.
      Parameters:
      initialTransportPeriod - initial time to wait before resending a coordination protocol message.

    • getMaximumTransportPeriod

      public int getMaximumTransportPeriod()
      Returns maximum time to wait before resending a coordination protocol message.
      Returns:
      maximum time to wait before resending a coordination protocol message.

    • setMaximumTransportPeriod

      public void setMaximumTransportPeriod(int maximumTransportPeriod)
      Sets maximum time to wait before resending a coordination protocol message.
      Parameters:
      maximumTransportPeriod - maximum time to wait before resending a coordination protocol message.

    • getTransportTimeout

      public int getTransportTimeout()
      Returns the wait period after sending a protocol message and not getting the expected reply before it is decided that the server at the other end has crashed. This wait is only used for some exchanges. A timeout may be handled by transitioning to a different transaction state. Alternatively the service may merely begin resending the message starting at the initial transport period.
      Returns:
      wait period before deciding that the server at the other end has crashed.

    • setTransportTimeout

      public void setTransportTimeout(int transportTimeout)
      Sets the wait period after sending a protocol message and not getting the expected reply before it is decided that the server at the other end has crashed.
      Parameters:
      transportTimeout - wait period before deciding that the server at the other end has crashed.

    • setHttpBindInetAddress

      public void setHttpBindInetAddress(InetAddress httpBindInetAddress)
      this setter is used by the microcontainer to inject the inet address supplied during app server startup.

    • getBindAddress11

      public String getBindAddress11()
      Returns the bind address on which the web service is listening. When running in JBoss AS this is derived from the JBoss Web service bean by injection. WS-C version: 1.1.
      Returns:
      the bind address on which the web service is listening.

    • setBindAddress11

      public void setBindAddress11(String bindAddress11)
      Sets the bind address on which the web service is listening. WS-C version: 1.1.
      Parameters:
      bindAddress11 - the bind address on which the web service is listening.

    • getBindPort11

      public int getBindPort11()
      Returns the port which will be used to service non-secure requests. WS-C version: 1.1.
      Returns:
      the port which will be used to service non-secure requests.

    • setBindPort11

      public void setBindPort11(int bindPort11)
      Sets the port which will be used to service non-secure requests. WS-C version: 1.1.
      Parameters:
      bindPort11 - the port which will be used to service non-secure requests.

    • getBindPortSecure11

      public int getBindPortSecure11()
      Returns the port which will be used to service secure requests. WS-C version: 1.1.
      Returns:
      the port which will be used to service secure requests.

    • setBindPortSecure11

      public void setBindPortSecure11(int bindPortSecure11)
      Sets the port which will be used to service secure requests. WS-C version: 1.1.
      Parameters:
      bindPortSecure11 - the port which will be used to service secure requests.

    • getCoordinatorURL11

      public String getCoordinatorURL11()
      Returns the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction. If this is undefined then a URL is constructed using the scheme, host address, port and URL path specified in the properties file or, where they are missing, using their default values. WS-C version: 1.1.
      Returns:
      the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction.

    • setCoordinatorURL11

      public void setCoordinatorURL11(String coordinatorURL11)
      Sets the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction. WS-C version: 1.1.
      Parameters:
      coordinatorURL11 - the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction.

    • getCoordinatorScheme11

      public String getCoordinatorScheme11()
      Returns the scheme which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Returns:
      the scheme which will be used to construct a coordinator URL if it is not specified.

    • setCoordinatorScheme11

      public void setCoordinatorScheme11(String coordinatorScheme11)
      Sets the scheme which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Parameters:
      coordinatorScheme11 - the scheme which will be used to construct a coordinator URL if it is not specified.

    • getCoordinatorAddress11

      public String getCoordinatorAddress11()
      Returns the address which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Returns:
      the address which will be used to construct a coordinator URL if it is not specified.

    • setCoordinatorAddress11

      public void setCoordinatorAddress11(String coordinatorAddress11)
      Sets the address which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Parameters:
      coordinatorAddress11 - the address which will be used to construct a coordinator URL if it is not specified.

    • getCoordinatorPort11

      public int getCoordinatorPort11()
      Returns the port which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Returns:
      the port which will be used to construct a coordinator URL if it is not specified.

    • setCoordinatorPort11

      public void setCoordinatorPort11(int coordinatorPort11)
      Sets the port which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Parameters:
      coordinatorPort11 - the port which will be used to construct a coordinator URL if it is not specified.

    • getCoordinatorPath11

      public String getCoordinatorPath11()
      Returns the path which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Returns:
      the path which will be used to construct a coordinator URL if it is not specified

    • setCoordinatorPath11

      public void setCoordinatorPath11(String coordinatorPath11)
      Sets the path which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.1.
      Parameters:
      coordinatorPath11 - the path which will be used to construct a coordinator URL if it is not specified.

    • getBindAddress10

      @Deprecated public String getBindAddress10()
      Deprecated.
      Returns the bind address on which the web service is listening. When running in JBoss AS this is derived from the JBoss Web service bean by injection. If not set it defaults to localhost. WS-C version: 1.0.
      Returns:
      the bind address on which the web service is listening.

    • setBindAddress10

      @Deprecated public void setBindAddress10(String bindAddress10)
      Deprecated.
      Sets the bind address on which the web service is listening. WS-C version: 1.0.
      Parameters:
      bindAddress10 - the bind address on which the web service is listening.

    • getBindPort10

      @Deprecated public int getBindPort10()
      Deprecated.
      Returns the port which will be used to service non-secure requests. If not set it defaults to 8080. WS-C version: 1.0.
      Returns:
      the port which will be used to service non-secure requests.

    • setBindPort10

      @Deprecated public void setBindPort10(int bindPort10)
      Deprecated.
      Sets the port which will be used to service non-secure requests. WS-C version: 1.0.
      Parameters:
      bindPort10 - the port which will be used to service non-secure requests.

    • getBindPortSecure10

      @Deprecated public int getBindPortSecure10()
      Deprecated.
      Returns the port which will be used to service secure requests. If not set it defaults to 8080. n.b. the 1.0 implementation deploys its own servlet and it only listens on the non-secure port. WS-C version: 1.0.
      Returns:
      the port which will be used to service secure requests.

    • setBindPortSecure10

      @Deprecated public void setBindPortSecure10(int bindPortSecure10)
      Deprecated.
      Sets the port which will be used to service secure requests. n.b. the 1.0 implementation deploys its own servlet and it only listens on the non-secure port. WS-C version: 1.0.
      Parameters:
      bindPortSecure10 - the port which will be used to service secure requests.

    • getCoordinatorURL10

      @Deprecated public String getCoordinatorURL10()
      Deprecated.
      Returns the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction. If this is undefined then a URL is constructed using the scheme, host address, port and URL path specified in the properties file or, where they are missing, using their default values. WS-C version: 1.0.
      Returns:
      the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction.

    • setCoordinatorURL10

      @Deprecated public void setCoordinatorURL10(String coordinatorURL10)
      Deprecated.
      Sets the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction. WS-C version: 1.0.
      Parameters:
      coordinatorURL10 - the URL to be used by XTS clients to address the Activation Coordinator service when starting a transaction.

    • getCoordinatorScheme10

      @Deprecated public String getCoordinatorScheme10()
      Deprecated.
      Returns the scheme which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Returns:
      the scheme which will be used to construct a coordinator URL if it is not specified.

    • setCoordinatorScheme10

      @Deprecated public void setCoordinatorScheme10(String coordinatorScheme10)
      Deprecated.
      Sets the scheme which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Parameters:
      coordinatorScheme10 - the scheme which will be used to construct a coordinator URL if it is not specified.

    • getCoordinatorAddress10

      @Deprecated public String getCoordinatorAddress10()
      Deprecated.
      Returns the address which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Returns:
      the address which will be used to construct a coordinator URL if it is not specified.

    • setCoordinatorAddress10

      @Deprecated public void setCoordinatorAddress10(String coordinatorAddress10)
      Deprecated.
      Sets the address which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Parameters:
      coordinatorAddress10 - the address which will be used to construct a coordinator URL if it is not specified.

    • getCoordinatorPort10

      @Deprecated public int getCoordinatorPort10()
      Deprecated.
      Returns the port which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Returns:
      the port which will be used to construct a coordinator URL if it is not specified.

    • setCoordinatorPort10

      @Deprecated public void setCoordinatorPort10(int coordinatorPort10)
      Deprecated.
      Sets the port which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Parameters:
      coordinatorPort10 - the port which will be used to construct a coordinator URL if it is not specified.

    • getCoordinatorPath10

      @Deprecated public String getCoordinatorPath10()
      Deprecated.
      Returns the path which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Returns:
      the path which will be used to construct a coordinator URL if it is not specified.

    • setCoordinatorPath10

      @Deprecated public void setCoordinatorPath10(String coordinatorPath10)
      Deprecated.
      Sets the path which will be used to construct a coordinator URL if it is not specified. WS-C version: 1.0.
      Parameters:
      coordinatorPath10 - the path which will be used to construct a coordinator URL if it is not specified.

    • getServiceURLPath

      public String getServiceURLPath()
      Returns the URL path component of the URL at which 1.1 WS-C services have been mapped. If this is null then the path is defaulted to "ws-c11".
      Returns:
      the URL path component of the URL at which 1.1 WS-C services have been mapped.

    • setServiceURLPath

      public void setServiceURLPath(String serviceURLPath)
      Sets the URL path component of the URL at which 1.1 WS-C services have been mapped.
      Parameters:
      serviceURLPath - the URL path component of the URL at which 1.1 WS-C services have been mapped.

    • getUseAsynchronousRequest

      public String getUseAsynchronousRequest()
      Getter for the asynchronous request (default NO) for registration.
      Returns:
      the value for asynch request

    • setUseAsynchronousRequest

      public void setUseAsynchronousRequest(String useAsynchronousRequest)
      Setter for the asynchronous request (default false) for registration.
      Parameters:
      useAsynchronousRequest - New async request

    • getAsyncRequestWait

      public int getAsyncRequestWait()
      Getter for the async request wait.
      Returns:
      The async request time.

    • setAsyncRequestWait

      public void setAsyncRequestWait(int asyncRequestWait)
      Setter for the async request time.
      Parameters:
      asyncRequestWait - The new async request wait time.