org.opennms.netmgt.flows.rest

Interface FlowRestService

All Known Implementing Classes:

FlowRestServiceImpl

public interface FlowRestService

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LIMIT
static String	DEFAULT_STEP_MS
static String	DEFAULT_TOP_N

Method Summary

Modifier and Type	Method and Description
Long	getFlowCount(javax.ws.rs.core.UriInfo uriInfo) Retrieves the number of flows persisted in the repository.
FlowNodeDetails	getFlowExporter(String nodeCriteria, int limit, javax.ws.rs.core.UriInfo uriInfo) Retrieved detailed information about a specific node.
List<FlowNodeSummary>	getFlowExporters(int limit, javax.ws.rs.core.UriInfo uriInfo) Retrieves a summary of the nodes that have exported flows.
FlowGraphUrlInfo	getFlowGraphUrlInfo(javax.ws.rs.core.UriInfo uriInfo)
FlowSummaryResponse	getTopNApplications(int N, boolean includeOther, javax.ws.rs.core.UriInfo uriInfo)
FlowSeriesResponse	getTopNApplicationSeries(long step, int N, boolean includeOther, javax.ws.rs.core.UriInfo uriInfo)
FlowSummaryResponse	getTopNConversations(int N, javax.ws.rs.core.UriInfo uriInfo)
FlowSeriesResponse	getTopNConversationsSeries(long step, int N, javax.ws.rs.core.UriInfo uriInfo)

Field Detail

DEFAULT_STEP_MS

static final String DEFAULT_STEP_MS

See Also:

Constant Field Values

DEFAULT_TOP_N

static final String DEFAULT_TOP_N

See Also:

Constant Field Values

DEFAULT_LIMIT

static final String DEFAULT_LIMIT

See Also:

Constant Field Values

Method Detail

getFlowCount

Long getFlowCount(@Context
                  javax.ws.rs.core.UriInfo uriInfo)

Retrieves the number of flows persisted in the repository. Supports filtering.

Parameters:

uriInfo - JAX-RS context

Returns:

number of flows that match the given query

getFlowExporters

List<FlowNodeSummary> getFlowExporters(int limit,
                                       @Context
                                       javax.ws.rs.core.UriInfo uriInfo)

Retrieves a summary of the nodes that have exported flows. Supports filtering.

Parameters:

limit - maximum number of exporters to return (those with the most flows will be returned in case the results are truncated)

uriInfo - JAX-RS context

Returns:

node summaries

getFlowExporter

FlowNodeDetails getFlowExporter(String nodeCriteria,
                                int limit,
                                @Context
                                javax.ws.rs.core.UriInfo uriInfo)

Retrieved detailed information about a specific node. Supports filtering.

Parameters:

nodeCriteria - node id or fs:fid

limit - maximum number of interfaces to return (those with the most flows will be returned in case the results are truncated)

uriInfo - JAX-RS context

Returns:

node details

getTopNApplications

FlowSummaryResponse getTopNApplications(int N,
                                        boolean includeOther,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo)

getTopNApplicationSeries

FlowSeriesResponse getTopNApplicationSeries(long step,
                                            int N,
                                            boolean includeOther,
                                            @Context
                                            javax.ws.rs.core.UriInfo uriInfo)

getTopNConversations

FlowSummaryResponse getTopNConversations(int N,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo)

getTopNConversationsSeries

FlowSeriesResponse getTopNConversationsSeries(long step,
                                              int N,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo)

getFlowGraphUrlInfo

FlowGraphUrlInfo getFlowGraphUrlInfo(@Context
                                     javax.ws.rs.core.UriInfo uriInfo)