C# Class SolarCalculator.SoeBase

Base class cruft for a server object extension

Datei anzeigen Open project: steveoh/SolarCalculator

Public Properties

Property	Type	Description
ConfigProps	IPropertySet
ReqHandler	IRESTRequestHandler
ServerObjectHelper	IServerObjectHelper

Public Methods

Method	Description
Construct ( IPropertySet props ) : void	This is where you put any expensive business logic that you don’t need to run on each request. For example, if you know you’re always working with the same layer in the map, you can put the code to get the layer here.
GetSchema ( ) : string	Gets the schema.
HandleRESTRequest ( string capabilities, string resourceName, string operationName, string operationInput, string outputFormat, string requestProperties, string &responseProperties ) : byte[]	Allows for REST requests and responses to come into the service. These methods create the schema and handle the requests.
Init ( IServerObjectHelper serverObjectHelper ) : void	Initializes and starts the server object specified by the IServerObjectHelper reference. If you have business logic that you want to run when the SOE first becomes enabled, don’t put it in Init() or in your SOE class’s constructor; instead, use the following IObjectConstruct.Construct() method
Shutdown ( ) : void	stops the server object specified by the IServerObjectHelper reference. Cleans up after itself before shutting down its parent mapservice etc.

Method Details

Construct() public method

This is where you put any expensive business logic that you don’t need to run on each request. For example, if you know you’re always working with the same layer in the map, you can put the code to get the layer here.

public Construct ( IPropertySet props ) : void
props	IPropertySet	The props.
return	void

GetSchema() public method

Gets the schema.

public GetSchema ( ) : string
return	string

HandleRESTRequest() public method

Allows for REST requests and responses to come into the service. These methods create the schema and handle the requests.

public HandleRESTRequest ( string capabilities, string resourceName, string operationName, string operationInput, string outputFormat, string requestProperties, string &responseProperties ) : byte[]
capabilities	string	The capabilities.
resourceName	string	Name of the resource.
operationName	string	Name of the operation.
operationInput	string	The operation input.
outputFormat	string	The output format.
requestProperties	string	The request properties.
responseProperties	string	The response properties.
return	byte[]

Init() public method

Initializes and starts the server object specified by the IServerObjectHelper reference. If you have business logic that you want to run when the SOE first becomes enabled, don’t put it in Init() or in your SOE class’s constructor; instead, use the following IObjectConstruct.Construct() method

public Init ( IServerObjectHelper serverObjectHelper ) : void
serverObjectHelper	IServerObjectHelper	The server object helper.
return	void

Shutdown() public method

stops the server object specified by the IServerObjectHelper reference. Cleans up after itself before shutting down its parent mapservice etc.

public Shutdown ( ) : void
return	void

Property Details

ConfigProps public_oe property

public IPropertySet ConfigProps
return	IPropertySet

ReqHandler public_oe property

public IRESTRequestHandler ReqHandler
return	IRESTRequestHandler

ServerObjectHelper public_oe property

public IServerObjectHelper ServerObjectHelper
return	IServerObjectHelper