org.apache.nifi.reporting.BulletinRepository Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.nifi.reporting;
import java.util.List;
/**
* The BulletinRepository provides a place to store and retrieve
* {@link Bulletin}s that have been created by the NiFi Framework and the
* Components that are running within the Framework.
*/
public interface BulletinRepository {
int MAX_BULLETINS_PER_COMPONENT = 5;
int MAX_BULLETINS_FOR_CONTROLLER = 10;
/**
* Adds a Bulletin to the repository.
*
* @param bulletin to add
*/
void addBulletin(Bulletin bulletin);
/**
* @return the capacity for the number of bulletins for the controller
*/
int getControllerBulletinCapacity();
/**
* @return the capacity for the number of bulletins per component
*/
int getComponentBulletinCapacity();
/**
* Finds Bulletin's that meet the specified query.
*
* @param bulletinQuery indicates which bulletins are of interest
* @return bulletins that met the query
*/
List findBulletins(BulletinQuery bulletinQuery);
/**
* Finds all bulletins for the specified source component.
*
* @param sourceId id of the source
* @return bulletins for the given source
*/
List findBulletinsForSource(String sourceId);
/**
* Finds all bulletins for the specified source component that resides in the given group. While the
* {@link #findBulletinsForSource(String)} method may be used, this method is preferred when the ID of the group
* is known, as this is far more efficient.
*
* @param sourceId the id of the source component
* @param groupId the id of the process group
* @return bulletins for the given source
*/
List findBulletinsForSource(String sourceId, String groupId);
/**
* Finds all bulletins for the specified group.
*
* @param groupId id of the group
* @return bulletins for the given group
*/
List findBulletinsForGroupBySource(String groupId);
/**
* Finds all bulletins for the specified group.
*
* @param groupId id of the group
* @param maxPerComponent max responses wanted
* @return bulletins found
*/
List findBulletinsForGroupBySource(String groupId, int maxPerComponent);
/**
* @return all bulletins for the controller
*/
List findBulletinsForController();
/**
* Finds all bulletins for the controller;
*
* @param max limits the number of responses
* @return all bulletins for the controller
*/
List findBulletinsForController(int max);
/**
* @return the max ID of any bulletin that has been added, or -1 if no bulletins have been added
*/
long getMaxBulletinId();
}