LogMessageFile

java.lang.Object
- org.vishia.msgDispatch.LogMessageBase
- - org.vishia.msgDispatch.LogMessageFile

All Implemented Interfaces:

java.lang.Appendable, LogMessage
```
public class LogMessageFile
extends LogMessageBase
```
This class is a LogMessage output which writes the messages into a file.
Capability:
- The file will be flushed or closed after a given time. Therefore it is possible to read the file with another tool.
- It is possible to define a name with a timestamp part. Then new files will be created with a timestamp in the name
- etc. todo

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class LogMessageFile.Dbg
Helper class for some debug informations.

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`LogMessageFile.Dbg` Helper class for some debug informations.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) boolean`	`bNewFile`
`(package private) char[]`	`charsFormatTimestampFilename`
`(package private) int`	`cntAllNonFlushedWrite` Counts all non flushed writes (seconds without flush).
`(package private) int`	`cntNonFlushedWrite` Counts all non flushed writes in a flush period.
`(package private) int`	`counterMultifile` Actual counter of multiFile.
`(package private) int`	`currentLengthMultifileNr`
`private java.text.SimpleDateFormat`	`dateFormat` The date format is fix.
`(package private) LogMessageFile.Dbg`	`dbg`
`(package private) FileAppend`	`file`
`(package private) java.text.FieldPosition`	`formatField`
`(package private) java.text.SimpleDateFormat`	`formatTimestamp`
`(package private) ConcurrentLinkedQueue<MsgDispatcherCore.Entry>`	`freeEntries` Common pool of entries to save messages.
`static int`	`kMsgClose`
`static int`	`kMsgNewFile`
`static int`	`kMsgOpen`
`static int`	`kMsgOpenError`
`private java.util.Locale`	`localization`
`(package private) int`	`maxCntNonFlushedWrite` Little statistic: max nr of writes without flush.
`(package private) int`	`msgIdentOpenClose` Number for open and close message.
`(package private) LogMessage`	`msgOpenClose` An open or close operation may be logged.
`(package private) int`	`nrofHoursPerFile` -1 than close never automaticly.
`(package private) int`	`nrofSecondsToClose`
`(package private) int`	`nrofSecondsToFlush`
`(package private) ConcurrentLinkedQueue<MsgDispatcherCore.Entry>`	`parkedOrders` List of messages to process if the file is able to open.
`(package private) int`	`posMultifileInFilename` If it is -1, no multiFile designation is used.
`(package private) int`	`posTimestampInFilename`
`private java.lang.StringBuilder`	`sBuffer` Buffer for the current line to assign.
`(package private) java.lang.StringBuffer`	`sDateformatBuffer` StringBuilder to store the converted timeStamp for file time.
`(package private) java.lang.StringBuilder`	`sFilenameBuffer`
`(package private) java.lang.String`	`sFormatTimestampFilename` TODO
`(package private) boolean`	`shouldFlushed`
`(package private) OS_TimeStamp`	`timeClose` The last close time.
`(package private) OS_TimeStamp`	`timeOpen` All OS:TimeStamp are simple embedded instances in C, but derived instances from java.util.Data in java.
`(package private) OS_TimeStamp`	`timeWrite`
`private java.util.TimeZone`	`timeZone`
`static int`	`version` Version, history and license.

Fields inherited from class org.vishia.msgDispatch.LogMessageBase
nLogLevel

Fields inherited from interface org.vishia.msgDispatch.LogMessage
debug, error, fineDebug, fineInfo, info, minSecondsFormat, mNeverOutputToDisplay, mReportLevel, sVersion, warning

Constructor Summary

Constructors
Constructor and Description
`LogMessageFile(java.lang.String sFilename, int nrofSecondsToFlush, int nrofHoursPerFile, java.util.Locale localization, java.util.TimeZone timeZoneP, ConcurrentLinkedQueue<MsgDispatcherCore.Entry> freeEntriesP)` Constructs the instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Appendable`	`append(char c)`
`java.lang.Appendable`	`append(java.lang.CharSequence csq)`
`java.lang.Appendable`	`append(java.lang.CharSequence csq, int start, int end)`
`void`	`close()` Closes the file and forces usage of a new file on next open.
`void`	`flush()` This method can be called after a cyclic time less than the nrofSecondsToFlush, but in the same thread like writing.
`boolean`	`isOnline()` Checks whether the message output is available.
`boolean`	`sendMsg(int identNumber, java.lang.CharSequence text, java.lang.Object... args)` Sends a message.
`boolean`	`sendMsgTime(int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence text, java.lang.Object... args)` Sends a message.
`boolean`	`sendMsgVaList(int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence text, Va_list args)` Sends a message.
`void`	`setLogMessageOpenClose(LogMessage msg, int msgIdentOpenClose)` Sets a log output if a open or close action is done.
`(package private) void`	`writeInFile(int identNumber, OS_TimeStamp creationTime, java.lang.CharSequence text, Va_list args)` Tests

Methods inherited from class org.vishia.msgDispatch.LogMessageBase
flushReport, getReportLevel, getReportLevelFromIdent, report, report, reportln, reportln, setReportLevel, setReportLevelToIdent, writeError, writeError, writeInfo, writeInfoln, writeWarning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.vishia.msgDispatch.LogMessage
msgSec, timeCurr, timeMsg

- Field Detail
  - version
```
public static final int version
```
    Version, history and license.
    - 2014-12-19 Hartmut chg: moved from srcJava_vishiaRun to this component srcJava_vishiaBase because it is a base concept which does not use any specials with communication etc. Creating a new archive.
    - 2013-03-24 Hartmut check size
    - 2013-03-24 Hartmut bugfix: If a message text contains '%' formatting character but the variable arguments are empty, it should not call format(). In this case the text should keep its '%' characters.
    - 2012-04-05 Hartmut chg: If only a simple file name is given, it is closed and re-opened with append. This is proper if the logging file is written only on demand and it is removed or copied manually.
    - 2009-09-27: Hartmut ctor, param nrofSecondsToFlush: if ==0, than it doesn't close, but flush any time on write.
    - 2008..2009: Hartmut: some changes
    - 2008 Hartmut created
    Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
    1. You can use this source without any restriction for any desired purpose.
    2. You can redistribute copies of this source to everybody.
    3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
    4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
    5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
    If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    
    Constant Field Values
  - sFilenameBuffer
```
final java.lang.StringBuilder sFilenameBuffer
```
  - sDateformatBuffer
```
final java.lang.StringBuffer sDateformatBuffer
```
    StringBuilder to store the converted timeStamp for file time. Note: Need a StringBuffer instead StringBuilder because SimpleDateFormat.format(java.util.Date, StringBuffer, FieldPosition)
  - sFormatTimestampFilename
```
java.lang.String sFormatTimestampFilename
```
    TODO
  - formatTimestamp
```
final java.text.SimpleDateFormat formatTimestamp
```
  - counterMultifile
```
int counterMultifile
```
    Actual counter of multiFile. It is set to 1 before first open, if an asterisk is used in filename.
  - formatField
```
final java.text.FieldPosition formatField
```
  - charsFormatTimestampFilename
```
final char[] charsFormatTimestampFilename
```
  - posTimestampInFilename
```
int posTimestampInFilename
```
  - posMultifileInFilename
```
int posMultifileInFilename
```
    If it is -1, no multiFile designation is used.
  - currentLengthMultifileNr
```
int currentLengthMultifileNr
```
  - file
```
final FileAppend file
```
  - timeOpen
```
final OS_TimeStamp timeOpen
```
    All OS:TimeStamp are simple embedded instances in C, but derived instances from java.util.Data in java.
  - bNewFile
```
boolean bNewFile
```
  - timeWrite
```
final OS_TimeStamp timeWrite
```
  - timeClose
```
final OS_TimeStamp timeClose
```
    The last close time.
  - nrofSecondsToFlush
```
final int nrofSecondsToFlush
```
  - nrofSecondsToClose
```
final int nrofSecondsToClose
```
  - cntAllNonFlushedWrite
```
int cntAllNonFlushedWrite
```
    Counts all non flushed writes (seconds without flush).
  - cntNonFlushedWrite
```
int cntNonFlushedWrite
```
    Counts all non flushed writes in a flush period.
  - maxCntNonFlushedWrite
```
int maxCntNonFlushedWrite
```
    Little statistic: max nr of writes without flush.
  - shouldFlushed
```
boolean shouldFlushed
```
  - msgOpenClose
```
LogMessage msgOpenClose
```
    An open or close operation may be logged. See setLogMessageOpenClose().
  - msgIdentOpenClose
```
int msgIdentOpenClose
```
    Number for open and close message. The close messages have offsets see kMsg....
  - kMsgOpen
```
public static final int kMsgOpen
```
    See Also:
    
    Constant Field Values
  - kMsgNewFile
```
public static final int kMsgNewFile
```
    See Also:
    
    Constant Field Values
  - kMsgOpenError
```
public static final int kMsgOpenError
```
    See Also:
    
    Constant Field Values
  - kMsgClose
```
public static final int kMsgClose
```
    See Also:
    
    Constant Field Values
  - nrofHoursPerFile
```
int nrofHoursPerFile
```
    -1 than close never automaticly.
  - dbg
```
final LogMessageFile.Dbg dbg
```
  - parkedOrders
```
final ConcurrentLinkedQueue<MsgDispatcherCore.Entry> parkedOrders
```
    List of messages to process if the file is able to open.
  - freeEntries
```
final ConcurrentLinkedQueue<MsgDispatcherCore.Entry> freeEntries
```
    Common pool of entries to save messages.
  - dateFormat
```
private final java.text.SimpleDateFormat dateFormat
```
    The date format is fix. Use ' no . to separate milliseconds, because elsewhere MS-Excel shows it badly.
  - localization
```
private final java.util.Locale localization
```
  - timeZone
```
private final java.util.TimeZone timeZone
```
  - sBuffer
```
private final java.lang.StringBuilder sBuffer
```
    Buffer for the current line to assign. Don't use dynamic memory!
- Constructor Detail
  - LogMessageFile
```
public LogMessageFile(java.lang.String sFilename,
                      int nrofSecondsToFlush,
                      int nrofHoursPerFile,
                      java.util.Locale localization,
                      java.util.TimeZone timeZoneP,
                      ConcurrentLinkedQueue<MsgDispatcherCore.Entry> freeEntriesP)
```
    Constructs the instance.
    
    Parameters:
    
    sFilename - path and name.
    If the name contains $..$, the string between $..$ is the date format in the filename. Example "path/name_$MMM-ddhh_mm$.log" produces a filename at ex. "path/name_Jan27-1233.log".
    If the filename contains an asterisk '*', than at this position a number is counted for every new file (multiFile-case), but the time stamp is not changed. The time stamp is the start time of the application respectively the first using of the log after start.
    
    nrofSecondsToFlush - If negative, than the file will closed after this time of opend file. The file will be in closing state at least this time.
    If positive, than a flush will be called after this time from first not flushed write.
    
    nrofHoursPerFile - 1... the time in hours, after which a new file is created. 0: A new file isn't created. -1.. the time in seconds, after which a new file is created (only to use for test).
    
    freeEntriesP - A pool of free entries, managed by a ConcurrentLinkedQueue.
- Method Detail
  - setLogMessageOpenClose
```
public void setLogMessageOpenClose(LogMessage msg,
                                   int msgIdentOpenClose)
```
    Sets a log output if a open or close action is done. This is useful especially in test situations.
    
    Parameters:
    
    msg - The message output may be the message dispatcher, and the message may be sent to this instance itself, it is no problem.
    
    msgIdentOpenClose - The msg ident number for the open message. The close message is +1.
  - sendMsg
```
public boolean sendMsg(int identNumber,
                       java.lang.CharSequence text,
                       java.lang.Object... args)
```
    Sends a message. See interface.
    
    Parameters:
    
    identNumber -
    
    text - The text representation of the message, format string, see java.lang.String.format(..).
    
    args - see interface
    
    Returns:
    
    true if the message will be dispatched, false if it is suppressed
  - sendMsgTime
```
public final boolean sendMsgTime(int identNumber,
                                 OS_TimeStamp creationTime,
                                 java.lang.CharSequence text,
                                 java.lang.Object... args)
```
    Sends a message. See interface.
    
    Parameters:
    
    identNumber -
    
    creationTime -
    
    text - The text representation of the message, format string, see java.lang.String.format(..).
    
    args - see interface
    
    Returns:
    
    true if the message will be dispatched, false if it is suppressed
  - sendMsgVaList
```
public boolean sendMsgVaList(int identNumber,
                             OS_TimeStamp creationTime,
                             java.lang.CharSequence text,
                             Va_list args)
```
    Sends a message. See interface.
    
    Parameters:
    
    identNumber -
    
    creationTime -
    
    text - The text representation of the message, format string, see java.lang.String.format(..).
    
    typeArgs - Type chars, ZCBSIJFD for boolean, char, byte, short, int, long, float double.
    
    args - see interface
    
    Returns:
    
    true than okay. It is possible, that a destination for dispatching is not available yet. Than the routine returns false. That is for special outputs of message dispatcher. Normally the user shouldn't realize false here and react anywise. If a message isn't able to transport, it is not visible in the creating thread. It is possible that a message is lost anywhere in transportation way. In Generally, to secure a complex systems functionality, any timeouts, repeats and backup strategies are necessary in the supervise software above sending a single message.
  - append
```
public java.lang.Appendable append(java.lang.CharSequence csq)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - append
```
public java.lang.Appendable append(java.lang.CharSequence csq,
                                   int start,
                                   int end)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - append
```
public java.lang.Appendable append(char c)
                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - flush
```
public void flush()
```
    This method can be called after a cyclic time less than the nrofSecondsToFlush, but in the same thread like writing. The file will be flushed or closed
  - writeInFile
```
void writeInFile(int identNumber,
                 OS_TimeStamp creationTime,
                 java.lang.CharSequence text,
                 Va_list args)
```
    Tests
    
    Parameters:
    
    identNumber -
    
    creationTime -
    
    text - The text representation of the message, format string, see java.lang.String.format(..).
    
    args -
  - close
```
public void close()
```
    Closes the file and forces usage of a new file on next open.
  - isOnline
```
public boolean isOnline()
```
    Description copied from interface: LogMessage
    
    Checks whether the message output is available.

Class LogMessageFile

Nested Class Summary

Field Summary

Fields inherited from class org.vishia.msgDispatch.LogMessageBase

Fields inherited from interface org.vishia.msgDispatch.LogMessage

Constructor Summary

Method Summary

Methods inherited from class org.vishia.msgDispatch.LogMessageBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.vishia.msgDispatch.LogMessage

Field Detail

version

sFilenameBuffer

sDateformatBuffer

sFormatTimestampFilename

formatTimestamp

counterMultifile

formatField

charsFormatTimestampFilename

posTimestampInFilename

posMultifileInFilename

currentLengthMultifileNr

file

timeOpen

bNewFile

timeWrite

timeClose

nrofSecondsToFlush

nrofSecondsToClose

cntAllNonFlushedWrite

cntNonFlushedWrite

maxCntNonFlushedWrite

shouldFlushed

msgOpenClose

msgIdentOpenClose

kMsgOpen

kMsgNewFile

kMsgOpenError

kMsgClose

nrofHoursPerFile

dbg

parkedOrders

freeEntries

dateFormat

localization

timeZone

sBuffer

Constructor Detail

LogMessageFile

Method Detail

setLogMessageOpenClose

sendMsg

sendMsgTime

sendMsgVaList

append

append

append

flush

writeInFile

close

isOnline