# Lock

Ensures the integrity of shared data.

## Component Signature

```
<bx:Lock name=[string]
scope=[string]
type=[string]
timeout=[Integer]
throwOnTimeout=[boolean]
cacheName=[string] />
```

### Attributes

| Atrribute        | Type      | Required | Description                                                                                                                                                                                                                                     | Default     |
| ---------------- | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `name`           | `string`  | `false`  | <p>Lock name. Mutually exclusive with the scope attribute. Only one request can execute the code within a lock component with a given<br>name at a time. Cannot be an empty string.</p>                                                         |             |
| `scope`          | `string`  | `false`  | <p>Lock scope. Mutually exclusive with the name attribut Lock name. Only one request in the specified scope can execute the code<br>within this component (or within any other lock component with the same lock scope scope) at a time.</p>    |             |
| `type`           | `string`  | `false`  | readOnly: lets more than one request read shared data. exclusive: lets one request read or write shared data.                                                                                                                                   | `exclusive` |
| `timeout`        | `Integer` | `false`  | <p>Maximum length of time, in seconds, to wait to obtain a lock. If lock is obtained, tag execution continues. Otherwise, behavior<br>depends on throwOnTimeout attribute value. A value of 0 will wait forever.</p>                            | `0`         |
| `throwOnTimeout` | `boolean` | `false`  | <p>True: if lock is not obtained within the timeout period, a runtime exception is thrown. False: if lock is not obtained,<br>the body of the component is skipped and execution continues without running the statements in the component.</p> | `true`      |
| `cacheName`      | `string`  | `false`  |                                                                                                                                                                                                                                                 |             |

## Examples

### Script Syntax

```java
bx:lock timeout="60" scope="session" type="exclusive" {
	session.MYVAR = "Hello";
}

```

### Tag Syntax

```java
<bx:lock timeout="60" scope="session" type="exclusive"> 
 <bx:set session.MYVAR = "Hello" > 
 </bx:lock>
```