MessageDebugBean (Oracle Communications Converged Application Server 7.0 Java API Reference)

All Superinterfaces:

weblogic.descriptor.DescriptorBean, weblogic.descriptor.SettableBean, WlssBean
```
public interface MessageDebugBean
extends WlssBean
```
Author:

Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`LEVEL_BASIC`
`static String`	`LEVEL_FULL`
`static String`	`LEVEL_TERSE`
`static String`	`PARAM_MSG_CALL_ID`
`static String`	`PARAM_MSG_CONTENT`
`static String`	`PARAM_MSG_CONTENT_LENGTH`
`static String`	`PARAM_MSG_CONTENT_TYPE`
`static String`	`PARAM_MSG_CSEQ`
`static String`	`PARAM_MSG_DATE`
`static String`	`PARAM_MSG_FROM`
`static String`	`PARAM_MSG_FROM_ADDR`
`static String`	`PARAM_MSG_FROM_PORT`
`static String`	`PARAM_MSG_FROM_TAG`
`static String`	`PARAM_MSG_FROM_URI`
`static String`	`PARAM_MSG_HEADERS`
`static String`	`PARAM_MSG_INCOMING`
`static String`	`PARAM_MSG_METHOD`
`static String`	`PARAM_MSG_MSG_SUMMARY`
`static String`	`PARAM_MSG_PROTOCOL`
`static String`	`PARAM_MSG_REASON`
`static String`	`PARAM_MSG_REQ_URI`
`static String`	`PARAM_MSG_STATUS`
`static String`	`PARAM_MSG_TIME`
`static String`	`PARAM_MSG_TIMESTAMP`
`static String`	`PARAM_MSG_TO`
`static String`	`PARAM_MSG_TO_ADDR`
`static String`	`PARAM_MSG_TO_PORT`
`static String`	`PARAM_MSG_TO_TAG`
`static String`	`PARAM_MSG_TO_URI`
`static String`	`PARAM_MSG_TYPE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`FormatBean`	`createFormat()`
`StringRepBean`	`createStringRep()`
`void`	`destroyFormat()`
`void`	`destroyStringRep()`
`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()` Defined the log rotation testing frequency.
`FormatBean`	`getFormat()`
`String`	`getLevel()` The predefined collection of information to log for each SIP request and response.
`String`	`getLogFilename()` The name of the log file that stores SIP 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.
`StringRepBean`	`getStringRep()`
`boolean`	`isLocalLoggingEnabled()` Specifies whether locally routed messages should be logged
`boolean`	`isLoggingEnabled()` Specifies whether the server logs SIP messages to an independent log file.
`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`	`setLevel(String level)`
`void`	`setLocalLoggingEnabled(boolean localLoggingEnabled)`
`void`	`setLogFilename(String logFilename)`
`void`	`setLogFileRotationDir(String logFileRotationDir)`
`void`	`setLoggingEnabled(boolean loggingEnabled)`
`void`	`setNumberOfFilesLimited(boolean numberOfFilesLimited)`
`void`	`setRotateLogOnStartup(boolean rotateLogOnStartup)`
`void`	`setRotationTime(String rotationTime)`
`void`	`setRotationType(String rotationType)`

Methods inherited from interface com.bea.wcp.sip.management.descriptor.beans.WlssBean
getName, setName

Methods inherited from interface weblogic.descriptor.DescriptorBean
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet

- Field Detail
  - PARAM_MSG_INCOMING
```
static final String PARAM_MSG_INCOMING
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TIMESTAMP
```
static final String PARAM_MSG_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_DATE
```
static final String PARAM_MSG_DATE
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TIME
```
static final String PARAM_MSG_TIME
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_FROM_ADDR
```
static final String PARAM_MSG_FROM_ADDR
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_FROM_PORT
```
static final String PARAM_MSG_FROM_PORT
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TO_ADDR
```
static final String PARAM_MSG_TO_ADDR
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TO_PORT
```
static final String PARAM_MSG_TO_PORT
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TYPE
```
static final String PARAM_MSG_TYPE
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_MSG_SUMMARY
```
static final String PARAM_MSG_MSG_SUMMARY
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_CALL_ID
```
static final String PARAM_MSG_CALL_ID
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_STATUS
```
static final String PARAM_MSG_STATUS
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_REASON
```
static final String PARAM_MSG_REASON
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_METHOD
```
static final String PARAM_MSG_METHOD
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_CSEQ
```
static final String PARAM_MSG_CSEQ
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_PROTOCOL
```
static final String PARAM_MSG_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_REQ_URI
```
static final String PARAM_MSG_REQ_URI
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_FROM
```
static final String PARAM_MSG_FROM
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_FROM_URI
```
static final String PARAM_MSG_FROM_URI
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_FROM_TAG
```
static final String PARAM_MSG_FROM_TAG
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TO
```
static final String PARAM_MSG_TO
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TO_URI
```
static final String PARAM_MSG_TO_URI
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_TO_TAG
```
static final String PARAM_MSG_TO_TAG
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_HEADERS
```
static final String PARAM_MSG_HEADERS
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_CONTENT_TYPE
```
static final String PARAM_MSG_CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_CONTENT_LENGTH
```
static final String PARAM_MSG_CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - PARAM_MSG_CONTENT
```
static final String PARAM_MSG_CONTENT
```
    See Also:
    
    Constant Field Values
  - LEVEL_TERSE
```
static final String LEVEL_TERSE
```
    See Also:
    
    Constant Field Values
  - LEVEL_FULL
```
static final String LEVEL_FULL
```
    See Also:
    
    Constant Field Values
  - LEVEL_BASIC
```
static final String LEVEL_BASIC
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getLevel
```
String getLevel()
```
    The predefined collection of information to log for each SIP request and response.
    
    The following levels are supported:
    - terse: Logs only the domain setting, logging Servlet name, logging level, and whether or not the message is an incoming message.
    - basic: Logs the terse items plus the SIP message status, reason phrase, the type of response or request, the SIP method, the From header, and the To header.
    - full: Logs the basic items plus all SIP message headers plus the timestamp, protocol, request URI, request type, response type, content type, and raw content.
  - setLevel
```
void setLevel(String level)
```
  - getFormat
```
FormatBean getFormat()
```
  - createFormat
```
FormatBean createFormat()
```
  - destroyFormat
```
void destroyFormat()
```
  - getStringRep
```
StringRepBean getStringRep()
```
  - createStringRep
```
StringRepBean createStringRep()
```
  - destroyStringRep
```
void destroyStringRep()
```
  - isLoggingEnabled
```
boolean isLoggingEnabled()
```
    Specifies whether the server logs SIP messages to an independent log file.
  - setLoggingEnabled
```
void setLoggingEnabled(boolean loggingEnabled)
```
  - isLocalLoggingEnabled
```
boolean isLocalLoggingEnabled()
```
    Specifies whether locally routed messages should be logged
  - setLocalLoggingEnabled
```
void setLocalLoggingEnabled(boolean localLoggingEnabled)
```
  - getFileTimeSpanFactor
```
long getFileTimeSpanFactor()
```
    Defined the log rotation testing 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.
    
    When the server checks the file size, if the log file has reached the specified minimum size, the server renames the current log file as FileName.logN, and creates a new file to store subsequent messages.
    
    Note: This setting requires that you specify a file rotation type of 'bySize.'
  - setFileMinSize
```
void setFileMinSize(int size)
```
  - getLogFilename
```
String getLogFilename()
```
    The name of the log file that stores SIP 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 'bySize' or 'byTime'.)
  - 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 'Limit number of retained files'.)
  - 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.
    
    Note: This setting requires that you set a log rotation type of hours and minutes ('hh:mm'; i.e., 07:30).
  - setRotationTime
```
void setRotationTime(String rotationTime)
```
  - getFileTimeSpan
```
int getFileTimeSpan()
```
    The interval (in hours) at which the server saves old log messages to another file.
    
    Note: This setting requires that you set a log rotation type of hours and minutes ('hh:mm'; i.e., 07:30).
  - 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)
```

Interface MessageDebugBean

Field Summary

Method Summary

Methods inherited from interface com.bea.wcp.sip.management.descriptor.beans.WlssBean

Methods inherited from interface weblogic.descriptor.DescriptorBean

Methods inherited from interface weblogic.descriptor.SettableBean

Field Detail

PARAM_MSG_INCOMING

PARAM_MSG_TIMESTAMP

PARAM_MSG_DATE

PARAM_MSG_TIME

PARAM_MSG_FROM_ADDR

PARAM_MSG_FROM_PORT

PARAM_MSG_TO_ADDR

PARAM_MSG_TO_PORT

PARAM_MSG_TYPE

PARAM_MSG_MSG_SUMMARY

PARAM_MSG_CALL_ID

PARAM_MSG_STATUS

PARAM_MSG_REASON

PARAM_MSG_METHOD

PARAM_MSG_CSEQ

PARAM_MSG_PROTOCOL

PARAM_MSG_REQ_URI

PARAM_MSG_FROM

PARAM_MSG_FROM_URI

PARAM_MSG_FROM_TAG

PARAM_MSG_TO

PARAM_MSG_TO_URI

PARAM_MSG_TO_TAG

PARAM_MSG_HEADERS

PARAM_MSG_CONTENT_TYPE

PARAM_MSG_CONTENT_LENGTH

PARAM_MSG_CONTENT

LEVEL_TERSE

LEVEL_FULL

LEVEL_BASIC

Method Detail

getLevel

setLevel

getFormat

createFormat

destroyFormat

getStringRep

createStringRep

destroyStringRep

isLoggingEnabled

setLoggingEnabled

isLocalLoggingEnabled

setLocalLoggingEnabled

getFileTimeSpanFactor

setFileTimeSpanFactor

getFileMinSize

setFileMinSize

getLogFilename

setLogFilename

getRotationType

setRotationType

isNumberOfFilesLimited

setNumberOfFilesLimited

getFileCount

setFileCount

isRotateLogOnStartup

setRotateLogOnStartup

getLogFileRotationDir

setLogFileRotationDir

getRotationTime

setRotationTime

getFileTimeSpan

setFileTimeSpan

getDateFormatPattern

setDateFormatPattern