Class ServerObjectInterceptorAttribute

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

Use ServerObjectInterceptor attribute to annotate main SOI class. An Add-in package can have multiple ServerObjectInterceptor classes but it is not recommended.

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public class ServerObjectInterceptorAttribute : Attribute
Inheritance
ServerObjectInterceptorAttribute
Inherited Members

Constructors

ServerObjectInterceptorAttribute(string)

ServerObjectInterceptorAttribute constructor.

public ServerObjectInterceptorAttribute(string serverobject)

Parameters

serverobject string

Type of the server object that this SOI was designed for. Example: 'MapServer'.

Properties

Description

SOI description.

public virtual string Description { get; set; }

Property Value

string

DisplayName

SOI display name that you will see in Manager or other admin client.

public virtual string DisplayName { get; set; }

Property Value

string

HasManagerPropertiesConfigurationPane

Set this flag to true if you have custom JS widget for the SOE properties pane in Manager. See ServerSimpleRESTSOEWithProperties SDK sample for details.

public virtual bool HasManagerPropertiesConfigurationPane { get; set; }

Property Value

bool

Properties

SOI properties. List of name=value string pairs in a semicolon-separated list. name=value;name1=value1

public virtual string Properties { get; set; }

Property Value

string

Examples

This example shows how to define SOI properties.

    [ServerObjectExtension("MapServer",
    AllCapabilities = "",
    DefaultCapabilities = "",
    Description = ".NET Simple REST SOE With Properties",
    DisplayName = ".NET Simple REST SOE With Properties",
    Properties = "layerType=feature;returnFormat=json;maxNumFeatures=100;isEditable=false",
    HasManagerPropertiesConfigurationPane = false,
    SupportsREST = true,
    SupportsSOAP = false)]
public class NetSimpleRESTSOEWithProperties : IServerObjectExtension, IObjectConstruct, IRESTRequestHandler

ServerObjectType

Type of the server object that this SOE was designed for. Example: 'MapServer'.

public virtual string ServerObjectType { get; set; }

Property Value

string

SupportsSharedInstances

Shows that SOE supports deployment to Shared Instances host. Default is false.

public virtual bool SupportsSharedInstances { get; set; }

Property Value

bool