org.rvpf.service.metadata.app

Class MetadataServiceAppImpl

Object

ServiceAppImpl

MetadataServiceAppImpl

All Implemented Interfaces:

ServiceApp, MetadataServiceApp

Direct Known Subclasses:

ClockServiceAppImpl, HTTPServerAppImpl, ProcessorServiceAppImpl, StoreServiceAppImpl

public abstract class MetadataServiceAppImpl
extends ServiceAppImpl
implements MetadataServiceApp

Metadata service application implementation.

This abstract class supplies a minimal implementation for the metadata service application interface. It also supplies help methods (protected) to its subclasses.

Field Summary

Fields inherited from class ServiceAppImpl

SERVICE_APP_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
MetadataServiceAppImpl()

Method Summary

Modifier and Type	Method and Description
Optional<String>	getEntityName() Gets the entity name.
Metadata	getMetadata() Gets the metadata.
MetadataService	getService() Gets the service holding this application.
protected boolean	loadMetadata(MetadataFilter metadataFilter) Loads the metadata as specified in a filter.
boolean	onNewMetadata(Metadata metadata) Called on new metadata.
boolean	setUp(MetadataService service) Sets up the application.
boolean	setUp(Service service) Deprecated. To generate a compile time warning.

Methods inherited from class ServiceAppImpl

createStats, fail, getConfig, getConfigProperties, getDataDir, getJoinTimeout, getProperties, getSourceUUID, getThisLogger, getTimer, onAlert, onEvent, onServiceNotAvailableException, onServicesNotReady, onServicesReady, onSignal, start, stop, tearDown

Methods inherited from class Object

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

Methods inherited from interface ServiceApp

createStats, onAlert, onEvent, onServicesNotReady, onServicesReady, onSignal, start, stop, tearDown

Constructor Detail

MetadataServiceAppImpl

public MetadataServiceAppImpl()

Method Detail

getEntityName

public Optional<String> getEntityName()

Gets the entity name.

Specified by:

getEntityName in interface MetadataServiceApp

Returns:

The optional entity name.

getMetadata

@Nonnull
 @CheckReturnValue
public Metadata getMetadata()

Gets the metadata.

Called as needed.

Returns:

The metadata.

getService

public MetadataService getService()

Gets the service holding this application.

Overrides:

getService in class ServiceAppImpl

Returns:

The service.

onNewMetadata

public boolean onNewMetadata(Metadata metadata)

Called on new metadata.

Overidden as needed.

Called by the framework and by overriding classes at the end of the override.

Specified by:

onNewMetadata in interface MetadataServiceApp

Parameters:

metadata - The new metadata.

Returns:

False to reject the metadata.

setUp

public boolean setUp(MetadataService service)

Sets up the application.

Overidden as needed.

Called by the framework and by overriding classes at the beginning of the override.

Specified by:

setUp in interface MetadataServiceApp

Parameters:

service - The service holding this application.

Returns:

True on success.

setUp

@Deprecated
public boolean setUp(Service service)

Deprecated. To generate a compile time warning.

Sets up the application.

Overidden as needed.

Called by the framework and by overriding classes at the beginning of the override.

Overriden to prevent call by subclasses: setUp(MetadataService) should be called instead.

Specified by:

setUp in interface ServiceApp

Overrides:

setUp in class ServiceAppImpl

Parameters:

service - The service holding this application.

Returns:

True on success.

loadMetadata

@CheckReturnValue
protected boolean loadMetadata(@Nonnull
                                                  MetadataFilter metadataFilter)

Loads the metadata as specified in a filter.

Parameters:

metadataFilter - The metadata filter.

Returns:

True on success.