org.apache.nifi.processors.groovyx.flow

Class SessionFile

java.lang.Object

org.apache.nifi.processors.groovyx.flow.SessionFile

All Implemented Interfaces:

Comparable<FlowFile>, FlowFile

Direct Known Subclasses:

GroovySessionFile

public abstract class SessionFile
extends Object
implements FlowFile

The Flow file implementation that contains reference to the session. So all commands become easier. Example: flowFile.putAttribute("AttrName", "AttrValue");

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.nifi.flowfile.FlowFile

FlowFile.KeyValidator

Field Summary

Fields

Modifier and Type	Field and Description
(package private) FlowFile	flowFile
(package private) ProcessSessionWrap	session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionFile(ProcessSessionWrap session, FlowFile f)

Method Summary

Modifier and Type	Method and Description
SessionFile	append(OutputStreamCallback c) append flowfile content.
SessionFile	clone(boolean cloneContent) Clone flowfile with or without content.
int	compareTo(FlowFile other)
String	getAttribute(String key)
Map<String,String>	getAttributes()
long	getEntryDate()
long	getId()
Long	getLastQueueDate()
long	getLineageStartDate()
long	getLineageStartIndex()
long	getQueueDateIndex()
long	getSize()
boolean	isPenalized()
SessionFile	putAllAttributes(Map<String,String> m) Copy attributes from map into flowfile.
SessionFile	putAttribute(String key, String value) set attribute value.
InputStream	read() Returns content of the flow file as InputStream.
void	read(InputStreamCallback c) read flowfile content.
void	remove() Drops this flow file from session.
SessionFile	removeAllAttributes(Collection<String> keys) Removes attributes by list.
SessionFile	removeAttribute(String key) Removes one attribute.
ProcessSessionWrap	session() Returns original session.
String	toString()
void	transfer(Relationship r) Transfers to defined relationship or to input relationship if parameter is null.
SessionFile	write(OutputStreamCallback c) write flowfile content.
SessionFile	write(StreamCallback c) write flowfile content.

Methods inherited from class java.lang.Object

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

Field Detail

flowFile

FlowFile flowFile

session

ProcessSessionWrap session

Constructor Detail

SessionFile

protected SessionFile(ProcessSessionWrap session,
                      FlowFile f)

Method Detail

session

public ProcessSessionWrap session()

Returns original session.

clone

public SessionFile clone(boolean cloneContent)

Clone flowfile with or without content.

Parameters:

cloneContent - clone content or not. attributes cloned in any case.

Returns:

new flow file

read

public InputStream read()

Returns content of the flow file as InputStream.

read

public void read(InputStreamCallback c)

read flowfile content.

write

public SessionFile write(StreamCallback c)

write flowfile content.

Returns:

reference to self

write

public SessionFile write(OutputStreamCallback c)

write flowfile content.

Returns:

reference to self

append

public SessionFile append(OutputStreamCallback c)

append flowfile content.

Returns:

reference to self

putAttribute

public SessionFile putAttribute(String key,
                                String value)

set attribute value.

Returns:

reference to self

putAllAttributes

public SessionFile putAllAttributes(Map<String,String> m)

Copy attributes from map into flowfile.

Returns:

reference to self

removeAttribute

public SessionFile removeAttribute(String key)

Removes one attribute.

Returns:

reference to self

removeAllAttributes

public SessionFile removeAllAttributes(Collection<String> keys)

Removes attributes by list.

Returns:

reference to self

transfer

public void transfer(Relationship r)

Transfers to defined relationship or to input relationship if parameter is null.

remove

public void remove()

Drops this flow file from session.

getId

public long getId()

Specified by:

getId in interface FlowFile

getEntryDate

public long getEntryDate()

Specified by:

getEntryDate in interface FlowFile

getLineageStartDate

public long getLineageStartDate()

Specified by:

getLineageStartDate in interface FlowFile

getLineageStartIndex

public long getLineageStartIndex()

Specified by:

getLineageStartIndex in interface FlowFile

getLastQueueDate

public Long getLastQueueDate()

Specified by:

getLastQueueDate in interface FlowFile

getQueueDateIndex

public long getQueueDateIndex()

Specified by:

getQueueDateIndex in interface FlowFile

isPenalized

public boolean isPenalized()

Specified by:

isPenalized in interface FlowFile

getAttribute

public String getAttribute(String key)

Specified by:

getAttribute in interface FlowFile

getSize

public long getSize()

Specified by:

getSize in interface FlowFile

getAttributes

public Map<String,String> getAttributes()

Specified by:

getAttributes in interface FlowFile

Returns:

an unmodifiable map of the flow file attributes

compareTo

public int compareTo(FlowFile other)

Specified by:

compareTo in interface Comparable<FlowFile>

toString

public String toString()

Overrides:

toString in class Object