Change Behaviour of webhooks

[Mike.Sheen]

How can you reference WebHookEvents and Webhook from another plugin?

WebHookEvents is a static property of the RESTAPIPlugin class - so you add a plugin reference and then you should have access to that List.

[SBarnes]

No actually that doesn't work it becomes an issue of scope that I figured out if you don't rename the classes in the second plugin to say MyBusinessLogicPlugin and MyRestAPIPlugin the editor seems to get confused, I tried partial on the classes but that didn't resolve it either as I suspect for that to work you'd need partial classes in both plugins but renaming the classes definitely resolves it and doesn't cause any side effects as Jiwa is looking for interface implementations so the class name doesn't really matter.

[Mike.Sheen]

Ahhh... yes I have a memory now of coming across that issue when working on the caching.

I got around it by registering in the Funq container of the REST APLI the class I wanted to access, and in the other plugin Resolving it.

So, in the REST API plugin in the Configure method of the RESTAPIPlugin class you register a type and the instance to associate with that type - so if you wanted to access the RESTAPIPlugin instance itself:

Code: Select all

Container.Register<RESTAPIPlugin>(this);

What that's doing is associating the type RESTAPIPlugin with an instance of itself (this).

Then in your plugin, you can retrieve that via:

Code: Select all

RESTAPIPlugin restAPIPlugin = Container.TryResolve<RESTAPIPlugin>();

This needs to also go into the Configure method as the Container is passed as a parameter to that.

If you want something more flexible (say you want to access it via another plugin which DOES NOT implement the IJiwaRESTAPIPlugin interface, then you could create your own container, shove that into the ObjectDictionary of the Manager class - so then you can access the container from anywhere which has access to the Manager (pretty much everywhere).

ObjectDictionary is just a System.Collections.Generic.Dictionary - so just add it like:

Code: Select all

Manager.ObjectDictionary.Add("Container", Funq.Container); // Funq.Container requires a reference to ServiceStack.dll

Then from anywhere you should be able to access the container to register types and resolve instances from the type.

Hope that helps!

[SBarnes]

Thanks Mike

Ok I am assuming for the Business Logic Plugin you would need to do the following:

Code: Select all

Manager.ObjectDictionary.Add("BusinessLogicPlugin", this);


to make

Code: Select all

BusinessLogicPlugin.Webhook(JiwaBusinessLogic.Manager, "", "");


work also?

Just an idea would it be possible add a property to the manager called RESTAPI so that you could have

Code: Select all

manager.RESTAPI.RESTAPIPlugin


and

Code: Select all

manager.RESTAPI.BusinessLogicPlugin


permanently available going forward otherwise every time you upgrade a system you have to edit the REST API plugin with the instructions you gave?

[Mike.Sheen]

Thanks Mike

Ok I am assuming for the Business Logic Plugin you would need to do the following:

Code: Select all

Manager.ObjectDictionary.Add("BusinessLogicPlugin", this);


to make

Code: Select all

BusinessLogicPlugin.Webhook(JiwaBusinessLogic.Manager, "", "");


work also?

I've not tried it, but yes I believe that would work.

Just an idea would it be possible add a property to the manager called RESTAPI so that you could have

Code: Select all

manager.RESTAPI.RESTAPIPlugin


and

Code: Select all

manager.RESTAPI.BusinessLogicPlugin


permanently available going forward otherwise every time you upgrade a system you have to edit the REST API plugin with the instructions you gave?

Because there can be multiple instances (like you can have multiple plugins implementing IJiwaRESTAPIPlugin), I'm currently not able to see how that would work...

[SBarnes]

I meant it would only reference back to the main REST API plugin by the way I also found an issue that setting the execution order fixes but if you have the line

Code: Select all

JiwaFinancials.Jiwa.JiwaServiceModel.RESTAPIPlugin.WebHookEvents.Add(new JiwaFinancials.Jiwa.JiwaServiceModel.WebHookEvent { Name = "salesorder.processed", Description = "Occurs when a sales order is processed" });


in a plugin where it's name would put it before the REST API such as it starts with Attkey then you get null reference exception that stops the service starting it doesn't matter that the REST API plugin is listed under the plugin references as I believe this doesn't change the load order.