Interface ISoWcfRequestInterceptorPlugin

Plugins needing to intercept web service reqests can implement this interface

Inherited Members

IDisposable.Dispose()

Namespace: SuperOfficeServicesWcfService

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
FuncDictionarystringstring	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)

Converters.MapEnums<From, To>(From)