Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration.log
Enum ExpirationConfig.ExpirationStrategy

java.lang.Object
  extended by java.lang.Enum<ExpirationConfig.ExpirationStrategy>
      extended by com.genesyslab.platform.apptemplate.configuration.log.ExpirationConfig.ExpirationStrategy
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ExpirationConfig.ExpirationStrategy>
Enclosing class:
ExpirationConfig

public static enum ExpirationConfig.ExpirationStrategy
extends java.lang.Enum<ExpirationConfig.ExpirationStrategy>

Describes the possible type of log file expiration strategy.


Enum Constant Summary
NUMBER_OF_FILES
          The expiration is based on the number of files with the same log name in the folder.
OFF
          The expiration is turned off.
TIME_BASED
          The expiration is based on the file age.
 
Method Summary
static ExpirationConfig.ExpirationStrategy valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ExpirationConfig.ExpirationStrategy[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

OFF

public static final ExpirationConfig.ExpirationStrategy OFF
The expiration is turned off. No limit either for log file number or for log file age is set. The ExpirationConfig.getExpire() property is ignored.


NUMBER_OF_FILES

public static final ExpirationConfig.ExpirationStrategy NUMBER_OF_FILES
The expiration is based on the number of files with the same log name in the folder. I.e. the number of files with pattern "<logfilename>.*.log" is counted.
If the number of such files exceeds the value, set via ExpirationConfig.getExpire(), the oldest files will be deleted. The number of deleted file is equal to 'currentFilesNumber - maxAllowedFilesNumber'.


TIME_BASED

public static final ExpirationConfig.ExpirationStrategy TIME_BASED
The expiration is based on the file age. I.e. among all files with pattern 'logfilename'.*.log the inactive files which are older than ExpirationConfig.getExpire() days are deleted.

Method Detail

values

public static ExpirationConfig.ExpirationStrategy[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ExpirationConfig.ExpirationStrategy c : ExpirationConfig.ExpirationStrategy.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExpirationConfig.ExpirationStrategy valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.