io.warp10.warp.sdk

Class IngressPlugin

java.lang.Object

io.warp10.warp.sdk.IngressPlugin

public abstract class IngressPlugin
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
IngressPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	delete(java.lang.Object ingress, WriteToken token, Metadata metadata) Called for each GTS identified as a deletion candidate
void	flush(java.lang.Object ingress) Called when the processing of an update, meta or delete operation ends
void	init()
boolean	meta(java.lang.Object ingress, WriteToken token, java.lang.String line, Metadata metadata) Called when a line of the input to the /meta endpoint has been parsed
boolean	update(java.lang.Object ingress, WriteToken token, java.lang.String line, GTSEncoder encoder) Called when a line of GTS Input Format has been parsed.

Methods inherited from class java.lang.Object

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

Constructor Detail

IngressPlugin

public IngressPlugin()

Method Detail

init

public void init()

update

public boolean update(java.lang.Object ingress,
                      WriteToken token,
                      java.lang.String line,
                      GTSEncoder encoder)

Called when a line of GTS Input Format has been parsed.

Parameters:

ingress - Instance which parsed the line (either Ingress or StandaloneIngressHandler)

token - Write token used to push the data

line - Text line in GTS Input Format

encoder - Parsed encoder

Returns:

true if the encoder can be processed further, false if it should be discarded

meta

public boolean meta(java.lang.Object ingress,
                    WriteToken token,
                    java.lang.String line,
                    Metadata metadata)

Called when a line of the input to the /meta endpoint has been parsed

Parameters:

ingress - Instance which parsed the line (either Ingress or StandaloneIngressHandler)

token - Write token used to perform the metadata modification

line - Line which was parsed

metadata - Parsed Metadata

Returns:

true if the Metadata can be further processed, false if the change should be ignored

delete

public boolean delete(java.lang.Object ingress,
                      WriteToken token,
                      Metadata metadata)

Called for each GTS identified as a deletion candidate

Parameters:

ingress - Instance which processes the delete (either Ingress or StandaloneDeleteHandler)

token - Write token used for the delete

metadata - Metadata of the GTS to delete

Returns:

true if deletion of this GTS should continue, false otherwise

flush

public void flush(java.lang.Object ingress)

Called when the processing of an update, meta or delete operation ends

Parameters:

ingress - Instance