--- schema_version: "1" id: 6b95514b36b7cc5085007a1e1e7f03b0f2aede539928d19e9c3416e6ebaf835d title: Java Module 2.0 Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/java-module/latest/java-reference.md canonical_url: https://docs.mulesoft.com/java-module/latest/java-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 3f67e9dbe630346e7b04046e933adba5df8107c977ba535cc0ae7bd6c9561f0e description: MuleSoft Documentation Site release: "2.0" latest: true --- # Java Module 2.0 Reference Java Module is used to invoke Java code. Release Notes: [Java Module Release Notes](https://docs.mulesoft.com/release-notes/connector/java-module) ## [](#configurations)Configurations * * * ### [](#config)Default Configuration Default configuration #### [](#parameters)Parameters
Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Name

String

The identifier of this element used to reference it in other components.

x
## [](#operations)Operations - [Invoke](#invoke) - [Invoke Static](#invokeStatic) - [New](#new) - [Validate Type](#validateType) ### [](#invoke)Invoke `` Invoke methods with the provided arguments in an instance. The identifier of the method to invoke includes the class and method names, being the method a full description of its signature including the types of each parameter. For example, to invoke the `echo` method with the signature `public String echo(String msg)` that belongs to `Class org.bar.Me`, then the identifier of the method is `echo(String)`. #### [](#parameters-2)Parameters
Name Type Description Default Value Required

Instance

Any

The instance on which the method is invoked.

x

Args

Object

The arguments used to invoke a method.

This field must be a map where the keys are the names of the method arguments and the values are the corresponding argument values.

For example, if there is a method echo with the signature public String echo(String msg, String volume), a possible value for Args is [{ msg : 'This is a message to echo', volume : 'Loud' }]. To use those argument names, the Java class must be compiled with -parameters. If not, you must use the canonical names for the arguments: [{ arg0 : 'This is a message to echo', arg1 : 'Loud' }]. You can always use the canonical name for the arguments, even if the source code is compiled with -parameters.

Output Mime Type

String

MIME type of the payload that this invocation outputs.

Output Encoding

String

Encoding of the payload that this invocation outputs.

Class

String

Represents the fully qualified name of the class containing the referenced method.

x

Method

String

Represents the method signature containing the method name and its argument types. For example, for the method with signature, public String log(String msg, boolean verbose), then the identifier of the method is log(String, boolean)

x

Target Variable

String

The name of a variable in which to place the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.
#### [](#output)Output

Type

Any
#### [](#throws)Throws - JAVA:ARGUMENTS\_MISMATCH - JAVA:CLASS\_NOT\_FOUND - JAVA:INVOCATION - JAVA:NO\_SUCH\_METHOD - JAVA:WRONG\_INSTANCE\_CLASS ### [](#invokeStatic)Invoke Static `` Operation that allows the user to invoke static methods with the provided arguments. The identifier of the method to be invoked includes the class and method names, being the method a full description of its signature including the types of each parameter. For example, to invoke the static method `echo` with signature `public static String echo(String msg)` that belongs to `Class org.bar.Me`, then the identifier of the method is `echo(String)`. #### [](#parameters-3)Parameters
Name Type Description Default Value Required

Args

Object

The arguments used to invoke a method.

This field must be a map where the keys are the names of the method arguments and the values are the corresponding argument values.

For example, if there is a method echo with the signature public String echo(String msg, String volume), a possible value for Args is [{ msg : 'This is a message to echo', volume : 'Loud' }]. To use those argument names, the Java class must be compiled with -parameters. If not, you must use the canonical names for the arguments: [{ arg0 : 'This is a message to echo', arg1 : 'Loud' }]. You can always use the canonical name for the arguments, even if the source code is compiled with -parameters.

Output Mime Type

String

MIME type of the payload that this invocation outputs.

Output Encoding

String

Encoding of the payload that this invocation outputs.

Class

String

Represents the fully qualified name of the Class containing the referenced Method.

x

Method

String

Represents the Method signature containing the method name and its argument types. For example, for the method with signature public static String log(String msg, boolean verbose), then the identifier of the method is log(String, boolean).

x

Target Variable

String

The name of a variable in which to place the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.
#### [](#output-2)Output

Type

Any
#### [](#throws-2)Throws - JAVA:CLASS\_NOT\_FOUND - JAVA:ARGUMENTS\_MISMATCH - JAVA:INVOCATION - JAVA:NO\_SUCH\_METHOD ### [](#new)New `` Create a new instance of a class. The identifier of a Constructor includes the class and constructor names, and the constructor has a full description of its signature including the types of each parameter. For example, to invoke the constructor `Me(String name, int age)` which belongs to the `org.bar.Me` class, then the identifier of the method is `Me(String,int)`. #### [](#parameters-4)Parameters
Name Type Description Default Value Required

Args

Object

The arguments used to invoke the given Constructor

Class

String

Represents the fully qualified name of the Class containing the referenced Method.

x

Constructor

String

Represents the Constructor signature that contains the name and its argument types. For example, for the Constructor with the public Me(String name, Integer age) signature, then the identifier of the method is Me(String, Integer).

x

Target Variable

String

The name of a variable in which to place the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output, and to store the outcome of that expression in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.
#### [](#output-3)Output

Type

Any
#### [](#throws-3)Throws - JAVA:ARGUMENTS\_MISMATCH - JAVA:CLASS\_NOT\_FOUND - JAVA:NO\_SUCH\_CONSTRUCTOR - JAVA:NOT\_INSTANTIABLE\_TYPE ### [](#validateType)Validate Type `` Validate that an instance is an `instanceof` a class. #### [](#parameters-5)Parameters
Name Type Description Default Value Required

Class

String

Instance

Any

The object whose type is expected to be an instanceof of a class.

x

Accept Subtypes

Boolean

Whether or not to accept subtypes of a class, or if the instance has to be of the exact same class.

true

Error Mappings

Array of Error Mapping

Set of error mappings.
#### [](#throws-4)Throws - JAVA:CLASS\_NOT\_FOUND - JAVA:WRONG\_INSTANCE\_CLASS ## [](#types)Types ### [](#ErrorMapping)Error Mapping
Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source of the error mapping.

Target

String

Target of the error mapping.

x
## [](#see-also)See Also [Salesforce Help](https://help.salesforce.com)