org.apache.nifi.processors.groovyx.flow

Class GroovySessionFile

java.lang.Object

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

org.apache.nifi.processors.groovyx.flow.GroovySessionFile

All Implemented Interfaces:

groovy.lang.GroovyObject, Comparable<FlowFile>, FlowFile

public class GroovySessionFile
extends SessionFile
implements groovy.lang.GroovyObject

SessionFile with groovy specific methods.

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
private groovy.lang.MetaClass	metaClass

Fields inherited from class org.apache.nifi.processors.groovyx.flow.SessionFile

flowFile, session

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GroovySessionFile	append(groovy.lang.Closure c) Append the existing content of the flow file.
GroovySessionFile	append(String charset, CharSequence c) Append the existing content of the flow file through Writer with defined charset.
GroovySessionFile	append(String charset, groovy.lang.Closure c) Append the existing content of the flow file through Writer with defined charset.
GroovySessionFile	append(String charset, groovy.lang.Writable c) Append the existing content of the flow file through Writer with defined charset.
groovy.lang.MetaClass	getMetaClass() GroovyObject support method
Object	getProperty(String key) alias method to getAttribute that will act in groovy as a property except for `size` and `attributes`
Object	invokeMethod(String name, Object args) GroovyObject support method
void	read(groovy.lang.Closure c) Reads content of the flow file and closes input stream.
void	read(String charset, groovy.lang.Closure c) Reads content of the flow file through Reader and closes the stream.
void	setMetaClass(groovy.lang.MetaClass metaClass) GroovyObject support method
void	setProperty(String key, Object value) Calls putAttribute if value defined and removeAttribute if value is null
GroovySessionFile	withInputStream(groovy.lang.Closure c)
GroovySessionFile	withOutputStream(groovy.lang.Closure c)
GroovySessionFile	withReader(String charset, groovy.lang.Closure c)
GroovySessionFile	withWriter(String charset, groovy.lang.Closure c)
GroovySessionFile	write(groovy.lang.Closure c) Write or read+write flow file contents through streams.
GroovySessionFile	write(String charset, CharSequence c) Instantly writes into flow file contents the char sequence (string).
GroovySessionFile	write(String charset, groovy.lang.Closure c) Write flow file contents through writer with defined charset.
GroovySessionFile	write(String charset, groovy.lang.Writable c) Write flow file contents through writer with defined charset.

Methods inherited from class org.apache.nifi.processors.groovyx.flow.SessionFile

append, clone, compareTo, getAttribute, getAttributes, getEntryDate, getId, getLastQueueDate, getLineageStartDate, getLineageStartIndex, getQueueDateIndex, getSize, isPenalized, putAllAttributes, putAttribute, read, read, remove, removeAllAttributes, removeAttribute, session, toString, transfer, write, write

Methods inherited from class java.lang.Object

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

Field Detail

metaClass

private transient groovy.lang.MetaClass metaClass

Constructor Detail

GroovySessionFile

protected GroovySessionFile(ProcessSessionWrap session,
                            FlowFile f)

Method Detail

getProperty

public Object getProperty(String key)

alias method to getAttribute that will act in groovy as a property except for `size` and `attributes`

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String key,
                        Object value)

Calls putAttribute if value defined and removeAttribute if value is null

Specified by:

setProperty in interface groovy.lang.GroovyObject

getMetaClass

public groovy.lang.MetaClass getMetaClass()

GroovyObject support method

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

GroovyObject support method

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String name,
                           Object args)

GroovyObject support method

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

write

public GroovySessionFile write(String charset,
                               groovy.lang.Closure c)

Write flow file contents through writer with defined charset.

Parameters:

charset - charset to use for writer

c - Closure that will receive writer as a parameter to write file content

Returns:

reference to self

write

public GroovySessionFile write(String charset,
                               CharSequence c)

Instantly writes into flow file contents the char sequence (string).

Parameters:

charset - charset to use for writer

c - content

Returns:

reference to self

write

public GroovySessionFile write(String charset,
                               groovy.lang.Writable c)

Write flow file contents through writer with defined charset.

Parameters:

charset - charset to use for writer

c - content defined as writable

Returns:

reference to self

write

public GroovySessionFile write(groovy.lang.Closure c)

Write or read+write flow file contents through streams.

Parameters:

c - Closure that could receive one parameter OutputStream to perform write, or two parameters InputStream and OutputStream to perform read and write.

Returns:

reference to self

append

public GroovySessionFile append(groovy.lang.Closure c)

Append the existing content of the flow file.

Parameters:

c - Closure that receives one parameter OutputStream to perform append.

Returns:

reference to self

append

public GroovySessionFile append(String charset,
                                groovy.lang.Writable c)

Append the existing content of the flow file through Writer with defined charset.

Parameters:

charset - charset to use for writer

c - content to append.

Returns:

reference to self

append

public GroovySessionFile append(String charset,
                                groovy.lang.Closure c)

Append the existing content of the flow file through Writer with defined charset.

Parameters:

charset - charset to use for writer

c - Closure with one parameter - Writer.

Returns:

reference to self

append

public GroovySessionFile append(String charset,
                                CharSequence c)

Append the existing content of the flow file through Writer with defined charset.

Parameters:

charset - charset to use for writer

c - content to append.

Returns:

reference to self

read

public void read(groovy.lang.Closure c)

Reads content of the flow file and closes input stream.

Parameters:

c - Closure with one parameter InputStream.

read

public void read(String charset,
                 groovy.lang.Closure c)

Reads content of the flow file through Reader and closes the stream.

Parameters:

charset - charset to use for Reader

c - Closure with one parameter Reader.

withInputStream

public GroovySessionFile withInputStream(groovy.lang.Closure c)
                                  throws IOException

Throws:

IOException

withOutputStream

public GroovySessionFile withOutputStream(groovy.lang.Closure c)
                                   throws IOException

Throws:

IOException

withReader

public GroovySessionFile withReader(String charset,
                                    groovy.lang.Closure c)
                             throws IOException,
                                    UnsupportedCharsetException

Throws:

IOException

UnsupportedCharsetException

withWriter

public GroovySessionFile withWriter(String charset,
                                    groovy.lang.Closure c)
                             throws IOException,
                                    UnsupportedCharsetException

Throws:

IOException

UnsupportedCharsetException