public void UnregisterServiceEndPoints(PluginManifest manifest, IOrganizationService client, TracingHelper t)
{
t.Debug($"Entering PluginWrapper.UnregisterServiceEndPoints");
foreach (var serviceEndpoint in manifest.ServiceEndpoints)
{
var existingEndpoint = serviceEndpoint.GetExistingServiceEndpoint().RetrieveSingleRecord(client);
if (existingEndpoint == null)
{
return;
}
var childStepsResults =
GetChildPluginStepsQuery(existingEndpoint.ToEntityReference()).RetrieveMultiple(client);
var childStepsList = childStepsResults.Entities.Select(e => e.Id).ToList();
if (childStepsList.Count > 0)
{
GetChildEntityImagesQuery(childStepsList).DeleteAllResults(client);
}
GetChildPluginStepsQuery(existingEndpoint.ToEntityReference()).DeleteAllResults(client);
serviceEndpoint.GetExistingServiceEndpoint().DeleteSingleRecord(client);
}
t.Debug($"Exiting PluginWrapper.UnregisterServiceEndPoints");
}
public void UnregisterServiceEndPoints(PluginManifest manifest, IOrganizationService client)
{
if (manifest.LoggingConfiguration != null)
{
var t = new TracingHelper(manifest.LoggingConfiguration);
UnregisterServiceEndPoints(manifest, client, t);
}
else
{
UnregisterServiceEndPoints(manifest, client, t: null);
}
}
public void RegisterServiceEndpoints(PluginManifest manifest, IOrganizationService client, TracingHelper t)
{
t.Debug($"Entering PluginWrapper.RegisterServiceEndpoints");
if (manifest.Clobber)
{
t.Warning($"Manifest has 'Clobber' set to true. Deleting referenced Plugins before re-registering");
this.UnregisterServiceEndPoints(manifest, client, t);
}
// 1. Register Service Endpoints
foreach (var serviceEndpoint in manifest.ServiceEndpoints)
{
t.Debug($"Registering Assembly {serviceEndpoint.Name}");
var createdEndpoint = serviceEndpoint.Register(client);
t.Info($"Assembly {serviceEndpoint.Name} registered with ID {createdEndpoint.Id}");
SolutionWrapper.AddSolutionComponent(client, manifest.SolutionName, createdEndpoint.Id, ComponentType.ServiceEndpoint);
t.Debug($"Plugin Step {serviceEndpoint.Name} added to solution {manifest.SolutionName}");
// 2. Register Steps
foreach (var step in serviceEndpoint.Steps)
{
t.Debug($"Processing Step = {step.FriendlyName}");
var sdkMessage = GetSdkMessageQuery(step.Message).RetrieveSingleRecord(client);
var sdkMessageFilter = GetSdkMessageFilterQuery(step.PrimaryEntity, sdkMessage.Id).RetrieveSingleRecord(client);
var createdStep = step.Register(client, createdEndpoint, sdkMessage.ToEntityReference(), sdkMessageFilter.ToEntityReference());
t.Info($"Plugin step {step.FriendlyName} registered with ID {createdStep.Id}");
if (manifest.SolutionName != null)
{
SolutionWrapper.AddSolutionComponent(client, manifest.SolutionName, createdStep.Id, ComponentType.SdkMessageProcessingStep);
t.Debug($"Plugin Step {step.FriendlyName} added to solution {manifest.SolutionName}");
}
// 3. register Entity Images
if (step.EntityImages == null)
{
continue;
}
foreach (var entityImage in step.EntityImages)
{
t.Debug($"Processing Entity Image = {entityImage.Name}");
var createdImage = entityImage.Register(client, createdStep);
t.Info($"Entity image {entityImage.Name} registered with ID {createdImage}");
}
}
}
t.Debug($"Exiting PluginWrapper.RegisterServiceEndpoints");
}
/// <summary>
/// Loops through each PluginAssembly in the manifest and registers all assemblies, plugins, steps and images
/// </summary>
/// <param name="manifest">XML plugin manifest</param>
/// <param name="client">IOrganizationService client reference</param>
public void RegisterPlugins(PluginManifest manifest, IOrganizationService client)
{
if (manifest.LoggingConfiguration != null)
{
var t = new TracingHelper(manifest.LoggingConfiguration);
RegisterPlugins(manifest, client, t);
}
else
{
var t = new TracingHelper();
RegisterPlugins(manifest, client, t);
}
}
public void UnregisterPlugins(PluginManifest manifest, IOrganizationService client, TracingHelper t)
{
t.Debug($"Entering PluginWrapper.UnregisterPlugins");
// TODO - need to clobber Custom APIs and child parameters/properties too!!
foreach (var pluginAssembly in manifest.PluginAssemblies)
{
t.Debug($"Getting PluginAssemblyInfo from file {pluginAssembly.Assembly}");
if (!File.Exists(pluginAssembly.Assembly))
{
t.Critical($"Assembly {pluginAssembly.Assembly} cannot be found!");
continue;
}
var pluginAssemblyInfo = new PluginAssemblyInfo(pluginAssembly.Assembly);
var existingAssembly = pluginAssembly.GetExistingQuery(pluginAssemblyInfo.Version).RetrieveSingleRecord(client);
if (existingAssembly == null)
{
return;
}
var childPluginTypesResults = GetChildPluginTypesQuery(existingAssembly.ToEntityReference()).RetrieveMultiple(client);
var pluginsList = childPluginTypesResults.Entities.Select(e => e.Id).ToList();
GetChildCustomApisQuery(pluginsList).DeleteAllResults(client);
var childStepsResults = GetChildPluginStepsQuery(pluginsList).RetrieveMultiple(client);
var pluginStepsList = childStepsResults.Entities.Select(e => e.Id).ToList();
if (pluginStepsList.Count > 0)
{
GetChildEntityImagesQuery(pluginStepsList).DeleteAllResults(client);
}
if (pluginsList.Count > 0)
{
GetChildPluginStepsQuery(pluginsList).DeleteAllResults(client);
}
GetChildPluginTypesQuery(existingAssembly.ToEntityReference()).DeleteAllResults(client);
pluginAssembly.GetExistingQuery(pluginAssemblyInfo.Version).DeleteSingleRecord(client);
}
t.Debug($"Exiting PluginWrapper.UnregisterPlugins");
}
public ManifestValidationResult Validate(PluginManifest manifest)
{
var validator = new PluginManifestValidator();
var result = validator.Validate(manifest);
if (!result.IsValid)
{
return(new ManifestValidationResult()
{
IsValid = false,
Errors = result.Errors.Select(e => e.ErrorMessage)
});
}
return(new ManifestValidationResult()
{
IsValid = true
});
}
/// <summary>
/// Loops through each PluginAssembly in the manifest and registers all assemblies, plugins, steps and images
/// </summary>
/// <param name="manifest">XML plugin manifest</param>
/// <param name="client">IOrganizationService client reference</param>
/// <param name="t">Tracing helpers for logging</param>
public void RegisterPlugins(PluginManifest manifest, IOrganizationService client, TracingHelper t)
{
t.Debug($"Entering PluginWrapper.RegisterPlugins");
// 0. Validate manifest before continuing
var manifestValidation = this.Validate(manifest);
if (!manifestValidation.IsValid)
{
t.Critical($"Manifest is invalid and has {manifestValidation.Errors.Count()} errors");
throw new InvalidManifestException(manifestValidation.ToString());
}
if (manifest.Clobber)
{
t.Warning($"Manifest has 'Clobber' set to true. Deleting referenced Plugins before re-registering");
this.UnregisterServiceEndPoints(manifest, client, t);
this.UnregisterPlugins(manifest, client, t);
}
// 1. Register Assemblies
foreach (var pluginAssembly in manifest.PluginAssemblies)
{
t.Debug($"Processing Assembly FriendlyName {pluginAssembly.FriendlyName}");
if (!File.Exists(pluginAssembly.Assembly))
{
t.Critical($"Assembly {pluginAssembly.Assembly} cannot be found!");
continue;
}
var targetSolutionName = string.Empty;
if (!string.IsNullOrEmpty(pluginAssembly.SolutionName))
{
targetSolutionName = pluginAssembly.SolutionName;
}
else if (!string.IsNullOrEmpty(manifest.SolutionName))
{
targetSolutionName = manifest.SolutionName;
}
t.Debug($"Registering Assembly {pluginAssembly.FriendlyName}");
var createdAssembly = pluginAssembly.Register(client);
t.Info($"Assembly {pluginAssembly.FriendlyName} registered with ID {createdAssembly.Id}");
SolutionWrapper.AddSolutionComponent(client, targetSolutionName, createdAssembly.Id, ComponentType.PluginAssembly);
t.Debug($"Assembly '{pluginAssembly.FriendlyName}' added to solution {targetSolutionName}");
if (manifest.UpdateAssemblyOnly)
{
continue;
}
// 2a. Register Plugins
foreach (var plugin in pluginAssembly.Plugins)
{
t.Debug($"PluginType FriendlyName = {plugin.FriendlyName}");
var createdPluginType = plugin.Register(client, createdAssembly);
t.Info($"Plugin {plugin.FriendlyName} registered with ID {createdPluginType.Id}");
if (plugin.Steps != null)
{
// 2b. Register Plugin Steps
foreach (var pluginStep in plugin.Steps)
{
t.Debug($"Processing Step = {pluginStep.FriendlyName}");
var sdkMessage = GetSdkMessageQuery(pluginStep.Message).RetrieveSingleRecord(client);
var sdkMessageFilter = GetSdkMessageFilterQuery(pluginStep.PrimaryEntity, sdkMessage.Id).RetrieveSingleRecord(client);
var createdStep = pluginStep.Register(client, createdPluginType, sdkMessage.ToEntityReference(), sdkMessageFilter.ToEntityReference());
t.Info($"Plugin step {pluginStep.FriendlyName} registered with ID {createdStep.Id}");
SolutionWrapper.AddSolutionComponent(client, targetSolutionName, createdStep.Id, ComponentType.SdkMessageProcessingStep);
t.Debug($"Plugin Step '{pluginStep.FriendlyName}' added to solution {targetSolutionName}");
// 2c. Register Entity Images
if (pluginStep.EntityImages == null)
{
continue;
}
foreach (var entityImage in pluginStep.EntityImages)
{
t.Debug($"Processing Entity Image = {entityImage.Name}");
var createdImage = entityImage.Register(client, createdStep);
t.Info($"Entity image {entityImage.Name} registered with ID {createdImage.Id}");
}
}
}
// 3a. Register Custom APIs
if (plugin.CustomApis != null)
{
// debug: view all apis and children with query - /api/data/v9.1/customapis?$select=uniquename,allowedcustomprocessingsteptype,bindingtype,boundentitylogicalname,description,displayname,executeprivilegename,isfunction,isprivate&$expand=CustomAPIRequestParameters($select=uniquename,name,description,displayname,type,logicalentityname,isoptional),CustomAPIResponseProperties($select=uniquename,name,description,displayname,type,logicalentityname),PluginTypeId($select=plugintypeid,typename,version,name,assemblyname)
foreach (var api in plugin.CustomApis)
{
t.Debug($"Processing Step = {api.FriendlyName}");
var createdApi = api.Register(client, createdPluginType);
t.Info($"CustomApi {api.FriendlyName} created with ID {createdApi.Id}");
SolutionWrapper.AddSolutionComponent(client, targetSolutionName, createdApi.Id, ComponentType.CustomApi);
t.Debug($"Custom API '{api.FriendlyName}' added to solution {targetSolutionName}");
// 3b. Create/Update Request Parameters
if (api.RequestParameters != null)
{
foreach (var requestParameter in api.RequestParameters)
{
t.Debug($"Processing Custom API request parameter '{requestParameter.FriendlyName}'");
var createdParameter = requestParameter.Register(client, createdApi);
t.Info($"Request parameter '{requestParameter.FriendlyName} created with ID {createdParameter.Id}'");
SolutionWrapper.AddSolutionComponent(client, targetSolutionName, createdParameter.Id, ComponentType.CustomApiRequestParameter);
t.Debug($"Request parameter '{requestParameter.FriendlyName}' added to solution {targetSolutionName}");
}
}
// 3c. Create/Update Response Properties
if (api.ResponseProperties != null)
{
foreach (var responseProperty in api.ResponseProperties)
{
t.Debug($"Processing Custom API response property '{responseProperty.FriendlyName}'");
var createdProperty = responseProperty.Register(client, createdApi);
t.Info($"Response property '{responseProperty.FriendlyName} created with ID {createdProperty.Id}'");
SolutionWrapper.AddSolutionComponent(client, targetSolutionName, createdProperty.Id, ComponentType.CustomApiResponseProperty);
t.Debug($"Response property '{responseProperty.FriendlyName}' added to solution {targetSolutionName}");
}
}
}
}
}
}
t.Debug($"Exiting PluginWrapper.RegisterPlugins");
}
/// <summary>
/// Loops through each PluginAssembly in the manifest and registers all assemblies, plugins, steps and images.
/// Accepts custom ILogger implementation for custom logging output
/// </summary>
/// <param name="manifest"></param>
/// <param name="client"></param>
/// <param name="logger"></param>
public void RegisterPlugins(PluginManifest manifest, IOrganizationService client, ILogger logger)
{
var t = new TracingHelper(logger);
RegisterPlugins(manifest, client, t);
}
public void UnregisterServiceEndPoints(PluginManifest manifest, IOrganizationService client, ILogger logger)
{
var t = new TracingHelper(logger);
UnregisterServiceEndPoints(manifest, client, t);
}
