com.esri.arcgis.server
Interface IServerLogQuery

All Superinterfaces:

Serializable

All Known Implementing Classes:

IServerLogQueryProxy

public interface IServerLogQuery
extends 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.

Method Summary

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	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.

Method Detail

getStartTime

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.

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartTime

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.

Parameters:

pTime - The pTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

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.

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTime

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.

Parameters:

pTime - The pTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTarget

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.

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTarget

void setTarget(String pName)
               throws IOException,
                      AutomationException

The log target name.

Product Availability

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

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMachine

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.

Returns:

The pMachine

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMachine

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.

Parameters:

pMachine - The pMachine (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevel

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.

Returns:

The pLevel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevel

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.

Parameters:

pLevel - The pLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRecords

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecords

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartIndex

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.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartIndex

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.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.