com.esri.arcgis.system
Class ILog2Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.system.ILogProxy
          extended by com.esri.arcgis.system.ILog2Proxy
All Implemented Interfaces:
ILog, ILog2, Externalizable, Serializable

public class ILog2Proxy
extends ILogProxy
implements ILog2, Serializable

Provides access to methods for accessing a 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 for 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.

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  ILog2Proxy()
           
  ILog2Proxy(Object obj)
           
protected ILog2Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void addMessageEx(int msgType, String methodName, int msgCode, double elapsed, String msg)
          Adds a message to the log.
 void removeListener(String iidStr, Object theListener)
           
 boolean willLog(int msgType)
          True if the message type is allowed to be written into the log file.
 
Methods inherited from class com.esri.arcgis.system.ILogProxy
addMessage
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.system.ILog
addMessage
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

ILog2Proxy

public ILog2Proxy()

ILog2Proxy

public ILog2Proxy(Object obj)
           throws IOException
Throws:
IOException

ILog2Proxy

protected ILog2Proxy(Object obj,
                     String iid)
              throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class ILogProxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class ILogProxy
Throws:
IOException

willLog

public boolean willLog(int msgType)
                throws IOException,
                       AutomationException
True if the message type is allowed to be written into the log file.

Product Availability

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

Specified by:
willLog in interface ILog2
Parameters:
msgType - The msgType (in)
Returns:
The willLog
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessageEx

public void addMessageEx(int msgType,
                         String methodName,
                         int msgCode,
                         double elapsed,
                         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 for 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.

Specified by:
addMessageEx in interface ILog2
Parameters:
msgType - The msgType (in)
methodName - The methodName (in)
msgCode - The msgCode (in)
elapsed - The elapsed (in)
msg - The msg (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.