# mulesoft Spring Module - Full Documentation

<!-- document id=9f6832641282a6a2b24fbaa19a1f4bc4e2feca9d3a02ee1d7a02e3631ef88a65 url=/mulesoft/current/en-us/spring-module/2.0/index.md -->

---
product: Spring Module
version: 2.0
---

# Spring Module 2.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Spring Module enables Mule apps to use the Spring framework.

Release Notes:
[Spring Module Release Notes](https://docs.mulesoft.com/release-notes/connector/spring-module-release-notes)  
Exchange: [Spring Module](https://www.mulesoft.com/exchange/org.mule.modules/mule-spring-module/)

## Add Spring Module to Your Project

In Anypoint Studio 7, Spring module is provided in the default configuration.

In **Mule Palette**, search for "Spring" and drag the Authorization Filter operation to the Studio
canvas.

## Configure Spring Module

1.  Add the following configuration:

    ```xml
    <?xml version="1.0" encoding="UTF-8"?>

    <mule xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
          xmlns="http://www.mulesoft.org/schema/mule/core"
          xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
            http://www.mulesoft.org/schema/mule/core/current/mule.xsd
            http://www.mulesoft.org/schema/mule/spring
            http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">

        <spring:config name="springConfig" files="beans.xml" />

    </mule>
    ```

2.  Put the `beans.xml` file in `src/main/resources`.

    The Spring configuration must be valid. Here is an example beans.xml file:

    ```xml
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:jdbc="http://www.springframework.org/schema/jdbc"

        xsi:schemaLocation="http://www.springframework.org/schema/beans
          http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
          http://www.springframework.org/schema/jdbc
          http://www.springframework.org/schema/jdbc/spring-jdbc-4.2.xsd
          http://www.springframework.org/schema/context
          http://www.springframework.org/schema/context/spring-context-4.2.xsd
          http://www.springframework.org/schema/security
          http://www.springframework.org/schema/security/spring-security-4.2.xsd">

        <jdbc:embedded-database id="dataSource" type="DERBY">
            <jdbc:script location="classpath:db/sql/create-db.sql" />
            <jdbc:script location="classpath:db/sql/insert-data.sql" />
        </jdbc:embedded-database>

    </beans>
    ```

You must export the beans files used with the Spring module for your application to start. See
[How to Export Resources](https://docs.mulesoft.com/mule-runtime/latest/how-to-export-resources).

If you are using Anypoint Studio 7.x, you don’t need to manually update the `mule-artifact.json`
file.

Because Mule also needs a descriptor where the Spring beans are declared, so the embedded packager
within Studio automatically generates one with all the resources it picks up from the project.
However, if you choose to declare the resources you need to export, then Studio packages only those
resources.

The following example enables you to declare your `beans.xml` file in `mule-artifact.json`:

```example
{
    "name": "MyApp",
    "minMuleVersion": "4.2.1",
    "classLoaderModelLoaderDescriptor": {
        "id": "mule",
        "attributes": {
            "exportedResources": [
                "/org/mule/myapp/beans.xml"
            ]
        }
    }
  }
}
```

## Spring Objects in Mule Components

You can use Spring objects in Mule configuration components (for instance, to point to the Derby
data source created with Spring beans) as follows:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:db="http://www.mulesoft.org/schema/mule/db"
      xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
        http://www.mulesoft.org/schema/mule/core/current/mule.xsd
        http://www.mulesoft.org/schema/mule/spring
        http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
        http://www.mulesoft.org/schema/mule/db
        http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd">

    <spring:config name="springConfig" files="beans.xml" />

    <db:config name="derbyConfig" doc:name="Database Config"  >
        <db:derby-connection database="datasource" create="true" />
    </db:config>
</mule>
```

## Spring Properties Placeholders

You cannot use the properties defined by Spring properties placeholders within your Mule app
configuration; you can use them only in Spring configuration files. However, you can use properties
defined in Mule through `<configuration-properties/>` within Spring configuration files.

## Limitations of Spring Objects

To use Spring module, consider implementation and injection limits:

- Spring objects cannot implement Mule API lifecycle methods.

- Spring objects cannot be injected with Mule API services. The only service that can be used is the
  `org.mule.runtime.api.artifact.Registry`, which can be used to access any other service within the
  Mule API. This can be accomplished by using `@PostConstruct` over a method to initialize the
  object and retrieve the Mule API service.

## Use Spring Security as a Security Manager

> [!IMPORTANT] If you use Spring Framework 5.x with plain text passwords, you must prefix the
> password value with `{noop}`. For example, the password `admin` would be `{noop}admin` instead.

The Spring module supports the use of Spring security as a security manager in Mule apps. You must
define an authentication manager in the Spring configuration file:

```xml
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:jdbc="http://www.springframework.org/schema/jdbc"
  xmlns:ss="http://www.springframework.org/schema/security"

  xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
      http://www.springframework.org/schema/jdbc
      http://www.springframework.org/schema/jdbc/spring-jdbc-4.2.xsd
      http://www.springframework.org/schema/context
      http://www.springframework.org/schema/context/spring-context-4.2.xsd
      http://www.springframework.org/schema/security
      http://www.springframework.org/schema/security/spring-security-4.2.xsd">

  <ss:authentication-manager alias="authenticationManager">
    <ss:authentication-provider>
      <ss:user-service id="userService">
        <ss:user name="admin" password="admin" authorities="ROLE_ADMIN" />
        <ss:user name="joe" password="secret" authorities="ROLE_ADMIN" />
        <ss:user name="anon" password="anon" authorities="ROLE_ANON" />
        <ss:user name="user" password="password" authorities="ROLE_ANON" />
        <ss:user name="ross" password="ross" authorities="ROLE_ANON" />
        <ss:user name="marie" password="marie" authorities="ROLE_ANON" />
      </ss:user-service>
    </ss:authentication-provider>
  </ss:authentication-manager>

</beans>
```

You can define a security manager within a Mule app that makes use of the Spring authentication
manager like this:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule
  xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-current.xsd
    http://www.mulesoft.org/schema/mule/core
    http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/spring
    http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">

  <spring:config name="springConfig" files="beans.xml" />

  <spring:security-manager>
    <spring:delegate-security-provider
      name="memory-provider"
      delegate-ref="authenticationManager" />
  </spring:security-manager>

</mule>
```

## Validate Authentication with the Spring Authorization Filter

The Spring module adds support for a filter that fails if authentication cannot be validated using
the Mule Security Manager:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule
  xmlns:http="http://www.mulesoft.org/schema/mule/http"
  xmlns:db="http://www.mulesoft.org/schema/mule/db"
  xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-current.xsd
    http://www.mulesoft.org/schema/mule/core
    http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/spring
    http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
    http://www.mulesoft.org/schema/mule/db
    http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd
    http://www.mulesoft.org/schema/mule/http
    http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd">

  <spring:config name="springConfig" files="beans.xml" />

  <spring:security-manager>
    <spring:delegate-security-provider
      name="memory-provider"
      delegate-ref="authenticationManager" />
  </spring:security-manager>

  <http:listener-config
    name="HTTP_Listener_config"
     doc:name="HTTP Listener config"  >
      <http:listener-connection
        host="0.0.0.0"
        port="9090" />
  </http:listener-config>

  <flow name="spring-exampleFlow"  >
    <http:listener
      config-ref="HTTP_Listener_config"
      path="/"
      doc:name="Listener"  />
    <http:basic-security-filter
      realm="mule" />
      <spring:authorization-filter
        requiredAuthorities="ROLE_ADMIN" />
  </flow>
</mule>
```

The `http:basic-security-filter` tries to authenticate the user using basic authentication. If the
request is authenticated successfully, Mule retrieves the username and uses it in the Spring
`authorization-filter` to search for that user and to try to authorize the request against the
authority ROLE\_ADMIN.

## See Also

- [Property Placeholders in Mule Apps](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

- [Migrate the Spring Module to Mule 4](https://docs.mulesoft.com/mule-runtime/latest/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=a86b5805b191204581110c8f8dbf17bee99cbfa2c2a70e5e407dfdd9b038eccb url=/mulesoft/current/en-us/spring-module/2.0/spring-module-reference.md -->

---
product: Spring Module
version: 2.0
---

# Spring Module 2.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Spring Module enables Mule apps to use the Spring framework.

## Configurations

---

### Config

Spring configuration that enables you to define a set of spring XML files and create an application
context with objects to use in the Mule artifact.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Spring beans file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of this element used to reference it in other components.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## Operations

### Authorization Filter

`<spring:authorization-filter>`

Authorizes users against a required set of authorities.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Required Authorities</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The authorities that grants the user further access to the flow, for example, <code>ROLE_ADMIN</code>,<code>ROLE_USER</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Throws

- MULE:NOT\_PERMITTED

- MULE:SERVER\_SECURITY

## Types

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Source</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><p>Source of the error.</p></td><td></td><td></td></tr><tr><td><p>Target</p></td><td><div><div><p>String</p></div></div></td><td><p>Target of the error.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

### Delegate Security Provider

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Provider name to reference.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Delegate Ref</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Spring security manager.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Authentication Provider Ref</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Authentication provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## See Also

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=51adbf1a8f6eb1ab66d40ecc35d9e2890cc7914192505291385d0206ca85f2c6 url=/mulesoft/current/en-us/spring-module/2.1/index.md -->

---
product: Spring Module
version: 2.1
---

# Spring Module 2.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Spring Module enables Mule apps to use the Spring framework.

Release Notes:
[Spring Module Release Notes](https://docs.mulesoft.com/release-notes/connector/spring-module-release-notes)  
Exchange: [Spring Module](https://www.mulesoft.com/exchange/org.mule.modules/mule-spring-module/)

## Add Spring Module to Your Project

In Anypoint Studio 7, Spring module is provided in the default configuration.

In **Mule Palette**, search for "Spring" and drag the Authorization Filter operation to the Studio
canvas.

## Configure Spring Module

1.  Add the following configuration:

    ```xml
    <?xml version="1.0" encoding="UTF-8"?>

    <mule xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
          xmlns="http://www.mulesoft.org/schema/mule/core"
          xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
            http://www.mulesoft.org/schema/mule/core/current/mule.xsd
            http://www.mulesoft.org/schema/mule/spring
            http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">

        <spring:config name="springConfig" files="beans.xml" />

    </mule>
    ```

2.  Put the `beans.xml` file in `src/main/resources`.

    The Spring configuration must be valid. Here is an example beans.xml file:

    ```xml
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:jdbc="http://www.springframework.org/schema/jdbc"

        xsi:schemaLocation="http://www.springframework.org/schema/beans
          http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
          http://www.springframework.org/schema/jdbc
          http://www.springframework.org/schema/jdbc/spring-jdbc-4.2.xsd
          http://www.springframework.org/schema/context
          http://www.springframework.org/schema/context/spring-context-4.2.xsd
          http://www.springframework.org/schema/security
          http://www.springframework.org/schema/security/spring-security-4.2.xsd">

        <jdbc:embedded-database id="dataSource" type="DERBY">
            <jdbc:script location="classpath:db/sql/create-db.sql" />
            <jdbc:script location="classpath:db/sql/insert-data.sql" />
        </jdbc:embedded-database>

    </beans>
    ```

You must export the beans files used with the Spring module for your application to start. See
[How to Export Resources](https://docs.mulesoft.com/mule-runtime/latest/how-to-export-resources).

If you are using Anypoint Studio 7.x, you don’t need to manually update the `mule-artifact.json`
file.

Because Mule also needs a descriptor where the Spring beans are declared, so the embedded packager
within Studio automatically generates one with all the resources it picks up from the project.
However, if you choose to declare the resources you need to export, then Studio packages only those
resources.

The following example enables you to declare your `beans.xml` file in `mule-artifact.json`:

```example
{
    "name": "MyApp",
    "minMuleVersion": "4.2.1",
    "classLoaderModelLoaderDescriptor": {
        "id": "mule",
        "attributes": {
            "exportedResources": [
                "/org/mule/myapp/beans.xml"
            ]
        }
    }
  }
}
```

## Spring Objects in Mule Components

You can use Spring objects in Mule configuration components (for instance, to point to the Derby
data source created with Spring beans) as follows:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:db="http://www.mulesoft.org/schema/mule/db"
      xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
        http://www.mulesoft.org/schema/mule/core/current/mule.xsd
        http://www.mulesoft.org/schema/mule/spring
        http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
        http://www.mulesoft.org/schema/mule/db
        http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd">

    <spring:config name="springConfig" files="beans.xml" />

    <db:config name="derbyConfig" doc:name="Database Config"  >
        <db:derby-connection database="datasource" create="true" />
    </db:config>
</mule>
```

## Spring Properties Placeholders

You cannot use the properties defined by Spring properties placeholders within your Mule app
configuration; you can use them only in Spring configuration files. However, you can use properties
defined in Mule through `<configuration-properties/>` within Spring configuration files.

## Limitations of Spring Objects

To use Spring module, consider implementation and injection limits:

- Spring objects cannot implement Mule API lifecycle methods.

- Spring objects cannot be injected with Mule API services. The only service that can be used is the
  `org.mule.runtime.api.artifact.Registry`, which can be used to access any other service within the
  Mule API. This can be accomplished by using `@PostConstruct` over a method to initialize the
  object and retrieve the Mule API service.

## Use Spring Security as a Security Manager

> [!IMPORTANT] If you use Spring Framework 5.x with plain text passwords, you must prefix the
> password value with `{noop}`. For example, the password `admin` would be `{noop}admin` instead.

The Spring module supports the use of Spring security as a security manager in Mule apps. You must
define an authentication manager in the Spring configuration file:

```xml
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:jdbc="http://www.springframework.org/schema/jdbc"
  xmlns:ss="http://www.springframework.org/schema/security"

  xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
      http://www.springframework.org/schema/jdbc
      http://www.springframework.org/schema/jdbc/spring-jdbc-4.2.xsd
      http://www.springframework.org/schema/context
      http://www.springframework.org/schema/context/spring-context-4.2.xsd
      http://www.springframework.org/schema/security
      http://www.springframework.org/schema/security/spring-security-4.2.xsd">

  <ss:authentication-manager alias="authenticationManager">
    <ss:authentication-provider>
      <ss:user-service id="userService">
        <ss:user name="admin" password="admin" authorities="ROLE_ADMIN" />
        <ss:user name="joe" password="secret" authorities="ROLE_ADMIN" />
        <ss:user name="anon" password="anon" authorities="ROLE_ANON" />
        <ss:user name="user" password="password" authorities="ROLE_ANON" />
        <ss:user name="ross" password="ross" authorities="ROLE_ANON" />
        <ss:user name="marie" password="marie" authorities="ROLE_ANON" />
      </ss:user-service>
    </ss:authentication-provider>
  </ss:authentication-manager>

</beans>
```

You can define a security manager within a Mule app that makes use of the Spring authentication
manager like this:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule
  xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-current.xsd
    http://www.mulesoft.org/schema/mule/core
    http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/spring
    http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">

  <spring:config name="springConfig" files="beans.xml" />

  <spring:security-manager>
    <spring:delegate-security-provider
      name="memory-provider"
      delegate-ref="authenticationManager" />
  </spring:security-manager>

</mule>
```

## Validate Authentication with the Spring Authorization Filter

The Spring module adds support for a filter that fails if authentication cannot be validated using
the Mule Security Manager:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule
  xmlns:http="http://www.mulesoft.org/schema/mule/http"
  xmlns:db="http://www.mulesoft.org/schema/mule/db"
  xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-current.xsd
    http://www.mulesoft.org/schema/mule/core
    http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/spring
    http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
    http://www.mulesoft.org/schema/mule/db
    http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd
    http://www.mulesoft.org/schema/mule/http
    http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd">

  <spring:config name="springConfig" files="beans.xml" />

  <spring:security-manager>
    <spring:delegate-security-provider
      name="memory-provider"
      delegate-ref="authenticationManager" />
  </spring:security-manager>

  <http:listener-config
    name="HTTP_Listener_config"
     doc:name="HTTP Listener config"  >
      <http:listener-connection
        host="0.0.0.0"
        port="9090" />
  </http:listener-config>

  <flow name="spring-exampleFlow"  >
    <http:listener
      config-ref="HTTP_Listener_config"
      path="/"
      doc:name="Listener"  />
    <http:basic-security-filter
      realm="mule" />
      <spring:authorization-filter
        requiredAuthorities="ROLE_ADMIN" />
  </flow>
</mule>
```

The `http:basic-security-filter` tries to authenticate the user using basic authentication. If the
request is authenticated successfully, Mule retrieves the username and uses it in the Spring
`authorization-filter` to search for that user and to try to authorize the request against the
authority ROLE\_ADMIN.

## See Also

- [Property Placeholders in Mule Apps](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

- [Migrate the Spring Module to Mule 4](https://docs.mulesoft.com/mule-runtime/latest/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=9cbc02d0ee07542c68495aaa3aae3ae83aafd05d87e220c04aacd8859daf1605 url=/mulesoft/current/en-us/spring-module/2.1/spring-module-reference.md -->

---
product: Spring Module
version: 2.1
---

# Spring Module 2.1 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Spring Module enables Mule apps to use the Spring framework.

## Configurations

---

### Config

Spring configuration that enables you to define a set of spring XML files and create an application
context with objects to use in the Mule artifact.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Spring beans file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of this element used to reference it in other components.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## Operations

### Authorization Filter

`<spring:authorization-filter>`

Authorizes users against a required set of authorities.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Required Authorities</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The authorities that grants the user further access to the flow, for example, <code>ROLE_ADMIN</code>,<code>ROLE_USER</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Throws

- MULE:NOT\_PERMITTED

- MULE:SERVER\_SECURITY

## Types

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Source</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><p>Source of the error.</p></td><td></td><td></td></tr><tr><td><p>Target</p></td><td><div><div><p>String</p></div></div></td><td><p>Target of the error.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

### Delegate Security Provider

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Provider name to reference.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Delegate Ref</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Spring security manager.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Authentication Provider Ref</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Authentication provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## See Also

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=c2d1ab70931b405fdbd0d201ef19c710b7022278b792844fda659ab14c69bfb8 url=/mulesoft/current/en-us/spring-module/latest/index.md -->

---
product: Spring Module
version: 2.2
is-latest-version: true
---

# Spring Module 2.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Spring Module enables Mule apps to use the Spring framework.

Release Notes:
[Spring Module Release Notes](https://docs.mulesoft.com/release-notes/connector/spring-module-release-notes)  
Exchange: [Spring Module](https://www.mulesoft.com/exchange/org.mule.modules/mule-spring-module/)

## Add Spring Module to Your Project

In **Mule Palette**, search for "Spring" and drag the Authorization Filter operation to the Studio
canvas.

Starting with version 2.2.0, the Spring libraries that the module needs are defined at the
configuration level instead of the module level. When you add the module to your project, Studio
doesn’t load the Spring libraries automatically, and each Spring Module configuration sets up its
own libraries. Existing apps that use earlier versions of the module continue to work.

> [!IMPORTANT] Spring Module 2.2.0 and later supports Spring Framework 7 and Spring Security 7
> through the `spring:v7-config` element. The `spring:config` element, which uses Spring 6, is
> deprecated. To use Spring 7, create a `spring:v7-config` configuration and complete the library
> setup in [Set Up Spring 7 Libraries in the pom.xml File](https://docs.mulesoft.com/spring-module/latest/spring-xml-maven#spring7-libraries).

## Configure Spring Module

1.  Add the following configuration:

    ```xml
    <?xml version="1.0" encoding="UTF-8"?>

    <mule xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
          xmlns="http://www.mulesoft.org/schema/mule/core"
          xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
            http://www.mulesoft.org/schema/mule/core/current/mule.xsd
            http://www.mulesoft.org/schema/mule/spring
            http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">

        <spring:v7-config name="springConfig" files="beans.xml" />

    </mule>
    ```

    > [!NOTE] To use Spring 6, use `<spring:config>` instead of `<spring:v7-config>`. You can’t use
    > both elements in the same app.

2.  Put the `beans.xml` file in `src/main/resources`.

    The Spring configuration must be valid. Here is an example beans.xml file:

    ```xml
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:jdbc="http://www.springframework.org/schema/jdbc"

        xsi:schemaLocation="http://www.springframework.org/schema/beans
          http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
          http://www.springframework.org/schema/jdbc
          http://www.springframework.org/schema/jdbc/spring-jdbc-4.2.xsd
          http://www.springframework.org/schema/context
          http://www.springframework.org/schema/context/spring-context-4.2.xsd
          http://www.springframework.org/schema/security
          http://www.springframework.org/schema/security/spring-security-4.2.xsd">

        <jdbc:embedded-database id="dataSource" type="DERBY">
            <jdbc:script location="classpath:db/sql/create-db.sql" />
            <jdbc:script location="classpath:db/sql/insert-data.sql" />
        </jdbc:embedded-database>

    </beans>
    ```

You must export the beans files used with the Spring module for your application to start. See
[How to Export Resources](https://docs.mulesoft.com/mule-runtime/latest/how-to-export-resources).

If you are using Anypoint Studio 7.x, you don’t need to manually update the `mule-artifact.json`
file.

Because Mule also needs a descriptor where the Spring beans are declared, so the embedded packager
within Studio automatically generates one with all the resources it picks up from the project.
However, if you choose to declare the resources you need to export, then Studio packages only those
resources.

The following example enables you to declare your `beans.xml` file in `mule-artifact.json`:

```example
{
    "name": "MyApp",
    "minMuleVersion": "4.2.1",
    "classLoaderModelLoaderDescriptor": {
        "id": "mule",
        "attributes": {
            "exportedResources": [
                "/org/mule/myapp/beans.xml"
            ]
        }
    }
  }
}
```

## Spring Objects in Mule Components

You can use Spring objects in Mule configuration components (for instance, to point to the Derby
data source created with Spring beans) as follows:

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:db="http://www.mulesoft.org/schema/mule/db"
      xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
      xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
        http://www.mulesoft.org/schema/mule/core/current/mule.xsd
        http://www.mulesoft.org/schema/mule/spring
        http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
        http://www.mulesoft.org/schema/mule/db
        http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd">

    <spring:config name="springConfig" files="beans.xml" />

    <db:config name="derbyConfig" doc:name="Database Config"  >
        <db:derby-connection database="datasource" create="true" />
    </db:config>
</mule>
```

## Spring Properties Placeholders

You cannot use the properties defined by Spring properties placeholders within your Mule app
configuration; you can use them only in Spring configuration files. However, you can use properties
defined in Mule through `<configuration-properties/>` within Spring configuration files.

## Limitations of Spring Objects

To use Spring module, consider implementation and injection limits:

- Spring objects cannot implement Mule API lifecycle methods.

- Spring objects cannot be injected with Mule API services. The only service that can be used is the
  `org.mule.runtime.api.artifact.Registry`, which can be used to access any other service within the
  Mule API. This can be accomplished by using `@PostConstruct` over a method to initialize the
  object and retrieve the Mule API service.

## Use Spring Security as a Security Manager

> [!IMPORTANT] If you use Spring Framework 5.x with plain text passwords, you must prefix the
> password value with `{noop}`. For example, the password `admin` would be `{noop}admin` instead.

The Spring module supports the use of Spring security as a security manager in Mule apps. You must
define an authentication manager in the Spring configuration file:

```xml
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:jdbc="http://www.springframework.org/schema/jdbc"
  xmlns:ss="http://www.springframework.org/schema/security"

  xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
      http://www.springframework.org/schema/jdbc
      http://www.springframework.org/schema/jdbc/spring-jdbc-4.2.xsd
      http://www.springframework.org/schema/context
      http://www.springframework.org/schema/context/spring-context-4.2.xsd
      http://www.springframework.org/schema/security
      http://www.springframework.org/schema/security/spring-security-4.2.xsd">

  <ss:authentication-manager alias="authenticationManager">
    <ss:authentication-provider>
      <ss:user-service id="userService">
        <ss:user name="admin" password="admin" authorities="ROLE_ADMIN" />
        <ss:user name="joe" password="secret" authorities="ROLE_ADMIN" />
        <ss:user name="anon" password="anon" authorities="ROLE_ANON" />
        <ss:user name="user" password="password" authorities="ROLE_ANON" />
        <ss:user name="ross" password="ross" authorities="ROLE_ANON" />
        <ss:user name="marie" password="marie" authorities="ROLE_ANON" />
      </ss:user-service>
    </ss:authentication-provider>
  </ss:authentication-manager>

</beans>
```

You can define a security manager within a Mule app that makes use of the Spring authentication
manager like this:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule
  xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-current.xsd
    http://www.mulesoft.org/schema/mule/core
    http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/spring
    http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">

  <spring:config name="springConfig" files="beans.xml" />

  <spring:security-manager>
    <spring:delegate-security-provider
      name="memory-provider"
      delegate-ref="authenticationManager" />
  </spring:security-manager>

</mule>
```

## Validate Authentication with the Spring Authorization Filter

The Spring module adds support for a filter that fails if authentication cannot be validated using
the Mule Security Manager:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<mule
  xmlns:http="http://www.mulesoft.org/schema/mule/http"
  xmlns:db="http://www.mulesoft.org/schema/mule/db"
  xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
  xmlns="http://www.mulesoft.org/schema/mule/core"
  xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-current.xsd
    http://www.mulesoft.org/schema/mule/core
    http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/spring
    http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
    http://www.mulesoft.org/schema/mule/db
    http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd
    http://www.mulesoft.org/schema/mule/http
    http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd">

  <spring:config name="springConfig" files="beans.xml" />

  <spring:security-manager>
    <spring:delegate-security-provider
      name="memory-provider"
      delegate-ref="authenticationManager" />
  </spring:security-manager>

  <http:listener-config
    name="HTTP_Listener_config"
     doc:name="HTTP Listener config"  >
      <http:listener-connection
        host="0.0.0.0"
        port="9090" />
  </http:listener-config>

  <flow name="spring-exampleFlow"  >
    <http:listener
      config-ref="HTTP_Listener_config"
      path="/"
      doc:name="Listener"  />
    <http:basic-security-filter
      realm="mule" />
      <spring:authorization-filter
        requiredAuthorities="ROLE_ADMIN" />
  </flow>
</mule>
```

The `http:basic-security-filter` tries to authenticate the user using basic authentication. If the
request is authenticated successfully, Mule retrieves the username and uses it in the Spring
`authorization-filter` to search for that user and to try to authorize the request against the
authority ROLE\_ADMIN.

## See Also

- [Property Placeholders in Mule Apps](https://docs.mulesoft.com/mule-runtime/latest/configuring-properties)

- [Migrate the Spring Module to Mule 4](https://docs.mulesoft.com/mule-runtime/latest/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=9ae763d2e9adfa9cc81dc68bd58e95fd7b8d1a6e6dff7bb72a231ad24f2c1d4d url=/mulesoft/current/en-us/spring-module/latest/spring-module-reference.md -->

---
product: Spring Module
version: 2.2
is-latest-version: true
---

# Spring Module 2.2 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Spring Module enables Mule apps to use the Spring framework.

## Configurations

---

### Config

Spring configuration that enables you to define a set of spring XML files and create an application
context with objects to use in the Mule artifact. This configuration uses Spring Framework 6 and
Spring Security 6 and is deprecated. To use Spring 7, use [7 Config](#v7-config).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Spring beans file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of this element used to reference it in other components.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### 7 Config

`<spring:v7-config>`

Spring configuration that enables you to define a set of spring XML files and create an application
context with objects to use in the Mule artifact. This configuration uses Spring Framework 7 and
Spring Security 7. You can’t use it in the same app as [Config](#config).

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name for this configuration. Connectors reference the configuration with this name.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Files</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The Spring beans file.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The identifier of this element used to reference it in other components.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## Operations

### Authorization Filter

`<spring:authorization-filter>`

Authorizes users against a required set of authorities.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Required Authorities</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The authorities that grants the user further access to the flow, for example, <code>ROLE_ADMIN</code>,<code>ROLE_USER</code>.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Error Mappings</strong></p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><div><div><p>Set of error mappings.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

#### Throws

- MULE:NOT\_PERMITTED

- MULE:SERVER\_SECURITY

## Types

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Source</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><p>Source of the error.</p></td><td></td><td></td></tr><tr><td><p>Target</p></td><td><div><div><p>String</p></div></div></td><td><p>Target of the error.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

### Delegate Security Provider

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Provider name to reference.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Delegate Ref</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Spring security manager.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Authentication Provider Ref</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Authentication provider.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

## See Also

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=99a1c654a99bebb46f0c580b5e3e16894f2351184efc556c9f617b6b29f14fa5 url=/mulesoft/current/en-us/spring-module/2.0/spring-xml-maven.md -->

---
product: Spring Module
version: 2.0
---

# Spring Module XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio.

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can get access to the connector in your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

When you add the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/spring
http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/spring
	http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-spring-module</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `spring module`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=8d81d118f062a9a38f5e5cacdf8346082d65645c44618be7f8b468a301b1e532 url=/mulesoft/current/en-us/spring-module/2.1/spring-xml-maven.md -->

---
product: Spring Module
version: 2.1
---

# Spring Module XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio.

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can get access to the connector in your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

When you add the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/spring
http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/spring
	http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-spring-module</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `spring module`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=1575f40a4ce311aa7fb4f0c7965f34aaebcda4874d615ff57c7c91b3e7a1bc26 url=/mulesoft/current/en-us/spring-module/latest/spring-xml-maven.md -->

---
product: Spring Module
version: 2.2
is-latest-version: true
---

# Spring Module XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio.

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can get access to the connector in your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

When you add the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/spring
http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:spring="http://www.mulesoft.org/schema/mule/spring"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/spring
	http://www.mulesoft.org/schema/mule/spring/current/mule-spring.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-spring-module</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `spring module`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## Set Up Spring 7 Libraries in the pom.xml File

Spring Module 2.2.0 and later defines the required Spring libraries at the configuration level. When
you create a `spring:v7-config` configuration, Anypoint Studio and Anypoint Code Builder can display
Spring 6 libraries (`spring-beans`, `spring-context`, and `spring-core`) as loaded. In Studio,
selecting **Remove configured library** has no effect, and in Anypoint Code Builder, the required
libraries parameter isn’t displayed. Don’t rely on the libraries shown in the configuration screen.

To use Spring 7, manually edit the `pom.xml` file of your project. These steps apply to both
Anypoint Studio and Anypoint Code Builder.

1.  Add the Spring libraries as shared libraries in the `configuration` element of the
    `mule-maven-plugin`:

    ```xml
    <configuration>
        <sharedLibraries>
            <sharedLibrary>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
            </sharedLibrary>
            <sharedLibrary>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
            </sharedLibrary>
            <sharedLibrary>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
            </sharedLibrary>
            <sharedLibrary>
                <groupId>org.springframework.security</groupId>
                <artifactId>spring-security-config</artifactId>
            </sharedLibrary>
            <sharedLibrary>
                <groupId>org.springframework.security</groupId>
                <artifactId>spring-security-crypto</artifactId>
            </sharedLibrary>
            <sharedLibrary>
                <groupId>org.springframework.security</groupId>
                <artifactId>spring-security-core</artifactId>
            </sharedLibrary>
            <sharedLibrary>
                <groupId>org.springframework.security</groupId>
                <artifactId>spring-security-access</artifactId>
            </sharedLibrary>
        </sharedLibraries>
    </configuration>
    ```

2.  Add the Spring 7 libraries as dependencies in the `dependencies` element:

    ```xml
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-beans</artifactId>
        <version>7.0.9</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>7.0.9</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>7.0.9</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.security</groupId>
        <artifactId>spring-security-config</artifactId>
        <version>7.1.1</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.security</groupId>
        <artifactId>spring-security-crypto</artifactId>
        <version>7.1.1</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.security</groupId>
        <artifactId>spring-security-core</artifactId>
        <version>7.1.1</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.security</groupId>
        <artifactId>spring-security-access</artifactId>
        <version>7.1.1</version>
    </dependency>
    ```

These are the library versions:

- Spring Framework (`spring-beans`, `spring-context`, and `spring-core`): 7.0.9

- Spring Security (`spring-security-config`, `spring-security-crypto`, `spring-security-core`, and
  `spring-security-access`): 7.1.1

You must list each library as both a dependency and a shared library. The `spring-security-access`
library is optional. Add it only if your app uses the legacy access API classes that Spring Security
7 moved to this library.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=f2c627737f0ba111b437ee7a0ea10963c91ee51f472a6635ebb4b361cef4079f url=/mulesoft/current/en-us/spring-module/2.0/spring-module-troubleshooting.md -->

---
product: Spring Module
version: 2.0
---

# Troubleshooting Spring Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Spring Module, become familiar with the information about enabling verbose logging
and interpreting commonly thrown messages.

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with Spring module is failing,
temporarily enable verbose logging for the module.

Remember to always disable the enhanced verbosity after troubleshooting, because it affects your
Mule application performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` path folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="org.mule.extension.spring" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Common Throws

Here is a list of common throw messages and how to interpret them:

- MULE:NOT\_PERMITTED

  Occurs when there is a security restriction enforced by a filter; for example, when using the
  authorization filter of the Spring module.

- MULE:SERVER\_SECURITY

  Occurs when there is a security error enforced by Mule runtime engine (Mule).

## See Also

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=f910560b844b5b30ca258b427af6bc6dc363d2fd260692a89dcac65113d74a60 url=/mulesoft/current/en-us/spring-module/2.1/spring-module-troubleshooting.md -->

---
product: Spring Module
version: 2.1
---

# Troubleshooting Spring Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Spring Module, become familiar with the information about enabling verbose logging
and interpreting commonly thrown messages.

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with Spring module is failing,
temporarily enable verbose logging for the module.

Remember to always disable the enhanced verbosity after troubleshooting, because it affects your
Mule application performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` path folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="org.mule.extension.spring" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Common Throws

Here is a list of common throw messages and how to interpret them:

- MULE:NOT\_PERMITTED

  Occurs when there is a security restriction enforced by a filter; for example, when using the
  authorization filter of the Spring module.

- MULE:SERVER\_SECURITY

  Occurs when there is a security error enforced by Mule runtime engine (Mule).

## See Also

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=16c0438d7510faa93013d1288109046c6d04f5b987ce1163030902eb2729a3b4 url=/mulesoft/current/en-us/spring-module/latest/spring-module-troubleshooting.md -->

---
product: Spring Module
version: 2.2
is-latest-version: true
---

# Troubleshooting Spring Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Spring Module, become familiar with the information about enabling verbose logging
and interpreting commonly thrown messages.

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with Spring module is failing,
temporarily enable verbose logging for the module.

Remember to always disable the enhanced verbosity after troubleshooting, because it affects your
Mule application performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` path folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="org.mule.extension.spring" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Common Throws

Here is a list of common throw messages and how to interpret them:

- MULE:NOT\_PERMITTED

  Occurs when there is a security restriction enforced by a filter; for example, when using the
  authorization filter of the Spring module.

- MULE:SERVER\_SECURITY

  Occurs when there is a security error enforced by Mule runtime engine (Mule).

## See Also

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=8c750e1eec37397e12b9a02b6f002bf3a7ccd45151b3992343e7f59b6eaee3f9 url=/mulesoft/current/en-us/spring-module/2.0/spring-module-upgrade-migrate.md -->

---
product: Spring Module
version: 2.0
---

# Upgrading and Migrating Spring Module to Version 2.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Spring Module to version 2.x.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>1.x</p></div></div></td><td><div><div><p>2.x</p></div></div></td></tr></tbody></table>

## Changes in This Release

Spring Module 2.0 includes these changes.

- Spring Module (and its dependencies) are now compilable and compatible only with Java 17.

- To align with modern development practices and ensure continued compatibility with secure and
  supported libraries, Spring Module is upgraded from Spring 5.x to Spring 6.x.

- The structure of the `spring:security-manager` element is updated to resolve validation issues
  with the DSL. Previously, `delegate-security-providers` could be defined directly within
  `spring:security-manager`. Now, all `spring:delegate-security-provider` elements must be wrapped
  within a new `spring:delegate-security-providers` element.

  - Old structure (no longer supported):

    ```xml
    <spring:security-manager doc:name="Spring Security Manager">
       <spring:delegate-security-provider name="memory-provider" delegate-ref="authenticationManager" />
    </spring:security-manager>
    ```

  - New structure (required):

    ```xml
    <spring:security-manager doc:name="Spring Security Manager">
       <spring:delegate-security-providers>
         <spring:delegate-security-provider name="memory-provider" delegate-ref="authenticationManager" />
       </spring:delegate-security-providers>
    </spring:security-manager>
    ```

## Upgrade Prerequisites

Before you perform the upgrade, you must create a backup of your files, data, and configurations in
case you need to restore them.

## Upgrade Steps

Follow these steps to perform the upgrade:

1.  In Anypoint Studio, right-click the project and select **Manage Dependencies** > **Manage
    Modules**.

2.  Select `Spring Module - Mule 4` and click **Update version**.

3.  Click **Apply and Close**.

4.  Verify that the Spring Module dependency version is `2.0.0` in the `pom.xml` file in the Mule
    project.

Alternatively, you can manually update the Spring Module dependency version in the `pom.xml` file in
the Mule project, or simply add the updated module to the project.

### Verify the Upgrade

After you upgrade the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Verify that there are no problems in the project `pom.xml` file.

3.  Test the connection to verify that the operations work.

## Troubleshoot

If there are problems with caching the parameters and caching the metadata, try restarting Anypoint
Studio.

### Revert the Upgrade

If it is necessary to revert to the previous version of Spring Module, change the Spring Module
dependency version `2.0.0` in the project’s `pom.xml` to the previous version.

You must update the project’s `pom.xml` in Anypoint Studio.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Spring Module Reference](https://docs.mulesoft.com/spring-module/2.0/spring-module-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=6c477299ce74a69cacdae3faf1a952aa028a7fed7882fdcede3901dca6d1d485 url=/mulesoft/current/en-us/spring-module/2.1/spring-module-upgrade-migrate.md -->

---
product: Spring Module
version: 2.1
---

# Upgrading and Migrating Spring Module to Version 2.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Spring Module to version 2.x.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>1.x</p></div></div></td><td><div><div><p>2.x</p></div></div></td></tr></tbody></table>

## Changes in This Release

Spring Module 2.0 includes these changes.

- Spring Module (and its dependencies) are now compilable and compatible only with Java 17.

- To align with modern development practices and ensure continued compatibility with secure and
  supported libraries, Spring Module is upgraded from Spring 5.x to Spring 6.x.

- The structure of the `spring:security-manager` element is updated to resolve validation issues
  with the DSL. Previously, `delegate-security-providers` could be defined directly within
  `spring:security-manager`. Now, all `spring:delegate-security-provider` elements must be wrapped
  within a new `spring:delegate-security-providers` element.

  - Old structure (no longer supported):

    ```xml
    <spring:security-manager doc:name="Spring Security Manager">
       <spring:delegate-security-provider name="memory-provider" delegate-ref="authenticationManager" />
    </spring:security-manager>
    ```

  - New structure (required):

    ```xml
    <spring:security-manager doc:name="Spring Security Manager">
       <spring:delegate-security-providers>
         <spring:delegate-security-provider name="memory-provider" delegate-ref="authenticationManager" />
       </spring:delegate-security-providers>
    </spring:security-manager>
    ```

## Upgrade Prerequisites

Before you perform the upgrade, you must create a backup of your files, data, and configurations in
case you need to restore them.

## Upgrade Steps

Follow these steps to perform the upgrade:

1.  In Anypoint Studio, right-click the project and select **Manage Dependencies** > **Manage
    Modules**.

2.  Select `Spring Module - Mule 4` and click **Update version**.

3.  Click **Apply and Close**.

4.  Verify that the Spring Module dependency version is `2.0.0` in the `pom.xml` file in the Mule
    project.

Alternatively, you can manually update the Spring Module dependency version in the `pom.xml` file in
the Mule project, or simply add the updated module to the project.

### Verify the Upgrade

After you upgrade the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Verify that there are no problems in the project `pom.xml` file.

3.  Test the connection to verify that the operations work.

## Troubleshoot

If there are problems with caching the parameters and caching the metadata, try restarting Anypoint
Studio.

### Revert the Upgrade

If it is necessary to revert to the previous version of Spring Module, change the Spring Module
dependency version `2.0.0` in the project’s `pom.xml` to the previous version.

You must update the project’s `pom.xml` in Anypoint Studio.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Spring Module Reference](https://docs.mulesoft.com/spring-module/2.1/spring-module-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=c599db7c31f691b1dd42921d9594de7f27d003658eec038896a596ac90f9445e url=/mulesoft/current/en-us/spring-module/latest/spring-module-upgrade-migrate.md -->

---
product: Spring Module
version: 2.2
is-latest-version: true
---

# Upgrading and Migrating Spring Module to Version 2.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Spring Module to version 2.x.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>1.x</p></div></div></td><td><div><div><p>2.x</p></div></div></td></tr></tbody></table>

## Changes in This Release

Spring Module 2.0 includes these changes.

- Spring Module (and its dependencies) are now compilable and compatible only with Java 17.

- To align with modern development practices and ensure continued compatibility with secure and
  supported libraries, Spring Module is upgraded from Spring 5.x to Spring 6.x.

- The structure of the `spring:security-manager` element is updated to resolve validation issues
  with the DSL. Previously, `delegate-security-providers` could be defined directly within
  `spring:security-manager`. Now, all `spring:delegate-security-provider` elements must be wrapped
  within a new `spring:delegate-security-providers` element.

  - Old structure (no longer supported):

    ```xml
    <spring:security-manager doc:name="Spring Security Manager">
       <spring:delegate-security-provider name="memory-provider" delegate-ref="authenticationManager" />
    </spring:security-manager>
    ```

  - New structure (required):

    ```xml
    <spring:security-manager doc:name="Spring Security Manager">
       <spring:delegate-security-providers>
         <spring:delegate-security-provider name="memory-provider" delegate-ref="authenticationManager" />
       </spring:delegate-security-providers>
    </spring:security-manager>
    ```

## Upgrade Prerequisites

Before you perform the upgrade, you must create a backup of your files, data, and configurations in
case you need to restore them.

## Upgrade Steps

Follow these steps to perform the upgrade:

1.  In Anypoint Studio, right-click the project and select **Manage Dependencies** > **Manage
    Modules**.

2.  Select `Spring Module - Mule 4` and click **Update version**.

3.  Click **Apply and Close**.

4.  Verify that the Spring Module dependency version is `2.0.0` in the `pom.xml` file in the Mule
    project.

Alternatively, you can manually update the Spring Module dependency version in the `pom.xml` file in
the Mule project, or simply add the updated module to the project.

### Verify the Upgrade

After you upgrade the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Verify that there are no problems in the project `pom.xml` file.

3.  Test the connection to verify that the operations work.

## Troubleshoot

If there are problems with caching the parameters and caching the metadata, try restarting Anypoint
Studio.

### Revert the Upgrade

If it is necessary to revert to the previous version of Spring Module, change the Spring Module
dependency version `2.0.0` in the project’s `pom.xml` to the previous version.

You must update the project’s `pom.xml` in Anypoint Studio.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Spring Module Reference](https://docs.mulesoft.com/spring-module/latest/spring-module-reference)

- [Salesforce Help](https://help.salesforce.com)