xyz.cofe.logs

Class RotateLogNaming

java.lang.Object

xyz.cofe.logs.RotateLogNaming

All Implemented Interfaces:

LogFileNaming

public class RotateLogNaming
extends Object
implements LogFileNaming

Ротация лог файлов.
Шаблон имени файла должен содержать индекс.
Пример 1: "/home/user/.app/log.${index}.log"
Пример 2: "/home/user/.app/log.${iii}.log"

Текущий/новый файл имеет индекс 0, предыдущий 1
При создании нового лога, старые лог файлы переименуются увеличивая индекс на единицу:

До создания нового
/home/user/.app/log.0.log
/home/user/.app/log.1.log
/home/user/.app/log.2.log

После создания нового
Новый файл -> /home/user/.app/log.0.log
/home/user/.app/log.0.log -> /home/user/.app/log.1.log
/home/user/.app/log.1.log -> /home/user/.app/log.2.log
/home/user/.app/log.2.log -> /home/user/.app/log.3.log

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RotateLogNaming.FileDesc
static class	RotateLogNaming.LogName
protected static class	RotateLogNaming.ResolveOverwrite
protected static class	RotateLogNaming.ResolveRenameFailed
static interface	RotateLogNaming.SearchPatternBuilder Создание шаблона поиска по шаблону

Constructor Summary

Constructors

Constructor and Description
RotateLogNaming()
RotateLogNaming(RotateLogNaming src)
RotateLogNaming(String filePathTemplate) Конструктор
RotateLogNaming(String filePathTemplate, xyz.cofe.fs.File searchDir, RotateLogNaming.LogName nameContext)

Method Summary

Modifier and Type	Method and Description
RotateLogNaming	clone()
xyz.cofe.fs.File	createNewLogFile() Создает новый файл лога
protected void	delete(xyz.cofe.fs.File src)
protected String	generateFileName(RotateLogNaming.LogName name)
xyz.cofe.text.template.BasicTemplate	getBasicTemplate()
RotateLogNaming.LogName	getLogName()
protected RotateLogNaming.LogName	getLogNameByIndex(int idx) Создает имя файла лога
xyz.cofe.text.template.BasicTemplate.Context<RotateLogNaming.LogName>	getNameTemplate()
xyz.cofe.fs.File	getSearchDir()
SearchPattern	getSearchPattern()
RotateLogNaming.SearchPatternBuilder	getSearchPatternBuilder()
String	getTemplate()
boolean	isReverseLogFiles()
protected Iterable<xyz.cofe.fs.File>	listNotFilteredFiles()
protected void	move(xyz.cofe.fs.File src, xyz.cofe.fs.File dest)
protected RotateLogNaming.ResolveOverwrite	resolveOverwrite(xyz.cofe.fs.File targetFile)
protected RotateLogNaming.ResolveRenameFailed	resolveRenameFailed(xyz.cofe.fs.File src, xyz.cofe.fs.File dest)
protected boolean	rotateLogs() Переименовывает файлы логов, увеличивая их номер: log2 -> log3, log1 -> log2, log0 -> log1
List<RotateLogNaming.FileDesc>	searchFileDesc()
Iterable<xyz.cofe.fs.File>	searchLogDirectories() Поиск лог каталогов
Iterable<xyz.cofe.fs.File>	searchLogFiles() Поиск лог файлов
void	setLogName(RotateLogNaming.LogName logName)
void	setReverseLogFiles(boolean reverseLogFiles)
void	setSearchPatternBuilder(RotateLogNaming.SearchPatternBuilder searchPatternBuilder)
void	setTemplate(String template)
protected void	touch(xyz.cofe.fs.File file)

Methods inherited from class java.lang.Object

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

Constructor Detail

RotateLogNaming

public RotateLogNaming(String filePathTemplate)

Конструктор

Parameters:

filePathTemplate - шаблон где будет распологатся лог файл
Перменные шаблона:
index - индекс шаблона: 123;
i - индекс шаблона: 1;
ii - индекс шаблона: 01;
iii - индекс шаблона: 002;
iiii - индекс шаблона: 0003;
iiiii - индекс шаблона: 00004;
iiiiii - индекс шаблона: 00005;
Пример

 new RotateLogNaming(
   "/home/user/.app/logfile.${index}.log"
 );
 

RotateLogNaming

public RotateLogNaming(String filePathTemplate,
                       xyz.cofe.fs.File searchDir,
                       RotateLogNaming.LogName nameContext)

RotateLogNaming

public RotateLogNaming()

RotateLogNaming

public RotateLogNaming(RotateLogNaming src)

Method Detail

clone

public RotateLogNaming clone()

Overrides:

clone in class Object

getLogName

public RotateLogNaming.LogName getLogName()

setLogName

public void setLogName(RotateLogNaming.LogName logName)

getLogNameByIndex

protected RotateLogNaming.LogName getLogNameByIndex(int idx)

Создает имя файла лога

Parameters:

idx - индекс лога

Returns:

имя

getTemplate

public String getTemplate()

setTemplate

public void setTemplate(String template)

getBasicTemplate

public xyz.cofe.text.template.BasicTemplate getBasicTemplate()

getNameTemplate

public xyz.cofe.text.template.BasicTemplate.Context<RotateLogNaming.LogName> getNameTemplate()

getSearchPatternBuilder

public RotateLogNaming.SearchPatternBuilder getSearchPatternBuilder()

setSearchPatternBuilder

public void setSearchPatternBuilder(RotateLogNaming.SearchPatternBuilder searchPatternBuilder)

getSearchPattern

public SearchPattern getSearchPattern()

getSearchDir

public xyz.cofe.fs.File getSearchDir()

searchLogDirectories

public Iterable<xyz.cofe.fs.File> searchLogDirectories()

Description copied from interface: LogFileNaming

Поиск лог каталогов

Specified by:

searchLogDirectories in interface LogFileNaming

Returns:

лог каталоги

listNotFilteredFiles

protected Iterable<xyz.cofe.fs.File> listNotFilteredFiles()

searchFileDesc

public List<RotateLogNaming.FileDesc> searchFileDesc()

isReverseLogFiles

public boolean isReverseLogFiles()

setReverseLogFiles

public void setReverseLogFiles(boolean reverseLogFiles)

searchLogFiles

public Iterable<xyz.cofe.fs.File> searchLogFiles()

Description copied from interface: LogFileNaming

Поиск лог файлов

Specified by:

searchLogFiles in interface LogFileNaming

Returns:

лог файлы

rotateLogs

protected boolean rotateLogs()

Переименовывает файлы логов, увеличивая их номер: log2 -> log3, log1 -> log2, log0 -> log1

Returns:

true - успешно / false - есть ошибки

resolveRenameFailed

protected RotateLogNaming.ResolveRenameFailed resolveRenameFailed(xyz.cofe.fs.File src,
                                                                  xyz.cofe.fs.File dest)

move

protected void move(xyz.cofe.fs.File src,
                    xyz.cofe.fs.File dest)

delete

protected void delete(xyz.cofe.fs.File src)

generateFileName

protected String generateFileName(RotateLogNaming.LogName name)

resolveOverwrite

protected RotateLogNaming.ResolveOverwrite resolveOverwrite(xyz.cofe.fs.File targetFile)

createNewLogFile

public xyz.cofe.fs.File createNewLogFile()

Создает новый файл лога

Specified by:

createNewLogFile in interface LogFileNaming

Returns:

Файл

touch

protected void touch(xyz.cofe.fs.File file)
              throws IOException

Throws:

IOException