org.apache.nifi.reporting

Interface BulletinRepository

public interface BulletinRepository

The BulletinRepository provides a place to store and retrieve Bulletins that have been created by the NiFi Framework and the Components that are running within the Framework.

Method Summary

Modifier and Type	Method and Description
void	addBulletin(Bulletin bulletin) Adds a Bulletin to the repository.
List<Bulletin>	findBulletins(BulletinQuery bulletinQuery) Finds Bulletin's that meet the specified query.
List<Bulletin>	findBulletinsForController()
List<Bulletin>	findBulletinsForController(int max) Finds all bulletins for the controller;
List<Bulletin>	findBulletinsForGroupBySource(String groupId) Finds all bulletins for the specified group.
List<Bulletin>	findBulletinsForGroupBySource(String groupId, int maxPerComponent) Finds all bulletins for the specified group.
int	getComponentBulletinCapacity()
int	getControllerBulletinCapacity()

Method Detail

addBulletin

void addBulletin(Bulletin bulletin)

Adds a Bulletin to the repository.

Parameters:

bulletin - to add

getControllerBulletinCapacity

int getControllerBulletinCapacity()

Returns:

the capacity for the number of bulletins for the controller

getComponentBulletinCapacity

int getComponentBulletinCapacity()

Returns:

the capacity for the number of bulletins per component

findBulletins

List<Bulletin> findBulletins(BulletinQuery bulletinQuery)

Finds Bulletin's that meet the specified query.

Parameters:

bulletinQuery - indicates which bulletins are of interest

Returns:

bulletins that met the query

findBulletinsForGroupBySource

List<Bulletin> findBulletinsForGroupBySource(String groupId)

Finds all bulletins for the specified group.

Parameters:

groupId - id of the group

Returns:

bulletins for the given group

findBulletinsForGroupBySource

List<Bulletin> findBulletinsForGroupBySource(String groupId,
                                             int maxPerComponent)

Finds all bulletins for the specified group.

Parameters:

groupId - id of the group

maxPerComponent - max responses wanted

Returns:

bulletins found

findBulletinsForController

List<Bulletin> findBulletinsForController()

Returns:

all bulletins for the controller

findBulletinsForController

List<Bulletin> findBulletinsForController(int max)

Finds all bulletins for the controller;

Parameters:

max - limits the number of responses

Returns:

all bulletins for the controller