org.rvpf.store.server.sink

Class SinkModule.Abstract

Object

SinkModule.Abstract

All Implemented Interfaces:

SinkModule

Direct Known Subclasses:

NullSink, PipeSink, ScriptSink

Enclosing interface:

SinkModule

@NotThreadSafe
public abstract static class SinkModule.Abstract
extends Object
implements SinkModule

Abstract sink module.

Nested Class Summary

Nested classes/interfaces inherited from interface SinkModule

SinkModule.Abstract

Constructor Summary

Constructors

Constructor and Description
Abstract()

Method Summary

Modifier and Type	Method and Description
protected void	abort() Aborts.
void	close() Closes this sink.
boolean	delete(VersionedValue versionedValue) Deletes a value.
protected Metadata	getMetadata() Gets the metadata.
protected SinkServiceAppImpl	getSinkAppImpl() Gets the sink application implementation.
protected Logger	getThisLogger() Gets the logger.
void	open() Opens this Sink.
boolean	setUp(SinkServiceAppImpl sinkAppImpl) Sets up the sink for action.
void	tearDown() Tears down what has been set up.
boolean	update(VersionedValue versionedValue) Updates a value.

Methods inherited from class Object

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

Constructor Detail

Abstract

public Abstract()

Method Detail

close

public void close()

Closes this sink.

Specified by:

close in interface SinkModule

delete

public boolean delete(VersionedValue versionedValue)

Deletes a value.

Specified by:

delete in interface SinkModule

Parameters:

versionedValue - The point value to delete.

Returns:

True if notification may proceed.

open

public void open()
          throws ServiceNotReadyException

Opens this Sink.

Specified by:

open in interface SinkModule

Throws:

ServiceNotReadyException - When the service is not ready.

setUp

public boolean setUp(SinkServiceAppImpl sinkAppImpl)

Sets up the sink for action.

Specified by:

setUp in interface SinkModule

Parameters:

sinkAppImpl - The sink application implementation.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface SinkModule

update

public boolean update(VersionedValue versionedValue)

Updates a value.

Specified by:

update in interface SinkModule

Parameters:

versionedValue - The new point value.

Returns:

True if notification may proceed.

abort

protected final void abort()

Aborts.

getMetadata

protected final Metadata getMetadata()

Gets the metadata.

Returns:

The metadata.

getSinkAppImpl

protected final SinkServiceAppImpl getSinkAppImpl()

Gets the sink application implementation.

Returns:

The sink application implementation.

getThisLogger

protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.