com.esri.arcgis.server
Class IServerLogQueryProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.server.IServerLogQueryProxy

All Implemented Interfaces:

IServerLogQuery, Externalizable, Serializable

public class IServerLogQueryProxy
extends com.esri.arcgis.interop.Dispatch
implements IServerLogQuery, Serializable

Provides access to members that configure a query to the ArcGIS Server logs.

Remarks

The IServerLogQuery interface is retrieved from the CreateQuery method of the IServerLog interface. After populating its properties, the IServerLogQuery interface is used as an argument to the GetLogRecords method of the IServerLog interface.

The StartTime and EndTime properties can be set programmatically (i.e. not hard coded) by getting a time interval from the IServerTimeRange interface via the IServerStatistics interface (see code example).

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

	IServerLogQueryProxy()
	IServerLogQueryProxy(Object obj)
protected	IServerLogQueryProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
Date	getEndTime() The end time in the ArcGIS Server logs at which to end the query.
int	getLevel() The log level at which to query (1-5).
String	getMachine() The machine name for which to query.
int	getMaxRecords() The maximum number of records to retrieve with the query.
int	getStartIndex() The starting index at which to start retrieving records from the query.
Date	getStartTime() The start time in the ArcGIS Server logs at which to begin the query.
String	getTarget() The log target name.
void	removeListener(String iidStr, Object theListener)
void	setEndTime(Date pTime) The end time in the ArcGIS Server logs at which to end the query.
void	setLevel(int pLevel) The log level at which to query (1-5).
void	setMachine(String pMachine) The machine name for which to query.
void	setMaxRecords(int pVal) The maximum number of records to retrieve with the query.
void	setStartIndex(int pVal) The starting index at which to start retrieving records from the query.
void	setStartTime(Date pTime) The start time in the ArcGIS Server logs at which to begin the query.
void	setTarget(String pName) The log target name.

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IServerLogQueryProxy

public IServerLogQueryProxy()

IServerLogQueryProxy

public IServerLogQueryProxy(Object obj)
                     throws IOException

Throws:

IOException

IServerLogQueryProxy

protected IServerLogQueryProxy(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 com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getStartTime

public Date getStartTime()
                  throws IOException,
                         AutomationException

The start time in the ArcGIS Server logs at which to begin the query.

Product Availability

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

Specified by:

getStartTime in interface IServerLogQuery

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

public void setStartTime(Date pTime)
                  throws IOException,
                         AutomationException

The start time in the ArcGIS Server logs at which to begin the query.

Product Availability

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

Specified by:

setStartTime in interface IServerLogQuery

Parameters:

pTime - The pTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

public Date getEndTime()
                throws IOException,
                       AutomationException

The end time in the ArcGIS Server logs at which to end the query.

Product Availability

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

Specified by:

getEndTime in interface IServerLogQuery

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTime

public void setEndTime(Date pTime)
                throws IOException,
                       AutomationException

The end time in the ArcGIS Server logs at which to end the query.

Product Availability

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

Specified by:

setEndTime in interface IServerLogQuery

Parameters:

pTime - The pTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTarget

public String getTarget()
                 throws IOException,
                        AutomationException

The log target name.

Remarks

The Target property refers to the name of objects running in the server. For example, "Server", "SDM.ServerDirectoryManager", "SrvLog.ServerLog", and the various server object configurations that have been deployed.

Product Availability

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

Specified by:

getTarget in interface IServerLogQuery

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTarget

public void setTarget(String pName)
               throws IOException,
                      AutomationException

The log target name.

Product Availability

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

Specified by:

setTarget in interface IServerLogQuery

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMachine

public String getMachine()
                  throws IOException,
                         AutomationException

The machine name for which to query.

Remarks

The Machine property refers to the name of a particular SOC machine in your ArcGIS Server system.

Product Availability

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

Specified by:

getMachine in interface IServerLogQuery

Returns:

The pMachine

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMachine

public void setMachine(String pMachine)
                throws IOException,
                       AutomationException

The machine name for which to query.

Product Availability

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

Specified by:

setMachine in interface IServerLogQuery

Parameters:

pMachine - The pMachine (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevel

public int getLevel()
             throws IOException,
                    AutomationException

The log level at which to query (1-5).

Remarks

LogLevel: this is a number between 0 and 5 which indicates the level of detail that the server logs. By default, the LogLevel is 3. The following is a description of the each log level:

• 0 (None): No logging
• 1 (Error): Serious problems that require immediate attention
• 2 (Warning): Problems that require attention
• 3 (Normal): Common administrative messages of the server
• 4 (Detailed): Very common messages from user use of the server, including server objects
• 5 (Debug): verbose messages to aid in troubleshooting

Querying for a specific log level will return log entries for that log level and below.

Product Availability

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

Specified by:

getLevel in interface IServerLogQuery

Returns:

The pLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevel

public void setLevel(int pLevel)
              throws IOException,
                     AutomationException

The log level at which to query (1-5).

Product Availability

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

Specified by:

setLevel in interface IServerLogQuery

Parameters:

pLevel - The pLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRecords

public int getMaxRecords()
                  throws IOException,
                         AutomationException

The maximum number of records to retrieve with the query.

Product Availability

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

Specified by:

getMaxRecords in interface IServerLogQuery

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecords

public void setMaxRecords(int pVal)
                   throws IOException,
                          AutomationException

The maximum number of records to retrieve with the query.

Product Availability

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

Specified by:

setMaxRecords in interface IServerLogQuery

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartIndex

public int getStartIndex()
                  throws IOException,
                         AutomationException

The starting index at which to start retrieving records from the query.

Product Availability

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

Specified by:

getStartIndex in interface IServerLogQuery

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartIndex

public void setStartIndex(int pVal)
                   throws IOException,
                          AutomationException

The starting index at which to start retrieving records from the query.

Product Availability

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

Specified by:

setStartIndex in interface IServerLogQuery

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.