Package org.apache.catalina.ha.deploy
Class FileMessageFactory
java.lang.Object
org.apache.catalina.ha.deploy.FileMessageFactory
This factory is used to read files and write files by splitting them up into smaller messages. So that entire files
 don't have to be read into memory. 
The factory can be used as a reader or writer but not both at the same time. When done reading or writing the factory will close the input or output streams and mark the factory as closed. It is not possible to use it after that.
To force a cleanup, call cleanup() from the calling object.
This class is not thread safe.
The factory can be used as a reader or writer but not both at the same time. When done reading or writing the factory will close the input or output streams and mark the factory as closed. It is not possible to use it after that.
To force a cleanup, call cleanup() from the calling object.
This class is not thread safe.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected booleanOnce the factory is used, it cannot be reused.protected longDeprecated.Unused.protected byte[]The bytes that we hold the data in, not thread safe.protected final FileThe file that we are reading/writingprotected FileInputStreamWhen openForWrite=false, the input stream is held by this variableprotected booleanFlag that indicates if a thread is writing messages to disk.protected AtomicLongThe number of the last message processed.protected longThe time this instance was last modified.protected intThe maximum time (in seconds) this instance will be allowed to exist from lastModifiedTime.protected final Map<Long,FileMessage> Messages received out of order are held in the buffer until required.protected intThe number of messages we have writtenprotected final booleanTrue means that we are writing with this factory.protected FileOutputStreamWhen openForWrite=true, the output stream is held by this variablestatic final intThe number of bytes that we read from fileprotected longThe total size of the fileprotected longThe total number of packets that we split this file into
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidcheckState(boolean openForWrite) Check to make sure the factory is able to perform the function it is asked to do.voidcleanup()Closes the factory, its streams and sets all its references to nullgetFile()static FileMessageFactorygetInstance(File f, boolean openForWrite) Creates a factory to read or write from a file.intbooleanisValid()Reads file data into the file message and sets the size, totalLength, totalNrOfMsgs and the message number
 If EOF is reached, the factory returns null, and closes itself, otherwise the same message is returned as was passed in.voidsetMaxValidTime(int maxValidTime) booleanwriteMessage(FileMessage msg) Writes a message to file.
- 
Field Details- 
READ_SIZEpublic static final int READ_SIZEThe number of bytes that we read from file- See Also:
 
- 
fileThe file that we are reading/writing
- 
openForWriteprotected final boolean openForWriteTrue means that we are writing with this factory. False means that we are reading with this factory
- 
closedprotected boolean closedOnce the factory is used, it cannot be reused.
- 
inWhen openForWrite=false, the input stream is held by this variable
- 
outWhen openForWrite=true, the output stream is held by this variable
- 
nrOfMessagesProcessedprotected int nrOfMessagesProcessedThe number of messages we have written
- 
sizeprotected long sizeThe total size of the file
- 
totalNrOfMessagesprotected long totalNrOfMessagesThe total number of packets that we split this file into
- 
lastMessageProcessedThe number of the last message processed. Message IDs are 1 based.
- 
msgBufferMessages received out of order are held in the buffer until required. If everything is worked as expected, messages will spend very little time in the buffer.
- 
dataprotected byte[] dataThe bytes that we hold the data in, not thread safe.
- 
isWritingprotected boolean isWritingFlag that indicates if a thread is writing messages to disk. Access to this flag must be synchronised.
- 
creationTimeDeprecated.Unused. This will be removed in Tomcat 11.The time this instance was created. (in milliseconds)
- 
lastModifiedprotected long lastModifiedThe time this instance was last modified.
- 
maxValidTimeprotected int maxValidTimeThe maximum time (in seconds) this instance will be allowed to exist from lastModifiedTime.
 
- 
- 
Method Details- 
getInstancepublic static FileMessageFactory getInstance(File f, boolean openForWrite) throws FileNotFoundException, IOException Creates a factory to read or write from a file. When opening for read, the readMessage can be invoked, and when opening for write the writeMessage can be invoked.- Parameters:
- f- File - the file to be read or written
- openForWrite- boolean - true, means we are writing to the file, false means we are reading from it
- Returns:
- FileMessageFactory
- Throws:
- FileNotFoundException- - if the file to be read doesn't exist
- IOException- - if it fails to create the file that is to be written
 
- 
readMessageReads file data into the file message and sets the size, totalLength, totalNrOfMsgs and the message number
 If EOF is reached, the factory returns null, and closes itself, otherwise the same message is returned as was passed in. This makes sure that not more memory is ever used. To remember, neither the file message or the factory are thread safe. Don't hand off the message to one thread and read the same with another.- Parameters:
- f- FileMessage - the message to be populated with file data
- Returns:
- FileMessage - returns the same message passed in as a parameter, or null if EOF
- Throws:
- IllegalArgumentException- - if the factory is for writing or is closed
- IOException- - if a file read exception occurs
 
- 
writeMessageWrites a message to file. If (msg.getMessageNumber() == msg.getTotalNrOfMsgs()) the output stream will be closed after writing.- Parameters:
- msg- FileMessage - message containing data to be written
- Returns:
- returns true if the file is complete and outputstream is closed, false otherwise.
- Throws:
- IllegalArgumentException- - if the factory is opened for read or closed
- IOException- - if a file write error occurs
 
- 
cleanuppublic void cleanup()Closes the factory, its streams and sets all its references to null
- 
checkStateCheck to make sure the factory is able to perform the function it is asked to do. Invoked by readMessage/writeMessage before those methods proceed.- Parameters:
- openForWrite- The value to check
- Throws:
- IllegalArgumentException- if the state is not the expected one
 
- 
getFile
- 
isValidpublic boolean isValid()
- 
getMaxValidTimepublic int getMaxValidTime()
- 
setMaxValidTimepublic void setMaxValidTime(int maxValidTime) 
 
-