org.mule.modules.microsoftdynamics365

Class Dynamics365Connector

java.lang.Object

org.mule.modules.microsoftdynamics365.Dynamics365Connector

Direct Known Subclasses:

org.mule.modules.microsoftdynamics365.generated.adapters.Dynamics365ConnectorCapabilitiesAdapter

@Connector(name="dynamics365",
           friendlyName="Microsoft Dynamics 365",
           minMuleVersion="3.6")
@ReconnectOn(exceptions=org.mule.api.ConnectionException.class)
@RequiresEnterpriseLicense(allowEval=true)
public class Dynamics365Connector
extends Object

The Microsoft Dynamics 365 connector provides unified connectivity to Dynamics CRM 8.2 On-Premises and On-Demand versions.

Author:

MuleSoft, Inc.

Constructor Summary

Constructors

Constructor and Description
Dynamics365Connector()

Method Summary

Methods

Modifier and Type	Method and Description
String	create(String logicalName, Map<String,Object> attributes) Creates a new Entity Create New Entity - https://msdn.microsoft.com/en-us/library/gg328090.aspx Associate Entity upon Creation - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4
org.mule.common.bulk.BulkOperationResult<Map<String,Object>>	createMultiple(String logicalName, List<Map<String,Object>> attributesList, boolean useSingleTransaction) Creates Multiple Entities Create New Entity - https://msdn.microsoft.com/en-us/library/gg328090.aspx Associate Entity upon Creation - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4 Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx
void	delete(String logicalName, String id) Delete an Entity Delete an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx
org.mule.common.bulk.BulkOperationResult<String>	deleteMultiple(String logicalName, List<String> ids, boolean useSingleTransaction) Delete Multiple Entities Delete an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx
void	disassociate(String logicalName, Map<String,Object> attributes) Disassociate Entities Disassociate Entities - https://msdn.microsoft.com/en-us/library/mt607875.aspx
Map<String,Object>	doAction(String actionName, String boundedEntityType, String boundedEntityId, Map<String,Object> relatedEntities) Call Action Use Web API Actions - https://msdn.microsoft.com/en-us/library/mt607600.aspx
DynamicsConfig	getConfig()
Map<String,Object>	invoke(String uri, InvokeHttpMethod httpMethod, Map<String,String> headers, String json) Generic Simple Invoke
Map<String,Object>	retrieve(String logicalName, String id) Retrieve an Entity Retrieve an Entity - https://msdn.microsoft.com/en-us/library/mt607871.aspx
org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,Dynamics365Connector>	retrieveMultiple(String dataQueryURL, org.mule.streaming.PagingConfiguration pagingConfiguration) Retrieve Multiple by URL Query Data using the Web API - https://msdn.microsoft.com/en-us/library/gg334767.aspx
org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,Dynamics365Connector>	retrieveMultipleByQuery(String query, org.mule.streaming.PagingConfiguration pagingConfiguration) Retrieve Multiple by DSQL Query Query Data using the Web API - https://msdn.microsoft.com/en-us/library/gg334767.aspx
void	setConfig(DynamicsConfig config)
void	update(String logicalName, Map<String,Object> attributes) Update an Entity Update an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx Associate Entities upon Update - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4 Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx
org.mule.common.bulk.BulkOperationResult<Map<String,Object>>	updateMultiple(String logicalName, List<Map<String,Object>> attributesList, boolean useSingleTransaction) Update Multiple Entities Update Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx Associate Entities upon Update - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4 Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Dynamics365Connector

public Dynamics365Connector()

Method Detail

getConfig

public DynamicsConfig getConfig()

setConfig

public void setConfig(DynamicsConfig config)

create

@OAuthProtected
@Processor
@MetaDataScope(value=CreateEntityMetadataResolver.class)
public String create(@MetaDataKeyParam(affects=INPUT)
                                                                                     String logicalName,
                                                                                     @Default(value="#[payload]")@Placement(group="Attributes")
                                                                                     Map<String,Object> attributes)
              throws DynamicsException,
                     org.mule.api.ConnectionException

Creates a new Entity
Create New Entity - https://msdn.microsoft.com/en-us/library/gg328090.aspx
Associate Entity upon Creation - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4

Parameters:

logicalName - The logical name of the entity. It is always the Schema Name in lower case.

attributes - The attributes of the entity to be created as a Map.

Returns:

The entity id which was created.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

createMultiple

@OAuthProtected
@Processor
@MetaDataScope(value=CreateEntitiesMetadataResolver.class)
public org.mule.common.bulk.BulkOperationResult<Map<String,Object>> createMultiple(@MetaDataKeyParam(affects=INPUT)
                                                                                                                                                     String logicalName,
                                                                                                                                                     @Default(value="#[payload]")@Placement(group="Attributes")
                                                                                                                                                     List<Map<String,Object>> attributesList,
                                                                                                                                                     @Default(value="false")
                                                                                                                                                     boolean useSingleTransaction)
                                                                            throws DynamicsException,
                                                                                   org.mule.api.ConnectionException

Creates Multiple Entities
Create New Entity - https://msdn.microsoft.com/en-us/library/gg328090.aspx
Associate Entity upon Creation - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4
Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

Parameters:

logicalName - The logical name of the entities to be created. It is always the Schema Name in lower case.

attributesList - A list with the attributes of the entities to be created as a List of Maps.

useSingleTransaction - Use a single transaction for creation. If one entity fails to be created the transaction is rolled-back.

Returns:

The results of the created entities in form of BulkOperationResult.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

update

@OAuthProtected
@Processor
@MetaDataScope(value=UpdateEntityMetadataResolver.class)
public void update(@MetaDataKeyParam(affects=INPUT)
                                                                                   String logicalName,
                                                                                   @Default(value="#[payload]")@Placement(group="Attributes")
                                                                                   Map<String,Object> attributes)
            throws DynamicsException,
                   org.mule.api.ConnectionException

Update an Entity
Update an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx
Associate Entities upon Update - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4
Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

Parameters:

logicalName - The logical name of the entity. It is always the Schema Name in lower case.

attributes - The attributes of the entity that will be updated as a Map.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

delete

@OAuthProtected
@Processor
@MetaDataScope(value=DeleteEntityMetadataResolver.class)
public void delete(@MetaDataKeyParam(affects=INPUT)
                                                                                   String logicalName,
                                                                                   @Default(value="#[payload]")
                                                                                   String id)
            throws DynamicsException,
                   org.mule.api.ConnectionException

Delete an Entity
Delete an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx

Parameters:

logicalName - The logical name of the entity. It is always the Schema Name in lower case.

id - The id of the entity that is going to be deleted

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

deleteMultiple

@OAuthProtected
@Processor
@MetaDataScope(value=DeleteEntitiesMetadataResolver.class)
public org.mule.common.bulk.BulkOperationResult<String> deleteMultiple(@MetaDataKeyParam(affects=INPUT)
                                                                                                                                         String logicalName,
                                                                                                                                         @Default(value="#[payload]")
                                                                                                                                         List<String> ids,
                                                                                                                                         @Default(value="false")
                                                                                                                                         boolean useSingleTransaction)
                                                                throws DynamicsException,
                                                                       org.mule.api.ConnectionException

Delete Multiple Entities
Delete an Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx
Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

Parameters:

logicalName - The logical name of the entity. It is always the Schema Name in lower case.

ids - The list of ids that are going to be deleted.

useSingleTransaction - Use a single transaction for deletion. If one entity fails to be deleted the transaction is rolled-back.

Returns:

The results of the deleted entities in form of BulkOperationResult.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

updateMultiple

@OAuthProtected
@Processor
@MetaDataScope(value=UpdateEntitiesMetadataResolver.class)
public org.mule.common.bulk.BulkOperationResult<Map<String,Object>> updateMultiple(@MetaDataKeyParam(affects=INPUT)
                                                                                                                                                     String logicalName,
                                                                                                                                                     @Default(value="#[payload]")@Placement(group="Attributes")
                                                                                                                                                     List<Map<String,Object>> attributesList,
                                                                                                                                                     @Default(value="false")
                                                                                                                                                     boolean useSingleTransaction)
                                                                            throws DynamicsException,
                                                                                   org.mule.api.ConnectionException

Update Multiple Entities
Update Entity - https://msdn.microsoft.com/en-us/library/mt607664.aspx
Associate Entities upon Update - https://msdn.microsoft.com/en-us/library/mt607875.aspx#Anchor_4
Batch Request - https://msdn.microsoft.com/en-us/library/mt607719.aspx

Parameters:

logicalName - The logical name of the entity. It is always the Schema Name in lower case.

attributesList - A list with the attributes of the entities that are going to be updated as a List of Maps.

useSingleTransaction - Use a single transaction for update. If one entity fails to be updated the transaction is rolled-back.

Returns:

The results of the updated entities in the form of BulkOperationResult.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

retrieve

@OAuthProtected
@Processor
@MetaDataScope(value=RetrieveEntityMetadataResolver.class)
public Map<String,Object> retrieve(@MetaDataKeyParam(affects=OUTPUT)
                                                                                                     String logicalName,
                                                                                                     @Default(value="#[payload]")
                                                                                                     String id)
                            throws DynamicsException,
                                   org.mule.api.ConnectionException

Retrieve an Entity
Retrieve an Entity - https://msdn.microsoft.com/en-us/library/mt607871.aspx

Parameters:

logicalName - The logical name of the entity. It is always the Schema Name in lower case.

id - The id of the entity that is going to be retrieved.

Returns:

The retrieve response as a Map.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

retrieveMultiple

@Processor
@Paged
@OAuthProtected
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,Dynamics365Connector> retrieveMultiple(@FriendlyName(value="Data Query URL")@Default(value="#[payload]")
                                                                                                                                      String dataQueryURL,
                                                                                                                                      org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                         throws DynamicsException,
                                                                                                                org.mule.api.ConnectionException

Retrieve Multiple by URL
Query Data using the Web API - https://msdn.microsoft.com/en-us/library/gg334767.aspx

Parameters:

dataQueryURL - The URL that is going to be used for retrieve.

pagingConfiguration - The configuration for the pagination feature.

Returns:

A paging delegate with the records resulting from the query. Pagination is handled internally.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

retrieveMultipleByQuery

@OAuthProtected
@Processor
@Paged
@MetaDataScope(value=RetrieveEntitiesByQueryMetadataResolver.class)
public org.mule.streaming.ProviderAwarePagingDelegate<Map<String,Object>,Dynamics365Connector> retrieveMultipleByQuery(@FriendlyName(value="Datasense Query")@Default(value="#[payload]")@Query
                                                                                                                                                                                                        String query,
                                                                                                                                                                                                        org.mule.streaming.PagingConfiguration pagingConfiguration)
                                                                                                                throws DynamicsException,
                                                                                                                       org.mule.api.ConnectionException

Retrieve Multiple by DSQL Query
Query Data using the Web API - https://msdn.microsoft.com/en-us/library/gg334767.aspx

Parameters:

query - The DSQL query that is going to be used for retrieve. The query will be transformed in a retrieve URL internally.

pagingConfiguration - The configuration for the pagination feature.

Returns:

A paging delegate with the records resulting from the query. Pagination is handled internally.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

disassociate

@OAuthProtected
@Processor
@MetaDataScope(value=DisassociateEntitiesMetadataResolver.class)
public void disassociate(@MetaDataKeyParam(affects=INPUT)
                                                                                                 String logicalName,
                                                                                                 @Default(value="#[payload]")@Placement(group="Attributes")
                                                                                                 Map<String,Object> attributes)
                  throws DynamicsException,
                         org.mule.api.ConnectionException

Disassociate Entities
Disassociate Entities - https://msdn.microsoft.com/en-us/library/mt607875.aspx

Parameters:

logicalName - The logical name of the entity. It is always the Schema Name in lower case.

attributes - The attributes should hold the id of the entity upon which the disassociation will be performed and a list with the entities keys that are going to be disassociated.

Throws:

DynamicsException - when there is an internal/server error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

doAction

@OAuthProtected
@Processor
@MetaDataScope(value=DoActionMetadataResolver.class)
public Map<String,Object> doAction(@MetaDataKeyParam(affects=INPUT)
                                                                                               String actionName,
                                                                                               @Optional
                                                                                               String boundedEntityType,
                                                                                               @Optional
                                                                                               String boundedEntityId,
                                                                                               @Default(value="#[payload]")@Placement(group="Related entities attributes")
                                                                                               Map<String,Object> relatedEntities)
                            throws DynamicsException,
                                   org.mule.api.ConnectionException

Call Action
Use Web API Actions - https://msdn.microsoft.com/en-us/library/mt607600.aspx

Parameters:

actionName - The action name that is going to be called

boundedEntityType - An optional bounded entity type. It must be provided if the action is bounded.

boundedEntityId - An optional bounded entity id. It must be provided if the action is bounded.

relatedEntities - This is the body that will be send in the request as a Map.

Returns:

The response as a Map.

Throws:

DynamicsException - when there is an internal error.

org.mule.api.ConnectionException - when there is an authentication/connection error.

invoke

@OAuthProtected
@Processor
public Map<String,Object> invoke(@Placement(order=1)@Default(value="#[payload]")
                                                 String uri,
                                                 @Placement(order=2)
                                                 InvokeHttpMethod httpMethod,
                                                 @Placement(order=3)
                                                 Map<String,String> headers,
                                                 @Optional@Placement(order=4)
                                                 String json)
                          throws DynamicsException,
                                 org.mule.api.ConnectionException

Generic Simple Invoke

Parameters:

uri - The URI that is going to be invoked.

httpMethod - The HTTP Method that is going to be invoked.

headers - The HTTP headers used in the request. There are some default headers that are used; read more in the documentation.

json - The JSON String that will be placed in the body of the request.

Returns:

The response from the server as a Map.

Throws:

DynamicsException - when there is an internal error.

org.mule.api.ConnectionException - when there is an authentication/connection error.