Class RestSOIHelper

Namespace
ESRI.Server.SOESupport.SOI
Assembly
ESRI.Server.SOESupport.dll

The RestSOIHelper class is an utility class that helps to implement REST request handling in SOIs.

public class RestSOIHelper : SOIBase
Inheritance
RestSOIHelper
Inherited Members

Constructors

RestSOIHelper(IServerObjectHelper)

The RestSOIHelper constructor accepts reference to IServerObjectHelper and should be called from the IServerObjectExtension.Init implementation.

public RestSOIHelper(IServerObjectHelper soHelper)

Parameters

soHelper IServerObjectHelper

Non-null reference to the IServerObjectHelper instance.

Properties

FilterMap

Map of REST request filters for every REST request code.

public Dictionary<RestHandlerOpCode, RestFilter> FilterMap { get; set; }

Property Value

Dictionary<RestHandlerOpCode, RestFilter>

Methods

GetFilter(RestHandlerOpCode)

GetFilter returns filter set for the REST request or null if there is no filter set.

public RestFilter GetFilter(RestHandlerOpCode opCode)

Parameters

opCode RestHandlerOpCode

An unique identifier of the REST request specified in RestHandlerOpCode and/or derived types.

Returns

RestFilter

Filter of the REST request or null if there is no filter set.

GetHandlerOpCode(string, string)

The GetHandlerOpCode method parses REST resource and operation name parameters and returns corresponding RestHandlerOpCode.

public static RestHandlerOpCode GetHandlerOpCode(string resourceName, string operationName)

Parameters

resourceName string

REST resource name passed to HandleRESTRequest

operationName string

REST operation name passed to HandleRESTRequest

Returns

RestHandlerOpCode

Value of RestHandlerOpCode or RestHandlerOpCode.DefaultNoOp if resource+operation string pair does not match any pre-defined values of RestHandlerOpCode