org.mule.modules

mule-module-drupal

config

Namespace	http://www.mulesoft.org/schema/mule/drupal
Schema Location	http://www.mulesoft.org/schema/mule/drupal/current/mule-drupal.xsd (View Schema)
Schema Version	1.0
Minimum Mule Version	3.2

Module Overview

Drupal is an open source content management platform powering millions of websites and applications. This connector allow you to integrate with a drupal server running the rest server.

Summary

Configuration
<drupal:config> Configure an instance of this module

Message Processors
<drupal:count-all-comments> Count all comments in a node
<drupal:count-new-comments> Counts all new comments in a node.
<drupal:create-comment> Create a comment.
<drupal:create-file> Create a file
<drupal:create-node> Creates a node.
<drupal:create-taxonomy-term> Create a taxonomy term
<drupal:create-taxonomy-vocabulary> Create a taxonomyVocabulary
<drupal:create-user> Create a User
<drupal:delete-comment> Delete a comment
<drupal:delete-file> Delete a file.
<drupal:delete-node> Delete a node
<drupal:delete-taxonomy-term> Delete a Term
<drupal:delete-taxonomy-vocabulary> Delete a Vocabulary
<drupal:delete-user> Delete an User
<drupal:get-comments-for-node> Get the list of comments of a node
<drupal:get-files-for-node> Get the list of files attached of a node
<drupal:get-nodes-with-term> Get a list of Nodes related to the term
<drupal:get-taxonomy-vocabulary-tree> The the list of terms that match the requirements of the request.
<drupal:index-comments> Get a list of Comments with only the fields specified in the list of fields and the uri field for the comment.
<drupal:index-files> Get a list of files with only the fields specified in the list of fields and the uri field for the File.
<drupal:index-nodes> Get a list of Nodes with only the fields specified in the list of fields and the uri field for the node.
<drupal:index-taxonomy-terms> Get a list of taxonomy terms with only the fields specified in the list of fields and the uri field for the term.
<drupal:index-taxonomy-vocabulary> Get a list of taxonomy vocabulary with only the fields specified in the list of fields and the uri field for the vocabulary.
<drupal:index-users> Get a list of Users with only the fields specified in the list of fields and the uri field for the user.
<drupal:read-comment> Read a comment.
<drupal:read-file> Read a file.
<drupal:read-node> Read a node.
<drupal:read-taxonomy-term> Read a taxonomy term.
<drupal:read-taxonomy-vocabulary> Read a taxonomy vocabulary.
<drupal:read-user> Read an user.
<drupal:register-user> Register a user
<drupal:update-comment> Update the comment
<drupal:update-custom-field-for-node> Update one custom field with the properties set at the map
<drupal:update-file> Update file
<drupal:update-node> Update the node
<drupal:update-taxonomy-term> Update the taxonomy term
<drupal:update-taxonomy-vocabulary> Update the taxonomyVocabulary
<drupal:update-user> Update the user

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:drupal="http://www.mulesoft.org/schema/mule/drupal"
      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/drupal
               http://www.mulesoft.org/schema/mule/drupal/current/mule-drupal.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	apiUrl	/rest/api	Optional. Path to the REST api
xs:string	commentEndpoint	comment	Optional. Path relative to the REST api url for the Comment Resource.
xs:string	fileEndpoint	file	Optional. Path relative to the REST api url for the File Resource.
xs:string	nodeEndpoint	node	Optional. Path relative to the REST api url for the Node Resource.
xs:int	port	8888	Optional. Port of the connecion
xs:string	server	localhost	Optional. Uri of the server
xs:string	taxonomyTermEndpoint	taxonomy_term	Optional. Path relative to the REST api url for the TaxonomyTerm Resource.
xs:string	taxonomyVocabularyEndpoint	taxonomy_vocabulary	Optional. Path relative to the REST api url for the TaxonomyVocabulary Resource.
xs:string	userEndpoint	user	Optional. Path relative to the REST api url for the User Resource.

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <drupal:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		A username	String	/	UTF-8
password		A password	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <drupal:config>
         <reconnect count="5" frequency="1000"/>
    </drupal:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<drupal:count-all-comments>

Count all comments in a node

XML Sample

<drupal:count-all-comments nodeId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
nodeId	Node Id	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
int	Amount of comments on the given node

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:count-new-comments>

Counts all new comments in a node.

XML Sample

<drupal:count-new-comments nodeId="1"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
nodeId		Node Id	int	/
since	0	Optional. Unix like date format. Default value is 0.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
int	Amount of new comments

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:create-comment>

Create a comment.

The comment needs to have the node id set. If the comment is related to another comment in the same node, you need to specify the comment id by setting the pid. See Comment.

XML Sample

<drupal:create-comment>
    <drupal:comment subject="New Comment">
        <drupal:comment-body>
            <drupal:und>
                <drupal:und>
                    <value>Body content value</value>
                </drupal:und>
            </drupal:und>
        </drupal:comment-body>
    </drupal:comment>
</drupal:create-comment>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
comment	#[payload]	Optional. Comment with a subject, body and node id	Comment	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Comment	The comment with the Id set by the server

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:create-file>

Create a file

XML Sample

<drupal:create-file>
    <drupal:file filename="temp.gif" content="ENCODED_CONTENT_BASE64"/>
</drupal:create-file>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
file	#[payload]	Optional. File that has the content encoded in Base64 and the name of the file.	File	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
File	the file with the Id set.

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:create-node>

Creates a node.

XML Sample

<drupal:create-node>
    <drupal:node title="New Article" type="article">
        <drupal:body>
            <drupal:und>
                <drupal:und>
                    <value>Body content value</value>
                </drupal:und>
            </drupal:und>
        </drupal:body>
    </drupal:node>
</drupal:create-node>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node	#[payload]	Optional. Node. The minimum required fields that need to be set are the Type and Title. See `Node`	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Node	The node with the Id set by the server

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:create-taxonomy-term>

Create a taxonomy term

XML Sample

<drupal:create-taxonomy-term>
    <drupal:taxonomy-term name="New term" description="This is a new term" vid="1"/>
</drupal:create-taxonomy-term>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
taxonomyTerm	#[payload]	Optional. TaxonomyTerm	TaxonomyTerm	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
TaxonomyTerm	the same TaxonomyTerm created

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:create-taxonomy-vocabulary>

Create a taxonomyVocabulary

XML Sample

<drupal:create-taxonomy-vocabulary>
    <drupal:taxonomy-vocabulary name="NewVoc" description="New taxonomy Vocabulary" machineName="new_voc"/>
</drupal:create-taxonomy-vocabulary>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
taxonomyVocabulary	#[payload]	Optional. TaxonomyVocabulary	TaxonomyVocabulary	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
TaxonomyVocabulary	the TaxonomyVocabulary.

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned. Error 500 is thrown when the vocabulary already exists

<drupal:create-user>

Create a User

XML Sample

<drupal:create-user>
    <drupal:user name="NewUser" mail="foo@foo.com" password="dummy00"/>
</drupal:create-user>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user	#[payload]	Optional. User with at least Name, mail and password set.	User	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
User	The user with the Id set by the server

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:delete-comment>

Delete a comment

XML Sample

<drupal:delete-comment commentId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	Id of the comment	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:delete-file>

Delete a file. If the file is associated to any content, then it can not be deleted.

XML Sample

<drupal:delete-file fileId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
fileId	Id of the file	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:delete-node>

Delete a node

XML Sample

<drupal:delete-node nodeId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
nodeId	Id of the node	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:delete-taxonomy-term>

Delete a Term

XML Sample

<drupal:delete-taxonomy-term taxonomyTermId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
taxonomyTermId	Id of the term	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:delete-taxonomy-vocabulary>

Delete a Vocabulary

XML Sample

<drupal:delete-taxonomy-vocabulary taxonomyVocId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
taxonomyVocId	Id of the vocabulary	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:delete-user>

Delete an User

XML Sample

<drupal:delete-user userId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userId	Id of the User	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:get-comments-for-node>

Get the list of comments of a node

XML Sample

<drupal:get-comments-for-node nodeId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
nodeId	The id of the node	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Comment>	List of Comment

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:get-files-for-node>

Get the list of files attached of a node

XML Sample

<drupal:get-files-for-node nodeId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
nodeId	The node Id	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<File>	List of Files

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:get-nodes-with-term>

Get a list of Nodes related to the term

XML Sample

<drupal:get-nodes-with-term taxonomyTermId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
taxonomyTermId	The term id of the tag we want the nodes to be associated with	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<Node>	List of nodes that have the term.

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:get-taxonomy-vocabulary-tree>

The the list of terms that match the requirements of the request.

XML Sample

<drupal:get-taxonomy-vocabulary-tree vocabularyId="1"/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
vocabularyId		Id of the TaxonomyVocabulary we want to get	int	/
parent	-1	Optional. The TaxonomyTerm id we will use to filter the results. Defatuls to -1. In this case the parameter willl be ignored	int	/
maxdepth	0	Optional. Max depth value of the terms tree we want to retrieve. It is an exclusive limit. Only terms with lower depth value will be retrieved. Default value is 0. In this case parameter will be ignored	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
List<TaxonomyTerm>	A list of terms. The tree is actually the relationship that exists between the TaxonomyTerm parent field and the tid field. See `TaxonomyTerm`

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:index-comments>

Get a list of Comments with only the fields specified in the list of fields and the uri field for the comment.

XML Sample

<drupal:index-comments>
    <drupal:fields>
        <drupal:field>cid</drupal:field>
        <drupal:field>subject</drupal:field>
    </drupal:fields>
</drupal:index-comments>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
startPage	-1	Optional. The start page of the result list. Default value is -1. In this case, parameter won't be used in the request	int	/
pagesize	0	Optional. The maximum amount of results per page. Default value is 0.In this case, parameter won't be used in the request	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<drupal:fields>		List of fields of the comment that we want to retrieve. See `Comment`	List<String>

Returns

Return Type	Description
List<Comment>	List of comments with the required fields and the uri

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:index-files>

Get a list of files with only the fields specified in the list of fields and the uri field for the File.

XML Sample

<drupal:index-files>
    <drupal:fields>
        <drupal:field>vid</drupal:field>
        <drupal:field>created</drupal:field>
    </drupal:fields>
</drupal:index-files>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
startPage	-1	Optional. The start page of the result list. Default value is -1. In this case, parameter won't be used in the request	int	/
pagesize	0	Optional. The maximum amount of results per page. Default value is 0.In this case, parameter won't be used in the request	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<drupal:fields>		List of fields of the File that we want to retrieve. See `File`	List<String>

Returns

Return Type	Description
List<File>	List of files with the required fields and the uri

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:index-nodes>

Get a list of Nodes with only the fields specified in the list of fields and the uri field for the node.

XML Sample

<drupal:index-nodes>
    <drupal:fields>
        <drupal:field>nid</drupal:field>
        <drupal:field>type</drupal:field>
        <drupal:field>title</drupal:field>
    </drupal:fields>
</drupal:index-nodes>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
startPage	-1	Optional. The start page of the result list. Default value is -1. In this case, parameter won't be used in the request	int	/
pagesize	0	Optional. The maximum amount of results per page. Default value is 0.In this case, parameter won't be used in the request	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<drupal:fields>		List of fields of the node that we want to retrieve.See `Node`	List<String>

Returns

Return Type	Description
List<Node>	List of nodes with the required fields and the uri

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:index-taxonomy-terms>

Get a list of taxonomy terms with only the fields specified in the list of fields and the uri field for the term.

XML Sample

<drupal:index-taxonomy-terms>
    <drupal:fields>
        <drupal:field>cid</drupal:field>
        <drupal:field>subject</drupal:field>
    </drupal:fields>
</drupal:index-taxonomy-terms>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
startPage	-1	Optional. The start page of the result list. Default value is -1. In this case, parameter won't be used in the request	int	/
pagesize	0	Optional. The maximum amount of results per page. Default value is 0.In this case, parameter won't be used in the request	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<drupal:fields>		List of fields of the TaxonomyTerm that we want to retrieve. See `TaxonomyTerm`	List<String>

Returns

Return Type	Description
List<TaxonomyTerm>	List of terms with the required fields and the uri

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:index-taxonomy-vocabulary>

Get a list of taxonomy vocabulary with only the fields specified in the list of fields and the uri field for the vocabulary.

XML Sample

<drupal:index-taxonomy-vocabulary>
    <drupal:fields>
        <drupal:field>vid</drupal:field>
        <drupal:field>created</drupal:field>
    </drupal:fields>
</drupal:index-taxonomy-vocabulary>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
startPage	-1	Optional. The start page of the result list. Default value is -1. In this case, parameter won't be used in the request	int	/
pagesize	0	Optional. The maximum amount of results per page. Default value is 0.In this case, parameter won't be used in the request	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<drupal:fields>		List of fields of the TaxonomyVocabulary that we want to retrieve. See `TaxonomyVocabulary`	List<String>

Returns

Return Type	Description
List<TaxonomyVocabulary>	List of vocabularies with the required fields and the uri

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:index-users>

Get a list of Users with only the fields specified in the list of fields and the uri field for the user.

XML Sample

<drupal:index-users startPage="2" pagesize="5">
    <drupal:fields>
        <drupal:field>mail</drupal:field>
    </drupal:fields>
</drupal:index-users>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
startPage	-1	Optional. The start page of the result list. Default value is -1. In this case, parameter won't be used in the request	int	/
pagesize	0	Optional. The maximum amount of results per page. Default value is 0.In this case, parameter won't be used in the request	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<drupal:fields>		List of fields of the user that we want to retrieve. See `User`	List<String>

Returns

Return Type	Description
List<User>	List of users with the required fields and the uri

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:read-comment>

Read a comment. See Comment

XML Sample

<drupal:read-comment commentId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	Number of comment	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Comment	Comment with the id specified

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:read-file>

Read a file. See File

XML Sample

<drupal:read-file fileId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
fileId	Number of file	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
File	File with the id specified

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:read-node>

Read a node. See Node.

XML Sample

<drupal:read-node nodeId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
nodeId	Number of node	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Node	Node with the id specified

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:read-taxonomy-term>

Read a taxonomy term. See TaxonomyTerm

XML Sample

<drupal:read-taxonomy-term taxonomyTermId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
taxonomyTermId	Number of the term	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
TaxonomyTerm	Taxonomy term with the id specified

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:read-taxonomy-vocabulary>

Read a taxonomy vocabulary.

XML Sample

<drupal:read-taxonomy-vocabulary vocabularyId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
vocabularyId	Number of the vocabulary	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
TaxonomyVocabulary	Taxonomy vocabulary with the id specified

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:read-user>

Read an user. See User

XML Sample

<drupal:read-user userId="1"/>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userId	Number of user	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Returns

Return Type	Description
User	User with the id specified

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:register-user>

XML Sample

<drupal:register-user>
    <drupal:user name="NewUser" mail="foo@foo.com" password="dummy00"/>
</drupal:register-user>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user	#[payload]	Optional. User with at least Name, mail and password set.	User	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
User	The user created

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:update-comment>

Update the comment

XML Sample

<drupal:update-comment>
 <drupal:comment subject="Updated subject" cid="1">
        <drupal:comment-body>
            <drupal:und>
                <drupal:und>
                    <value>Updated body content value</value>
                </drupal:und>
            </drupal:und>
        </drupal:comment-body>
    </drupal:comment>
</drupal:update-comment>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
comment	#[payload]	Optional. Comment with new fields set	Comment	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Comment	the same comment

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:update-custom-field-for-node>

Update one custom field with the properties set at the map

XML Sample

<drupal:update-custom-field-for-node nodeId="1" fieldName="field_test">
    <drupal:custom-properties>
        <value>10.00</value>
    </drupal:custom-properties>
</drupal:update-custom-field-for-node>

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
nodeId	Id of the node	int	/
fieldName	Machine name of the field	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. A username	String	/	UTF-8
password	Optional. A password	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<drupal:custom-properties>		Map that contains the pair of key and values	Map<String, String>

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200

<drupal:update-file>

Update file

XML Sample

<drupal:update-file/>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
file	#[payload]	Optional. File with new fields set	File	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
File	the same File

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:update-node>

Update the node

XML Sample

<drupal:update-node>
    <drupal:node title="Updated title" nid="1"/>
</drupal:update-node>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node	#[payload]	Optional. Node	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
Node	the same node

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:update-taxonomy-term>

Update the taxonomy term

XML Sample

<drupal:update-taxonomy-term>
    <drupal:taxonomy-term description="Updated description" tid="1"/>
</drupal:update-taxonomy-term>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
taxonomyTerm	#[payload]	Optional. TaxonomyTerm with new fields set	TaxonomyTerm	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
TaxonomyTerm	the same taxonomyTerm

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:update-taxonomy-vocabulary>

Update the taxonomyVocabulary

XML Sample

<drupal:update-taxonomy-vocabulary>
    <drupal:taxonomy-vocabulary name="UpdateName" description="New description" vid="1"/>
</drupal:update-taxonomy-vocabulary>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
taxonomyVocabulary	#[payload]	Optional. Taxonomy vocabulary with new fields set	TaxonomyVocabulary	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
TaxonomyVocabulary	The same taxonomyVocabulary

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned

<drupal:update-user>

Update the user

XML Sample

<drupal:update-user>
    <drupal:user name="updatedUserName"/>
</drupal:update-user>

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
user	#[payload]	Optional. User with new fields set	User	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. A username	String	/	UTF-8
password		Optional. A password	String	/	UTF-8

Returns

Return Type	Description
User	the same user

Exception Payloads

Payload Class	Description
DrupalException	When the server doesn't return code 200, it contains the code returned