### Start HornetQ with STOMP Over WebSocket

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/stomp/doc/index.html

Commands to navigate to the example directory and build the project to enable STOMP over WebSocket support in HornetQ.

```bash
$ cd hornetq-x.y.z/examples/jms/stomp-websockets
$ mvn clean install
```

--------------------------------

### Setup Local Test Sandbox

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/CONTRIBUTING.md

Use these Grunt commands to set up a local test sandbox and begin development. Ensure you copy the example HTML file first.

```bash
cp sandbox/index.html.example sandbox/index.html
grunt connect
```

```bash
open http://localhost:9999/sandbox/index.html
```

--------------------------------

### STOMP Connection and Subscription Example

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/stomp/doc/index.html

Example of connecting to a STOMP server via WebSocket and subscribing to a queue. This is a basic setup for a chat application.

```javascript
var client = Stomp.client('ws://localhost:15674/ws');

client.connect('guest', 'guest', function(frame) {
    console.log('connected to Stomp');

    client.subscribe('/queue/test', function (message) {
        console.log('received message: ' + message.body);
    });

}, function(error) {
    console.log('STOMP: ' + error);
});

```

--------------------------------

### Install Development Dependencies

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/stomp/README.md

Install all necessary dependencies for development, including testing and building the library. This command should be run in the project's root directory.

```bash
$ npm install
```

--------------------------------

### Install JavaScript dependency management tools

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/README.adoc

Commands to install Node.js, npm, and Bower on an Ubuntu system.

```bash
sudo apt-get install nodejs
sudo apt-get install npm
sudo sudo npm install bower
```

--------------------------------

### Start Distributed State Machine Instance

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-web.adoc

Command to start a single instance of the distributed state machine sample. Ensure Zookeeper is running locally. Use `--server.port=<myport>` to distinguish instances on the same host.

```text
# java -jar spring-statemachine-samples-web-{revnumber}.jar
```

--------------------------------

### Install Flat UI via Bower

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/flat-ui/README.md

Use this command to install the Flat UI package using the Bower dependency manager.

```bash
bower install flat-ui
```

--------------------------------

### Install Bower Globally

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/flat-ui/docs/getting-started.html

If Bower is not installed globally, run this command first to install it.

```bash
npm install -g bower
```

--------------------------------

### Install Grunt Packages

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/flat-ui/docs/getting-started.html

Before running Grunt commands, ensure all necessary Grunt packages are installed by running this command.

```bash
npm install
```

--------------------------------

### Install AngularJS Toaster with Bower or NPM

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/angularjs-toaster/README.md

Use these commands to install the library via package managers.

```bash
bower install --save angularjs-toaster
```

```bash
npm install --save angularjs-toaster
```

--------------------------------

### Get State HTTP Request

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-turnstilereactive.adoc

Example HTTP GET request to retrieve the current state of the StateMachine.

```bash
GET http://localhost:8080/state
```

--------------------------------

### Select Spring Profile for Persistence

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-datajpapersist.adoc

Examples of how to run the sample application with specific Spring profiles activated to choose the persistence backend.

```text
# java -jar spring-statemachine-samples-datapersist-{revnumber}.jar --spring.profiles.active=jpa
# java -jar spring-statemachine-samples-datapersist-{revnumber}.jar --spring.profiles.active=mongo
# java -jar spring-statemachine-samples-datapersist-{revnumber}.jar --spring.profiles.active=redis
```

--------------------------------

### Instantiate State Machine with Configuration Model

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/appendix-distributedpaper.adoc

Demonstrates how to instantiate a state machine by building a model with configuration data classes and then using a factory to create the state machine. This approach allows for easier integration and customization.

```java
StateMachineModel<String, String> model = StateMachineModelFactory.create("sample-machine", new StateMachineConfigObject(new StateMachineConfigObject.States(), new StateMachineConfigObject.Transitions()));
StateMachine<String, String> stateMachine = stateMachineFactory.create(model);
```

--------------------------------

### Component Initialization API

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.SliderHandle.md

APIs related to the initialization and setup of components.

```APIDOC
## init( player, options, ready )

### Description
The constructor function for the class.

### Method
POST

### Endpoint
N/A (Constructor)

### Parameters
#### Path Parameters
* **player** - Required - The player instance.
* **options** - Required - Initialization options.
* **ready** - Required - Callback function when initialization is complete.
```

```APIDOC
## initChildren()

### Description
Add and initialize default child components from options. This method processes the `children` option to add and configure child components.

### Method
POST

### Endpoint
N/A (Method call on component instance)

### Parameters
None

### Example
```javascript
// Example of setting children in options
MyComponent.prototype.options_.children = {
  myChildComponent: {
    myChildOption: true
  }
};

// Or when creating the component
var myComp = new MyComponent(player, {
  children: {
    myChildComponent: {
      myChildOption: true
    }
  }
});

// Children can also be an Array
var myComp = new MyComponent(player, {
  children: [
    'button',
    {
      name: 'button',
      someOtherOption: true
    }
  ]
});
```
```

--------------------------------

### Get State HTTP Response

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-turnstilereactive.adoc

Example response when retrieving the StateMachine state.

```text
"LOCKED"
```

--------------------------------

### init( player, options )

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.LoadProgressBar.md

Initializes the component with player and options.

```APIDOC
## init( player, options )

### Parameters
- **player** (Object) - Required - The player instance.
- **options** (Object) - Required - Configuration options.
```

--------------------------------

### Get Children Components Example

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.CaptionsButton.md

Retrieves an array containing all child components currently associated with a parent component.

```javascript
var kids = myComponent.children();
```

--------------------------------

### Get video duration

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Player.md

Retrieves the length of the video in seconds. The video must have started loading before this value is available.

```javascript
var lengthOfVideo = myPlayer.duration();
```

--------------------------------

### Configure Simple Machine with JPA Repository

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-repository.adoc

Demonstrates manual creation of states and transitions for a simple machine using JPA repositories.

```java
include::samples/DocsJpaRepositorySampleTests1.java[tags=snippetA]
```

--------------------------------

### Run Turnstile Sample

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-turnstile.adoc

Command line interaction showing how to start the state machine and send events.

```text
$ java -jar spring-statemachine-samples-turnstile-{revnumber}.jar

sm>print
+----------------------------------------------------------------+
|                              SM                                |
+----------------------------------------------------------------+
|                                                                |
|         +----------------+          +----------------+         |
|     *-->|     LOCKED     |          |    UNLOCKED    |         |
|         +----------------+          +----------------+         |
|     +---| entry/         |          | entry/         |---+     |
|     |   | exit/          |          | exit/          |   |     |
|     |   |                |          |                |   |     |
| PUSH|   |                |---COIN-->|                |   |COIN |
|     |   |                |          |                |   |     |
|     |   |                |          |                |   |     |
|     |   |                |<--PUSH---|                |   |     |
|     +-->|                |          |                |<--+     |
|         |                |          |                |         |
|         +----------------+          +----------------+         |
|                                                                |
+----------------------------------------------------------------+

sm>start
State changed to LOCKED
State machine started

sm>event COIN
State changed to UNLOCKED
Event COIN send

sm>event PUSH
State changed to LOCKED
Event PUSH send
```

--------------------------------

### Run Sample Application

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-datajpa.adoc

Command to execute the JPA state machine sample JAR.

```text
# java -jar spring-statemachine-samples-datajpa-{revnumber}.jar
```

--------------------------------

### Install AngularJS via bower

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/angular/README.md

Use this command to install the package in a bower-managed project.

```shell
bower install angular
```

--------------------------------

### Install AngularJS via npm

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/angular/README.md

Use this command to install the package in an npm-managed project.

```shell
npm install angular
```

--------------------------------

### init(player, options)

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.MenuItem.md

Initializes the component with a player instance and options.

```APIDOC
## init(player, options)

### Description
Initializes the component.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
* __player__ - The player instance.
* __options__ - Initialization options.
```

--------------------------------

### init(player, options)

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.MuteToggle.md

Initializes the component with a player instance and options.

```APIDOC
## init(player, options)

### Description
Initializes the component with a player instance and options.

### Method
`init(player, options)`

### Endpoint
N/A (Method within a class)

### Parameters
* __player__ - The player instance.
* __options__ - The options for initializing the component.
```

--------------------------------

### Install grunt-cli globally

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/CONTRIBUTING.md

Install the grunt command-line interface globally to manage build tasks.

```bash
sudo npm install -g grunt-cli
```

```bash
npm install -g grunt-cli
```

--------------------------------

### init(player, options)

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.PlayToggle.md

Initializes the component with a player instance and options.

```APIDOC
## init(player, options)

### Description
Initializes the component with a player instance and options.

### Method
[Method details not explicitly provided, assumed to be a component method]

### Endpoint
[Not applicable for this method]

### Parameters
#### Path Parameters
* **player** - Required - The player instance.
* **options** - Required - Initialization options.

### Request Example
None

### Response
None explicitly defined.
```

--------------------------------

### Install contribflow globally

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/CONTRIBUTING.md

Install the git workflow tool used for managing branches and pull requests.

```bash
sudo npm install -g contribflow
```

```bash
npm install -g contribflow
```

--------------------------------

### Run the Deploy Sample Application

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-deploy.adoc

Execute the Spring Boot-based deploy sample application using the provided JAR file.

```text
# java -jar spring-statemachine-samples-deploy-{revnumber}.jar
```

--------------------------------

### Interact with Shell Instance 1

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-zookeeper.adoc

Demonstrates starting the state machine and transitioning states in the first shell instance.

```text
sm>start
Entry state LOCKED
State machine started

sm>event COIN
Exit state LOCKED
Entry state UNLOCKED
Event COIN send

sm>state
UNLOCKED
```

--------------------------------

### Copy Sandbox Index File

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/CONTRIBUTING.md

Copy the example index file to the sandbox directory to create a local player instance for testing. This allows you to see your local changes in a browser.

```bash
cp sandbox/index.html.example sandbox/index.html
open sandbox/index.html
```

--------------------------------

### Install angular-animate with npm

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/angular-animate/README.md

Use npm to install the angular-animate package. Then, require it as a dependency for your AngularJS application module.

```shell
npm install angular-animate
```

```javascript
angular.module('myApp', [require('angular-animate')]);
```

--------------------------------

### Run Order Shipping Sample

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-ordershipping.adoc

Execute the order shipping sample application using the provided JAR file.

```text
# java -jar spring-statemachine-samples-ordershipping-{revnumber}.jar
```

--------------------------------

### Set or Get Component Width

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Html5.md

This method allows you to set or get the width of a component. When setting, only pixel values are reliably supported; percentage values may not compute correctly. Returns the component instance when setting width, or the width value when getting.

```javascript
myComponent.width(100);
myComponent.width();
```

--------------------------------

### Component Initialization

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.MediaLoader.md

Initializes a component with player, options, and a ready callback.

```APIDOC
## init( player, options, ready )

### Description
Initializes the component with the provided player instance, options, and a ready callback function.

### Method
POST

### Endpoint
N/A (Method on component instance)

### Parameters
#### Path Parameters
* **player** - The player instance.
* **options** - Configuration options for the component.
* **ready** - A callback function to be executed when the component is ready.
```

--------------------------------

### Install stompjs for Node.js

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/stomp/README.md

Install the 'stompjs' module using npm. This is the first step to using the library in a Node.js application.

```bash
$ npm install stompjs
```

--------------------------------

### Interact with Shell Instance 2

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-zookeeper.adoc

Demonstrates starting the second shell instance and observing the distributed state.

```text
sm>start
State machine started

sm>state
UNLOCKED
```

--------------------------------

### Set or Get Height

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.ChaptersTrack.md

Gets or sets the height of the component using CSS values. Pixel values are required for setting.

```APIDOC
## GET/PUT height( [num], [skipListeners] )

### Description
Get or set the height of the component (CSS values).
Setting the video tag dimension values only works with values in pixels. Percent values will not work. Some percents can be used, but width()/height() will return the number + %, not the actual computed width/height.

### Method
GET/PUT

### Endpoint
/api/component/height

### Parameters
#### Path Parameters
- **num** (Number|String) - Optional - New component height.
- **skipListeners** (Boolean) - Optional - Skip the resize event trigger.

### Returns
* `vjs.Component` - This component, when setting the height.
* `Number|String` - The height, when getting.
```

--------------------------------

### Video.js Player HTML Setup

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Player.md

This HTML snippet shows how to set up a video element for Video.js using the `data-setup` attribute. The library will automatically create a player instance when ready.

```html
<video id="example_video_1" data-setup='{}' controls>
  <source src="my-source.mp4" type="video/mp4">
</video>
```

--------------------------------

### Start Zookeeper Shell Instance

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-zookeeper.adoc

Command to launch the Zookeeper sample application shell.

```text
@n1:~# java -jar spring-statemachine-samples-zookeeper-{revnumber}.jar
```

--------------------------------

### Get or Set Height

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.SubtitlesTrack.md

Gets or sets the height of the component using CSS values. Pixel values are required for setting the height.

```APIDOC
## height( [num], [skipListeners] )

### Description
Get or set the height of the component (CSS values).

Setting the video tag dimension values only works with values in pixels. Percent values will not work.
Some percents can be used, but width()/height() will return the number + %, not the actual computed width/height.

### Parameters
* __num__ `Number|String` _(OPTIONAL)_ - The new component height.
* __skipListeners__ `Boolean` _(OPTIONAL)_ - Whether to skip the resize event trigger.

### Returns
* `vjs.Component` - This component, when setting the height.
* `Number|String` - The height, when getting.
```

--------------------------------

### Component Initialization

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.TextTrack.md

Initializes a component with player and options.

```APIDOC
## POST /api/component/init

### Description
Initialize a component with player and options.

### Method
POST

### Endpoint
/api/component/init

### Parameters
#### Request Body
- **player** (Object) - The player instance.
- **options** (Object) - Configuration options for the component.
```

--------------------------------

### Build Samples with Gradle

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples.adoc

Command to clean and build the samples using Gradle. Use '-x test' to exclude tests during the build.

```bash
./gradlew clean build -x test
```

--------------------------------

### Define a Simple Runnable Task

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/recipes.adoc

This example shows a basic Runnable task that performs a sleep operation. It serves as a foundation for other task examples.

```java
Runnable sleepRunnable = () -> {
    try {
        Thread.sleep(50);
    } catch (InterruptedException e) {
        Thread.currentThread().interrupt();
    }
};
```

--------------------------------

### Run Security Sample

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-security.adoc

Command to execute the compiled security sample JAR.

```text
# java -jar spring-statemachine-samples-secure-{revnumber}.jar
```

--------------------------------

### Install angular-animate with bower

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/angular-animate/README.md

Use bower to install the angular-animate package. Include the script in your index.html and then add 'ngAnimate' as a dependency for your AngularJS application module.

```shell
bower install angular-animate
```

```html
<script src="/bower_components/angular-animate/angular-animate.js"></script>
```

```javascript
angular.module('myApp', ['ngAnimate']);
```

--------------------------------

### Get or Set Component Height - JavaScript

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.TextTrack.md

Gets or sets the height of a component. Pixel values are required when setting the height. This method is inherited from src/js/component.js.

```javascript
var height = player.height();
player.height(360);
player.height('360px');
```

--------------------------------

### Configure Video.js via data-setup

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/guides/options.md

Provide player options as a JSON object within the data-setup attribute of the video tag.

```html
<video data-setup='{ "controls": true, "autoplay": false, "preload": "auto" }'...
```

--------------------------------

### STOMP Telnet Connection Example

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/stomp/doc/index.html

Example of connecting to a STOMP server using telnet and sending a message. This is a low-level way to interact with the server for testing.

```bash
$ telnet localhost 61613
CONNECT
login:guest
passcode:guest

^@

CONNECTED
session:1092296064


^@ is a null (control-@ in ASCII) byte.

SEND
destination:/queue/test

Hello from TCP!
^@

```

--------------------------------

### Build and Test Video.js

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/CONTRIBUTING.md

Build a local copy of Video.js and run the default test suite. 'grunt' builds the project, and 'grunt test' runs the tests.

```bash
grunt
grunt test
```

--------------------------------

### Start and Commit Transaction

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/stomp/doc/index.html

Start a transaction using client.begin() and commit it to send messages within that transaction. Messages sent with the transaction ID will be part of the transaction.

```javascript
// start the transaction
var tx = client.begin();
// send the message in a transaction
client.send("/queue/test", {transaction: tx.id}, "message in a transaction");
// commit the transaction to effectively send the message
tx.commit();

```

--------------------------------

### Compile, Test, and Build Project with Gradle

Source: https://github.com/spring-projects/spring-statemachine/blob/main/README.adoc

Compile the project, run tests, and build all artifacts including distribution zips and documentation. This command uses the Gradle wrapper and requires JDK 17+.

```bash
./gradlew build
```

--------------------------------

### Get all Regions in a State Machine

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-accessor.adoc

Use `withAllRegions` to get a list of all Region instances within a state machine. Requires JDK 8 lambdas for non-verbose code.

```java
stateMachine.withAllRegions(new StateMachineFunction<Object, Object>() {

	@Override
	public void apply(StateMachineAccess<Object, Object> access) throws Exception {
		System.out.println("Region " + access.getRegion().getId() + " " + access.getRegion().getState().getId());
	}

});
```

--------------------------------

### init()

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Player.md

Player's constructor function.

```APIDOC
## init()

### Description
Player's constructor function.

### Parameters
#### Request Body
- **tag** (Element) - Required - The original video tag used for configuring options.
- **options** (Object) - Optional - Player options.
- **ready** (Function) - Optional - Ready callback function.
```

--------------------------------

### Install Spring Artifacts with Gradle

Source: https://github.com/spring-projects/spring-statemachine/blob/main/README.adoc

Install all Spring artifacts into your local Maven cache using the Gradle wrapper. This command requires JDK 17+ and a successful Git clone.

```bash
./gradlew install
```

--------------------------------

### Get a Single Region in a State Machine

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-accessor.adoc

Use `withRegion` to get a specific Region instance within a state machine. Requires JDK 8 lambdas for non-verbose code.

```java
stateMachine.withRegion("regionId", new StateMachineFunction<Object, Object>() {

	@Override
	public void apply(StateMachineAccess<Object, Object> access) throws Exception {
		System.out.println("Region " + access.getRegion().getId() + " " + access.getRegion().getState().getId());
	}

});
```

--------------------------------

### Run Project Build and Tests

Source: https://github.com/spring-projects/spring-statemachine/blob/main/CONTRIBUTING.md

Command sequence to clean and build the project using Gradle.

```bash
cd spring-statemachine
./gradlew clean build
```

--------------------------------

### height([num], [skipListeners])

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.MuteToggle.md

Gets or sets the height of the component. Accepts CSS values. When setting, only pixel values are effective; percentage values are not directly computed. When getting, it returns the computed height.

```APIDOC
## height([num], [skipListeners])

### Description
Get or set the height of the component (CSS values).

Setting the video tag dimension values only works with values in pixels. Percent values will not work. Some percents can be used, but width()/height() will return the number + %, not the actual computed width/height.

### Method
`height([num], [skipListeners])`

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Parameters
* __num__ (Number|String) - _Optional_ - The new component height.
* __skipListeners__ (Boolean) - _Optional_ - Skip the resize event trigger.

### Returns
* `vjs.Component` - This component, when setting the height.
* `Number|String` - The height, when getting.
```

--------------------------------

### Configure Submachine with JPA Repository

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-repository.adoc

Demonstrates manual creation of a submachine configuration using JPA repositories.

```java
include::samples/DocsJpaRepositorySampleTests1.java[tags=snippetB]
```

--------------------------------

### Set or Get Component Height

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Menu.md

Allows getting or setting the height of a component using CSS values. Note that only pixel values are effective for setting dimensions; percentage values may not compute correctly.

```javascript
this.height(num, skipListeners);
```

--------------------------------

### Get or Set Component Height

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.FullscreenToggle.md

Gets or sets the height of the component using CSS values. Pixel values are required for setting dimensions on the video tag; percentage values may not work as expected.

```javascript
Setting the video tag dimension values only works with values in pixels.
Percent values will not work.
Some percents can be used, but width()/height() will return the number + %, not the actual computed width/height.
```

--------------------------------

### Component Initialization

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.RemainingTimeDisplay.md

Method for initializing a component with player and options.

```APIDOC
## init( player, options )

### Description
Initializes the component with the provided player instance and options.

### Method
POST

### Endpoint
N/A (Method on component instance)

### Parameters
#### Path Parameters
* __player__ - The player instance associated with this component.
* __options__ - An object containing configuration options for the component.
```

--------------------------------

### Run Scope State Machine Sample

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-scope.adoc

Execute the compiled JAR file to start the state machine application.

```text
# java -jar spring-statemachine-samples-scope-{revnumber}.jar
```

--------------------------------

### Configure State Machine with Session Scope (Adapter)

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-scopes.adoc

Example of using a configuration adapter to set up a state machine for session scope. Requires proxyMode to be TARGET_CLASS.

```java
@Configuration
public class StateMachineConfig extends StateMachineConfigurerAdapter<String, String> {

    @Override
    public void configure(StateMachineBuilder.Builder<String, String> builder) throws Exception {
        builder.configureConfiguration()
            .withConfiguration()
            .autoStartup(false)
            .beanIds("stateMachine");
    }

    @Bean(name = StateMachineSystemConstants.DEFAULT_STATE_MACHINE_ID)
    @Scope(value = "session", proxyMode = ScopedProxyMode.TARGET_CLASS)
    public StateMachine<String, String> stateMachine() {
        return super.getStateMachine();
    }
}
```

--------------------------------

### Set or Get Component Width

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.MenuButton.md

Sets or gets the width of the component using CSS values. Note that when setting the width, only pixel values are reliably supported; percentage values may not produce the expected computed width.

```javascript
this.width(300);
var currentWidth = this.width();
```

--------------------------------

### Run Data Persist Sample

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-datapersist.adoc

Commands to execute the application with specific persistence profiles.

```text
# java -jar spring-statemachine-samples-datapersist-{revnumber}.jar
```

```text
# java -jar spring-statemachine-samples-datapersist-{revnumber}.jar --spring.profiles.active=jpa
# java -jar spring-statemachine-samples-datapersist-{revnumber}.jar --spring.profiles.active=mongo
# java -jar spring-statemachine-samples-datapersist-{revnumber}.jar --spring.profiles.active=redis
```

--------------------------------

### height()

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Player.md

Get or set the height of the component.

```APIDOC
## height()

### Description
Get or set the height of the component (CSS values).

### Parameters
#### Query Parameters
- **num** (Number|String) - Optional - New component height.
- **skipListeners** (Boolean) - Optional - Skip the resize event trigger.

### Response
#### Success Response (200)
- **result** (vjs.Component|Number|String) - Returns the component when setting, or the height when getting.
```

--------------------------------

### Using State Machine Lifecycle Annotations

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-context.adoc

Shows how to listen to state machine start, stop, and error events.

```java
include::samples/DocsConfigurationSampleTests4.java[tags=snippetI]
```

```java
include::samples/DocsConfigurationSampleTests4.java[tags=snippetII]
```

--------------------------------

### error()

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Player.md

Set or get the current MediaError.

```APIDOC
## error()

### Description
Set or get the current MediaError.

### Parameters
#### Request Body
- **err** (*) - Required - A MediaError or a String/Number to be turned into a MediaError.

### Response
#### Success Response (200)
- **result** (vjs.MediaError|null|vjs.Player) - Returns MediaError/null when getting, or vjs.Player when setting.
```

--------------------------------

### Configure State Machine with Session Scope (Builder)

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-scopes.adoc

Example of building a state machine manually and configuring it for session scope. Ensure proxyMode is set to TARGET_CLASS.

```java
    @Bean(name = "stateMachineFactory")
    public StateMachineFactory<String, String> stateMachineFactory() {
        StateMachineBuilder.Builder<String, String> builder = StateMachineBuilder.builder();
        builder.configureConfiguration()
            .withConfiguration()
            .autoStartup(false)
            .beanIds("stateMachine");
        return new DefaultStateMachineFactory<>(builder.build());
    }

    @Bean(name = StateMachineSystemConstants.DEFAULT_STATE_MACHINE_ID)
    @Scope(value = "session", proxyMode = ScopedProxyMode.TARGET_CLASS)
    public StateMachine<String, String> stateMachine() {
        return stateMachineFactory().getStateMachine();
    }
```

--------------------------------

### GET /name

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.VolumeHandle.md

Retrieves the component's name.

```APIDOC
## GET /name

### Description
Get the component's name, often used to reference the component.

### Returns
- **String** - The component name.
```

--------------------------------

### Run Event Service Demo

Source: https://github.com/spring-projects/spring-statemachine/blob/main/docs/src/reference/asciidoc/sm-examples-eventservice.adoc

Command to run the Spring Boot-based sample application. Requires a Redis server running on localhost.

```text
mvn spring-boot:run -Dspring-boot.run.jvmArguments='-Dspring.redis.host=localhost -Dspring.redis.port=6379'
```

--------------------------------

### PUT /height

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.VolumeHandle.md

Gets or sets the height of the component.

```APIDOC
## PUT /height

### Description
Get or set the height of the component using CSS values.

### Parameters
#### Request Body
- **num** (Number|String) - Optional - New component height.
- **skipListeners** (Boolean) - Optional - Skip the resize event trigger.

### Returns
- **vjs.Component|Number|String** - Returns the component when setting, or the height when getting.
```

--------------------------------

### Initialize Component with Options

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.ChaptersTrackMenuItem.md

Initializes a component, often used internally during player setup. It accepts player instance and options.

```javascript
init( player, options )
```

--------------------------------

### GET /getChild

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.VolumeHandle.md

Retrieves a child component by its name.

```APIDOC
## GET /getChild

### Description
Returns a child component with the provided name.

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the child component.

### Returns
- **vjs.Component** - The child component instance.
```

--------------------------------

### Clone Video.js Repository

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/CONTRIBUTING.md

Clone your fork of the Video.js repository to your local machine. This is the first step to setting up a development environment.

```bash
git clone https://github.com/<your-username>/video.js.git
```

--------------------------------

### GET/POST /height

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.VolumeBar.md

Gets or sets the height of the component.

```APIDOC
## GET/POST /height

### Description
Get or set the height of the component (CSS values). Setting the video tag dimension values only works with values in pixels.

### Parameters
#### Query Parameters
- **num** (Number|String) - Optional - New component height.
- **skipListeners** (Boolean) - Optional - Skip the resize event trigger.

### Returns
- **vjs.Component** - This component, when setting the height.
- **Number|String** - The height, when getting.
```

--------------------------------

### duration()

Source: https://github.com/spring-projects/spring-statemachine/blob/main/spring-statemachine-samples/web/src/main/resources/static/lib/videojs/docs/api/vjs.Player.md

Get the length in time of the video in seconds.

```APIDOC
## duration()

### Description
Get the length in time of the video in seconds. Note: The video must have started loading before the duration can be known.

### Parameters
#### Query Parameters
- **seconds** (Number) - Required - The duration of the video in seconds.
```