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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BULLETINS_FOR_CONTROLLER
static int	MAX_BULLETINS_PER_COMPONENT

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.
List<Bulletin>	findBulletinsForSource(String sourceId) Finds all bulletins for the specified source component.
List<Bulletin>	findBulletinsForSource(String sourceId, String groupId) Finds all bulletins for the specified source component that resides in the given group.
int	getComponentBulletinCapacity()
int	getControllerBulletinCapacity()
long	getMaxBulletinId()

Field Detail

MAX_BULLETINS_PER_COMPONENT

static final int MAX_BULLETINS_PER_COMPONENT

See Also:

Constant Field Values

MAX_BULLETINS_FOR_CONTROLLER

static final int MAX_BULLETINS_FOR_CONTROLLER

See Also:

Constant Field Values

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

findBulletinsForSource

List<Bulletin> findBulletinsForSource(String sourceId)

Finds all bulletins for the specified source component.

Parameters:

sourceId - id of the source

Returns:

bulletins for the given source

findBulletinsForSource

List<Bulletin> findBulletinsForSource(String sourceId,
                                      String groupId)

Finds all bulletins for the specified source component that resides in the given group. While the findBulletinsForSource(String) method may be used, this method is preferred when the ID of the group is known, as this is far more efficient.

Parameters:

sourceId - the id of the source component

groupId - the id of the process group

Returns:

bulletins for the given source

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

getMaxBulletinId

long getMaxBulletinId()

Returns:

the max ID of any bulletin that has been added, or -1 if no bulletins have been added