Interface ISoWcfRequestInterceptorPlugin

Plugins needing to intercept web service reqests can implement this interface

Namespace: SuperOffice.Services.WcfService
Assembly: SuperOffice.Plugins.dll
Syntax
public interface ISoWcfRequestInterceptorPlugin : IDisposable

Methods

OnAuthenticate(String, String, String)

Event raised when web service requests are recieved

Declaration
OnAuthenticateResponse OnAuthenticate(string service, string method, string requestApplicationToken)
Parameters
Type Name Description
String service

Name of service or agent.
String method

Name of web method
String requestApplicationToken

Application Token from the request
Returns
Type Description
OnAuthenticateResponse

State passed on to other events raised in the web method processing.

OnError(String, String, String, Exception, ref WcfRequestInterceptorState)

Event raised if an error occurs. This event is raised when authentication fails too

Declaration
void OnError(string service, string method, string requestApplicationToken, Exception exception, ref WcfRequestInterceptorState pluginState)
Parameters
Type Name Description
String service

Name of service or agent.
String method

Name of web method
String requestApplicationToken

Application Token from the request
Exception exception

Exception occured
WcfRequestInterceptorState pluginState

State created in OnAuthenticate

OnExecute(String, String, String, ref WcfRequestInterceptorState)

Event raised after the user is authenticated before executing the actual method

Declaration
void OnExecute(string service, string method, string requestApplicationToken, ref WcfRequestInterceptorState pluginState)
Parameters
Type Name Description
String service

Name of service or agent.
String method

Name of web method
String requestApplicationToken

Application Token from the request
WcfRequestInterceptorState pluginState

State created in OnAuthenticate

OnExecuted(String, String, String, Func<Dictionary<String, String>>, ref WcfRequestInterceptorState)

Event raised after the operation has successfully been carried out

Declaration
void OnExecuted(string service, string method, string requestApplicationToken, Func<Dictionary<string, string>> responseExtraInfo, ref WcfRequestInterceptorState pluginState)
Parameters
Type Name Description
String service

Name of service or agent.
String method

Name of web method
String requestApplicationToken

Application Token from the request
Func<Dictionary<String, String>> responseExtraInfo

ExtraInfo passed in teh response, that is sent to the client.
WcfRequestInterceptorState pluginState

State created in OnAuthenticate

Extension Methods

EnumUtil.MapEnums<From, To>(From)