Cisco Cisco Customer Voice Portal Downloads Developer's Guide

C

HAPTER 

13:

 

L

OGGERS

 

 

P

ROGRAMMING 

G

UIDE FOR 

C

ISCO 

U

NIFIED 

CVP

 

VXML

 

S

ERVER 

 

 

 

AND 

C

ISCO 

U

NIFIED 

C

ALL 

S

TUDIO 

R

ELEASE 

4.1(1) 

 

77 

These methods are defined in the LoggerBase class and are therefore applicable to both 
application and global loggers. 

int getLoggerType() 

This method returns the type of the logger, and is for future use.  Currently, it returns 

APPLICATION_LOGGER 

or

 GLOBAL_LOGGER.

 

String getLoggerInstanceName()  

This method returns the name of the logger instance as defined in either VXML Server’s 
configuration or the settings of the application. 

HashSet getEventsListeningFor()  

This method returns the 

HashSet

 containing the event IDs that the logger is handling. This 

method is called by VXML 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 getLogFileDirectory()  

This method returns the full path of the directory VXML Server has provided this logger to store 
its logs, if necessary. On startup, VXML Server creates a folder for each global logger instance 
within the global 

logs

 folder. It also creates a folder for each application logger instance within 

the 

logs

 folder of the particular appliation. The folders are given the logger instance name. The 

folder is for exclusive use of the logger instance should it require it. Should the logger create log 
files, it should use this directory unless the logger’s is designed 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. 

These utility methods apply only to application loggers. 

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.