Package org.opennms.netmgt.flows.rest

Interface FlowRestService

All Known Implementing Classes:

FlowRestServiceImpl

public interface FlowRestService

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
List<String>	getApplications(String matchingPrefix, long limit, javax.ws.rs.core.UriInfo uriInfo)	Retrieve the list of applications.
FlowSeriesResponse	getApplicationSeries(long step, Integer N, Set<String> applications, boolean includeOther, javax.ws.rs.core.UriInfo uriInfo)
FlowSummaryResponse	getApplicationSummary(Integer N, Set<String> applications, boolean includeOther, javax.ws.rs.core.UriInfo uriInfo)
List<String>	getConversations(String locationPattern, String protocolPattern, String lowerIPPattern, String upperIPPattern, String applicationPattern, long limit, javax.ws.rs.core.UriInfo uriInfo)	Retrieve the list of conversations.
FlowSeriesResponse	getConversationSeries(long step, Integer N, Set<String> conversations, boolean includeOther, javax.ws.rs.core.UriInfo uriInfo)
FlowSummaryResponse	getConversationSummary(Integer N, Set<String> conversations, boolean includeOther, javax.ws.rs.core.UriInfo uriInfo)
FlowSeriesResponse	getDscpSeries(long step, javax.ws.rs.core.UriInfo uriInfo)
FlowSummaryResponse	getDscpSummaries(javax.ws.rs.core.UriInfo uriInfo)
List<Integer>	getDscpValues(javax.ws.rs.core.UriInfo uriInfo)
Long	getFlowCount(javax.ws.rs.core.UriInfo uriInfo)	Retrieves the number of flows persisted in the repository.
FlowNodeDetails	getFlowExporter(Integer nodeId)	Retrieved detailed information about a specific node.
List<FlowNodeSummary>	getFlowExporters()	Retrieves a summary of the nodes that have exported flows.
FlowGraphUrlInfo	getFlowGraphUrlInfo(javax.ws.rs.core.UriInfo uriInfo)
List<String>	getHosts(String regex, long limit, javax.ws.rs.core.UriInfo uriInfo)	Retrieve the list of hosts.
FlowSeriesResponse	getHostSeries(long step, Integer N, Set<String> hosts, boolean includeOther, javax.ws.rs.core.UriInfo uriInfo)
FlowSummaryResponse	getHostSummary(Integer N, Set<String> hosts, boolean includeOther, 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()

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

Returns:

node summaries

getFlowExporter

FlowNodeDetails getFlowExporter(Integer nodeId)

Retrieved detailed information about a specific node. Supports filtering.

Parameters:

nodeId - node id

Returns:

node details

getDscpValues

List<Integer> getDscpValues(@Context
                            javax.ws.rs.core.UriInfo uriInfo)

getDscpSummaries

FlowSummaryResponse getDscpSummaries(@Context
                                     javax.ws.rs.core.UriInfo uriInfo)

getDscpSeries

FlowSeriesResponse getDscpSeries(long step,
                                 @Context
                                 javax.ws.rs.core.UriInfo uriInfo)

getApplications

List<String> getApplications(String matchingPrefix,
                             long limit,
                             @Context
                             javax.ws.rs.core.UriInfo uriInfo)

Retrieve the list of applications. Supports filtering.

Parameters:

matchingPrefix - a string prefix that can be used to further filter the results

limit - the maximum number of applications to return

Returns:

the list of applications

getApplicationSummary

FlowSummaryResponse getApplicationSummary(Integer N,
                                          Set<String> applications,
                                          boolean includeOther,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)

getApplicationSeries

FlowSeriesResponse getApplicationSeries(long step,
                                        Integer N,
                                        Set<String> applications,
                                        boolean includeOther,
                                        @Context
                                        javax.ws.rs.core.UriInfo uriInfo)

getHosts

List<String> getHosts(String regex,
                      long limit,
                      @Context
                      javax.ws.rs.core.UriInfo uriInfo)

Retrieve the list of hosts. Supports filtering.

Parameters:

prefix - a string prefix that can be used to further filter the results

limit - the maximum number of hosts to return

Returns:

the list of hosts

getHostSummary

FlowSummaryResponse getHostSummary(Integer N,
                                   Set<String> hosts,
                                   boolean includeOther,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo)

getHostSeries

FlowSeriesResponse getHostSeries(long step,
                                 Integer N,
                                 Set<String> hosts,
                                 boolean includeOther,
                                 @Context
                                 javax.ws.rs.core.UriInfo uriInfo)

getConversations

List<String> getConversations(String locationPattern,
                              String protocolPattern,
                              String lowerIPPattern,
                              String upperIPPattern,
                              String applicationPattern,
                              long limit,
                              @Context
                              javax.ws.rs.core.UriInfo uriInfo)

Retrieve the list of conversations. Supports filtering.

Parameters:

locationPattern - the regex pattern for the location field

protocolPattern - the regex pattern for the protocol field

lowerIPPattern - the regex pattern for the lower IP field

upperIPPattern - the regex pattern for the upper IP field

applicationPattern - the regex pattern for the application field

limit - limit for how many conversations to return

Returns:

the list of conversations

getConversationSummary

FlowSummaryResponse getConversationSummary(Integer N,
                                           Set<String> conversations,
                                           boolean includeOther,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)

getConversationSeries

FlowSeriesResponse getConversationSeries(long step,
                                         Integer N,
                                         Set<String> conversations,
                                         boolean includeOther,
                                         @Context
                                         javax.ws.rs.core.UriInfo uriInfo)

getFlowGraphUrlInfo

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