com.arsdigita.developersupport
Class DeveloperSupport

java.lang.Object
  extended bycom.arsdigita.developersupport.DeveloperSupport

public class DeveloperSupport
extends Object

DeveloperSupport This class provides interfaces called by the request handling and database code for collecting developer support information. By registering DeveloperSupportListener's, you can add handlers for this information.

Version:
1.0
Author:
Joseph A. Bank (jbank@alum.mit.edu)

Field Summary
static String versionId
           
 
Method Summary
static void addListener(DeveloperSupportListener l)
          addListener Add a new listener.
static boolean containsListener(DeveloperSupportListener l)
           
static void endStage(String stagename)
          endStage Callback indicating a stage has ended.
static int getListenerCount()
           
static void logComment(String comment)
          logComment Log a generic comment
static void logQuery(int connection_id, String type, String query, HashMap bindvars, long time, SQLException sqle)
          logQuery Callback logging a database query.
static void removeListener(DeveloperSupportListener l)
           
static void requestAddProperty(Object request, String property, Object value)
          requestAddProperty Add a new property about this request.
static void requestEnd(Object request)
          requestEnd Callback indicating the request ended
static void requestStart(Object request)
          requeststart Callback indicating a new request has started.
static void startStage(String stagename)
          startStage Callback indicating a new stage has started.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Method Detail

addListener

public static void addListener(DeveloperSupportListener l)
addListener Add a new listener.


removeListener

public static void removeListener(DeveloperSupportListener l)

containsListener

public static boolean containsListener(DeveloperSupportListener l)

getListenerCount

public static int getListenerCount()

requestStart

public static void requestStart(Object request)
requeststart Callback indicating a new request has started. Request is an opaque pointer for now for linkage purposes (don't want to have dependencies on the dispatcher here) and for making this infrastructure more general.


requestAddProperty

public static void requestAddProperty(Object request,
                                      String property,
                                      Object value)
requestAddProperty Add a new property about this request.


requestEnd

public static void requestEnd(Object request)
requestEnd Callback indicating the request ended


logQuery

public static void logQuery(int connection_id,
                            String type,
                            String query,
                            HashMap bindvars,
                            long time,
                            SQLException sqle)
logQuery Callback logging a database query. sqle should be null if no exception was thrown, otherwise it should be the exception thrown


logComment

public static void logComment(String comment)
logComment Log a generic comment


startStage

public static void startStage(String stagename)
startStage Callback indicating a new stage has started. Stages can be used to log help mark the time taken to perform various parts of requests.


endStage

public static void endStage(String stagename)
endStage Callback indicating a stage has ended. Stages can be used to log help mark the time taken to perform various parts of requests.



Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC