Package org.jgrapes.io

Class FileStorage

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.io.FileStorage

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class FileStorage
extends Component

A component that reads from or writes to a file.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
FileStorage(Channel channel)	Create a new instance using the default buffer size of 8192.
FileStorage(Channel channel, int bufferSize)	Create a new instance using the given size for the read buffers.

Method Summary

Modifier and Type	Method	Description
void	onClose(Close event, Channel channel)	Handle close by closing the file associated with the channel.
void	onInput(Input<ByteBuffer> event, Channel channel)	Handle input by writing it to the file, if a channel exists.
void	onOutput(Output<ByteBuffer> event, Channel channel)	Handle Output events by writing them to the file, if a channel exists.
void	onSaveInput(SaveInput event)	Opens a file for writing using the properties of the event.
void	onSaveOutput(SaveOutput event)	Opens a file for writing using the properties of the event.
void	onStop(Stop event)	Handle stop by closing all files.
void	onStreamFile(StreamFile event)	Opens a file for reading using the properties of the event and streams its content as a sequence of Output events with the end of record flag set in the last event.
String	toString()	If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

FileStorage

public FileStorage(Channel channel,
 int bufferSize)

Create a new instance using the given size for the read buffers.

Parameters:

channel - the component’s channel. Used for sending Output events and receiving Input events

bufferSize - the size of the buffers used for reading

FileStorage

public FileStorage(Channel channel)

Create a new instance using the default buffer size of 8192.

Parameters:

channel - the component’s channel. Used for sending Output events and receiving Input events

Method Details

onStreamFile

@Handler
public void onStreamFile(StreamFile event)
                  throws InterruptedException

Opens a file for reading using the properties of the event and streams its content as a sequence of Output events with the end of record flag set in the last event.

All generated events are considered responses to this event and therefore fired using the event processor from the event’s I/O subchannel.

Parameters:

event - the event

Throws:

InterruptedException - if the execution was interrupted

onSaveInput

@Handler
public void onSaveInput(SaveInput event)
                 throws InterruptedException

Opens a file for writing using the properties of the event.

All data from subsequent Input events is written to the file. The end of record flag is ignored.

Parameters:

event - the event

Throws:

InterruptedException - if the execution was interrupted

onInput

@Handler
public void onInput(Input<ByteBuffer> event,
 Channel channel)

Handle input by writing it to the file, if a channel exists.

Parameters:

event - the event

channel - the channel

onSaveOutput

@Handler
public void onSaveOutput(SaveOutput event)
                  throws InterruptedException

Opens a file for writing using the properties of the event.

All data from subsequent Output events is written to the file. The end of record flag is ignored.

Parameters:

event - the event

Throws:

InterruptedException - if the execution was interrupted

onOutput

@Handler
public void onOutput(Output<ByteBuffer> event,
 Channel channel)

Handle Output events by writing them to the file, if a channel exists.

Parameters:

event - the event

channel - the channel

onClose

@Handler
public void onClose(Close event,
 Channel channel)
             throws InterruptedException

Handle close by closing the file associated with the channel.

Parameters:

event - the event

channel - the channel

Throws:

InterruptedException - the interrupted exception

onStop

@Handler(priority=-1000)
public void onStop(Stop event)
            throws InterruptedException

Handle stop by closing all files.

Parameters:

event - the event

Throws:

InterruptedException - the interrupted exception

toString

public String toString()

Description copied from class: ComponentVertex

If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Overrides:

toString in class ComponentVertex