Class SOIBase

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

The SOIBase class is an utility class. Both RestSOIHelper and SoapSOIHelper derive from this class. It provides general support for the request interception. It is possible to use it directly, but we recommend to use the RestSOIHelper and SoapSOIHelper classes instead as they contain more useful utility methods.

public class SOIBase
Inheritance
SOIBase
Derived
Inherited Members

Constructors

SOIBase(IServerObjectHelper)

Initializes a new instance of the SOIBase class. If used directly, call it from the Init(IServerObjectHelper) implementation.

public SOIBase(IServerObjectHelper soHelper)

Parameters

soHelper IServerObjectHelper

IServerObjectHelper reference.

Properties

ServerEnvironment

The ServerEnvironment property provides access to the IServerEnvironment2 reference. It is a read-only property. The most common usage of the ServerEnvironment property is to obtain user information from the ServerEnvironment.UserInfo.

public IServerEnvironment2 ServerEnvironment { get; }

Property Value

IServerEnvironment2

ServerObjectHelper

The ServerObjectHelper property provides access to the IServerObjectHelper reference. It is a read-only property.

public IServerObjectHelper ServerObjectHelper { get; }

Property Value

IServerObjectHelper

Methods

FindRequestHandlerDelegate<THandlerInterface>()

The FindRequestHandlerDelegate is the most important method in SOIBase. It finds and returns the reference to the proper request handler based on the handler interface type.

public THandlerInterface FindRequestHandlerDelegate<THandlerInterface>() where THandlerInterface : class

Returns

THandlerInterface

Requested handler reference or null.

Type Parameters

THandlerInterface

Type of the requested handler interface. Allowed interface types include IRESTRequestHandler, IWebRequestHandler, IRequestHandler2, IRequestHandler.

GetRoleInformation(IServerUserInfo)

Get allowed roles for the user making a request. Deprecated. Use ServerUtilities.GetGroupInfo() instead.

public HashSet<string> GetRoleInformation(IServerUserInfo userInfo)

Parameters

userInfo IServerUserInfo

Returns

HashSet<string>

set of roles

GetServerEnvironment()

The GetServerEnvironment method obtains reference to IServerEnvironment2 for current server environment. This method does not cache any references. If you want to get cached IServerEnvironment2 reference for better performance, use SOIBase.ServerEnvironment property. Deprecated. Use ServerUtilities.GetServerEnvironment() instead.

public static IServerEnvironment2 GetServerEnvironment()

Returns

IServerEnvironment2

QueryConfigurationProperties(string, string)

Retrieves service configuration properties using local admin connection. Deprecated. Use ServerUtilities.QueryConfigurationProperties() instead.

public static IPropertySet QueryConfigurationProperties(string servicename, string typename)

Parameters

servicename string

Service name

typename string

Service type

Returns

IPropertySet