com.esri.arcgis.system
Interface ILog

All Superinterfaces:

Serializable

All Known Subinterfaces:

ILog2

All Known Implementing Classes:

ILog2Proxy, ILogProxy

public interface ILog
extends Serializable

Provides access to methods for accessing a log.

Superseded By

ILog2

Description

If you want your server object extension to log messages to the GIS server's log file, your server object extension should implement ILogSupport. ILogSupport is an optional interface for server object extensions that has a single InitLogging method. InitLogging is called when the server object extension is created and hands back a reference to the GIS server's log object via the log argument. Once you have a reference to the server log, you will often call a single method, AddMessage(), to add information to the log. The AddMessage() method has three parameters: level, code, and message.

The level is the level of detail of the message in relation to other messages. Levels are classified from 1 to 5 and termed, in order, Error, Warning, Normal, Detailed, and Debug. ArcGIS Server log file settings determine which messages are included in the server log.

The code is the result code associated with the message. The code is an arbitrary integer value to uniquely define the source of the message. Codes 0 - 5999 are utilized by the SOM. Codes 6000 and above can be generated by any serviced component (e.g. MapServer, GeocodeServer, custom component, etc.).

The message is the custom string inserted into the GIS server log file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	addMessage(int msgType, int msgCode, String msg) Adds a message to the log.

Method Detail

addMessage

void addMessage(int msgType,
                int msgCode,
                String msg)
                throws IOException,
                       AutomationException

Adds a message to the log.

Description

If you want your server object extension to log messages to the GIS server's log file, your server object extension should implement ILogSupport. ILogSupport is an optional interface for server object extensions that has a single InitLogging method. InitLogging is called when the server object extension is created and hands back a reference to the GIS server's log object via the log argument. Once you have a reference to the server log, you will often call a single method, AddMessage(), to add information to the log. The AddMessage() method has three parameters: level, code, and message.

The level is the level of detail of the message in relation to other messages. Levels are classified from 1 to 5 and termed, in order, Error, Warning, Normal, Detailed, and Debug. ArcGIS Server log file settings determine which messages are included in the server log.

The code is the result code associated with the message. The code is an arbitrary integer value to uniquely define the source of the message. Codes 0 - 5999 are utilized by the SOM. Codes 6000 and above can be generated by any serviced component (e.g. MapServer, GeocodeServer, custom component, etc.).

The message is the custom string inserted into the GIS server log file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

msgType - The msgType (in)

msgCode - The msgCode (in)

msg - The msg (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.