Package com.sun.identity.shared.debug.file.impl

Class DebugConfigurationFromProperties

java.lang.Object

com.sun.identity.shared.debug.file.impl.DebugConfigurationFromProperties

All Implemented Interfaces:

DebugConfiguration

public class DebugConfigurationFromProperties
extends Object
implements DebugConfiguration

Read debug configuration from a properties file.

Constructor Summary

Constructors

Constructor	Description
DebugConfigurationFromProperties(String debugFilePropertiesPath)	initialize the properties It will reset the current properties for every Debug instance

Method Summary

Modifier and Type	Method	Description
String	getDebugPrefix()	Get the debug prefix configuration
String	getDebugSuffix()	Get the debug suffix configuration Suffix is an empty string or contains a date format if the rotation interval is enable (rotation interval > 0)
long	getRotationFileSizeInByte()	get size rotation in byte
int	getRotationInterval()	get rotation interval in minute Rotation interval can't be <= 0
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DebugConfigurationFromProperties

public DebugConfigurationFromProperties(String debugFilePropertiesPath)
                                 throws InvalidDebugConfigurationException

initialize the properties It will reset the current properties for every Debug instance

Parameters:

debugFilePropertiesPath - path to the debug configuration file

Throws:

InvalidDebugConfigurationException - if the file can't be found, can't be read or isn't valid

Method Detail

getDebugPrefix

public String getDebugPrefix()

Description copied from interface: DebugConfiguration

Get the debug prefix configuration

Specified by:

getDebugPrefix in interface DebugConfiguration

Returns:

prefix, never null; an empty string if no prefix is configured

getDebugSuffix

public String getDebugSuffix()

Description copied from interface: DebugConfiguration

Get the debug suffix configuration Suffix is an empty string or contains a date format if the rotation interval is enable (rotation interval > 0)

Specified by:

getDebugSuffix in interface DebugConfiguration

Returns:

suffix, never null; an empty string if no suffix is configured

getRotationInterval

public int getRotationInterval()

Description copied from interface: DebugConfiguration

get rotation interval in minute Rotation interval can't be <= 0

Specified by:

getRotationInterval in interface DebugConfiguration

Returns:

the number of minutes before rotating a file. If <= 0, the rotation is disable.

getRotationFileSizeInByte

public long getRotationFileSizeInByte()

Description copied from interface: DebugConfiguration

get size rotation in byte

Specified by:

getRotationFileSizeInByte in interface DebugConfiguration

Returns:

the maximum file size in byte. If <= 0, the rotation is disable.

toString

public String toString()

Overrides:

toString in class Object