Cisco Cisco Customer Voice Portal Downloads Developer's Guide

Page of 98
C
HAPTER 
13:
 
L
OGGERS
 
 
V
OICE
XML
 
P
ROGRAMMING 
G
UIDE 
 
 
 
FOR 
C
ISCO 
U
NIFIED 
C
USTOMER 
V
OICE 
P
ORTAL 
R
ELEASE 
4.0(1) 
 
 
 
 
72
 
Utility Methods 
These utility methods provide important information to the logger.  
String getLogFileDirectory()  
This method returns the full path of the directory Unified CVP VoiceXML Server has provided 
this logger to store its logs, if necessary. On startup, the VoiceXML Server creates a folder for 
each logger instance whose name is the logger instance name within the logs folder of the 
application. This folder is for exclusive use of the logger referenced in the logger instance should 
it require it. Should the logger create log files, it should use this directory, unless the logger’s 
configuration specified to log somewhere else. Should the logger not use files, such as if it logs 
directly to a database,  this method and the folder it references can be ignored. 
String getApplicationName()  
This method returns the name of the application that the logger instance belongs to. 
String enforceCallEventOrder()  
This method returns true if the logger instance has been configured to enforce the call event 
order, false otherwise. This is useful if the logger wishes to throw an error if the logger instance 
was not configured a certain way. 
HashSet getEventsListeningFor()  
This method returns the HashSet containing the event IDs that the logger is handling. This 
method is called by Unified CVP VoiceXML Server to determine if to send a new event to the 
logger. This methods simply returns the protected member variable eventsToListenFor defined in 
LoggerBase. 
String getLoggerInstanceName()  
This method returns the name of the logger instance as defined by the application designer for 
the application. 
int getLoggerType() 
This method returns the type of the logger, and is for future use.  Currently, it always returns 
APPLICATION_LOGGER
.