Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.ticket

Class TicketLoggingHandler

java.lang.Object

java.util.logging.Handler

com.aoapps.hodgepodge.logging.QueuedHandler

com.aoindustries.aoserv.client.ticket.TicketLoggingHandler

public class TicketLoggingHandler
extends QueuedHandler

An implementation of Handler that logs to the ticket system. It queues log entries and logs them in the background. The log entries are added in the order received, regardless of priority.

Will first look for any open/hold/bounced ticket that is for the same brand, account, language, type, level, prefix, classname, method, and category. If found, it will annotate that ticket. If not found, it will create a new ticket.

To minimize resource consumption, this shares one ExecutorService for all handlers, which means tickets are fed to the master(s) sequentially, even across many different connectors.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Modifier	Constructor	Description
	TicketLoggingHandler()	Public constructor required so can be specified in logging.properties.
protected	TicketLoggingHandler(String summaryPrefix, AOServConnector connector, String categoryDotPath)

Method Summary

Modifier and Type	Method	Description
protected void	backgroundPublish(Formatter formatter, LogRecord record, String fullReport)
void	close()	Clean-up this handler and any that were garbage collected.
static String	generateActionSummary(Formatter formatter, LogRecord record)
static TicketLoggingHandler	getHandler(String summaryPrefix, AOServConnector connector, String categoryDotPath)	Only one TicketLoggingHandler will be created per unique summaryPrefix, AOServConnector, and categoryDotPath.
static String	getPriorityName(Level level)	Gets the name of a Priority that corresponds to the given Level.

Methods inherited from class com.aoapps.hodgepodge.logging.QueuedHandler

flush, newExecutor, publish, shutdownExecutor

Methods inherited from class java.util.logging.Handler

getEncoding, getErrorManager, getFilter, getFormatter, getLevel, isLoggable, reportError, setEncoding, setErrorManager, setFilter, setFormatter, setLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TicketLoggingHandler

protected TicketLoggingHandler(String summaryPrefix,
                               AOServConnector connector,
                               String categoryDotPath)

TicketLoggingHandler

public TicketLoggingHandler()
                     throws ConfigurationException

Public constructor required so can be specified in logging.properties. Supports the following optional settings in logging.properties:

• (classname).summaryPrefix - the summary prefix for tickets.
• (classname).username - the username to login as. When not set, the username from aoserv-client.properties is used.
• (classname).password - the password to login with. When not set, the password from aoserv-client.properties is used.
• (classname).categoryDotPath - the category dot path for tickets.

Throws:

ConfigurationException

Method Detail

getHandler

public static TicketLoggingHandler getHandler(String summaryPrefix,
                                              AOServConnector connector,
                                              String categoryDotPath)

Only one TicketLoggingHandler will be created per unique summaryPrefix, AOServConnector, and categoryDotPath.

close

public void close()
           throws SecurityException

Clean-up this handler and any that were garbage collected.

Overrides:

close in class QueuedHandler

Throws:

SecurityException

backgroundPublish

protected void backgroundPublish(Formatter formatter,
                                 LogRecord record,
                                 String fullReport)
                          throws IOException,
                                 SQLException

Specified by:

backgroundPublish in class QueuedHandler

Throws:

IOException

SQLException

generateActionSummary

public static String generateActionSummary(Formatter formatter,
                                           LogRecord record)

getPriorityName

public static String getPriorityName(Level level)

Gets the name of a Priority that corresponds to the given Level.