Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


com.bea.wcp.diameter.management.descriptor.beans
Interface MessageDebugBean

All Superinterfaces:
DiameterDescriptorBean

public interface MessageDebugBean
extends DiameterDescriptorBean

Method Summary
 String getDateFormatPattern()
          The date format pattern used for rendering dates in the Server log file and stdout output.
 int getFileCount()
          The maximum number of log files that the server creates when it rotates the log.
 int getFileMinSize()
          The size (1 - 65535 kilobytes) that triggers the server to move log messages to a separate file.
 int getFileTimeSpan()
          The interval (in hours) at which the server saves old log messages to another file.
 long getFileTimeSpanFactor()
          This factor is defined so that log rotation can be tested at a different frequency.
 String getLogFilename()
          The name of the log file that stores Diameter messages.
 String getLogFileRotationDir()
          The directory where the rotated log files will be stored.
 String getRotationTime()
          Determines the start time (hour and minute) for a time-based rotation sequence.
 String getRotationType()
          Defines the criteria for moving old log messages to a separate file.
 boolean isLoggingEnabled()
          Indicates whether this server logs Diameter messages into an independent log file.
 boolean isMessageDebugEnabled()
          Specifies whether diameter message tracing is enabled.
 boolean isNumberOfFilesLimited()
          Indicates whether to limit the number of log files that this server instance creates to store old messages.
 boolean isRotateLogOnStartup()
          Specifies whether a server rotates its log file during its startup cycle.
 void setDateFormatPattern(String dateFormatPattern)
           
 void setFileCount(int fileCount)
           
 void setFileMinSize(int size)
           
 void setFileTimeSpan(int fileTimeSpan)
           
 void setFileTimeSpanFactor(long factor)
           
 void setLogFilename(String logFilename)
           
 void setLogFileRotationDir(String logFileRotationDir)
           
 void setLoggingEnabled(boolean loggingEnabled)
           
 void setMessageDebugEnabled(boolean messageDebug)
           
 void setNumberOfFilesLimited(boolean numberOfFilesLimited)
           
 void setRotateLogOnStartup(boolean rotateLogOnStartup)
           
 void setRotationTime(String rotationTime)
           
 void setRotationType(String rotationType)
           

 

Methods inherited from interface com.bea.wcp.diameter.management.descriptor.beans.DiameterDescriptorBean
getName, setName

 

Method Detail

isMessageDebugEnabled

boolean isMessageDebugEnabled()
Specifies whether diameter message tracing is enabled.
Returns:

setMessageDebugEnabled

void setMessageDebugEnabled(boolean messageDebug)

isLoggingEnabled

boolean isLoggingEnabled()
Indicates whether this server logs Diameter messages into an independent log file.

setLoggingEnabled

void setLoggingEnabled(boolean loggingEnabled)

getFileTimeSpanFactor

long getFileTimeSpanFactor()
This factor is defined so that log rotation can be tested at a different frequency.
Returns:

setFileTimeSpanFactor

void setFileTimeSpanFactor(long factor)

getFileMinSize

int getFileMinSize()
The size (1 - 65535 kilobytes) that triggers the server to move log messages to a separate file. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as FileName.n and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)

setFileMinSize

void setFileMinSize(int size)

getLogFilename

String getLogFilename()
The name of the log file that stores Diameter messages.

setLogFilename

void setLogFilename(String logFilename)

getRotationType

String getRotationType()
Defines the criteria for moving old log messages to a separate file.

setRotationType

void setRotationType(String rotationType)
Parameters:
rotationType -

isNumberOfFilesLimited

boolean isNumberOfFilesLimited()
Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)

setNumberOfFilesLimited

void setNumberOfFilesLimited(boolean numberOfFilesLimited)

getFileCount

int getFileCount()
The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)

setFileCount

void setFileCount(int fileCount)

isRotateLogOnStartup

boolean isRotateLogOnStartup()
Specifies whether a server rotates its log file during its startup cycle.

setRotateLogOnStartup

void setRotateLogOnStartup(boolean rotateLogOnStartup)

getLogFileRotationDir

String getLogFileRotationDir()
The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.

setLogFileRotationDir

void setLogFileRotationDir(String logFileRotationDir)

getRotationTime

String getRotationTime()
Determines the start time (hour and minute) for a time-based rotation sequence. (Requires that you specify a file rotation type of TIME.)

setRotationTime

void setRotationTime(String rotationTime)

getFileTimeSpan

int getFileTimeSpan()
The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)

setFileTimeSpan

void setFileTimeSpan(int fileTimeSpan)

getDateFormatPattern

String getDateFormatPattern()

The date format pattern used for rendering dates in the Server log file and stdout output. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.


setDateFormatPattern

void setDateFormatPattern(String dateFormatPattern)

Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.1

E36938-01


Copyright © 2012 Oracle Corporation. All Rights Reserved.