Package org.opennms.netmgt.flows.rest.internal

Class FlowRestServiceImpl

java.lang.Object

org.opennms.netmgt.flows.rest.internal.FlowRestServiceImpl

All Implemented Interfaces:

FlowRestService

public class FlowRestServiceImpl
extends java.lang.Object
implements FlowRestService

Field Summary

Fields inherited from interface org.opennms.netmgt.flows.rest.FlowRestService

DEFAULT_LIMIT, DEFAULT_STEP_MS, DEFAULT_TOP_N

Constructor Summary

Constructors

Constructor	Description
FlowRestServiceImpl(FlowQueryService flowQueryService, NodeDao nodeDao, SnmpInterfaceDao snmpInterfaceDao, SessionUtils sessionUtils)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowRestServiceImpl

public FlowRestServiceImpl(FlowQueryService flowQueryService,
                           NodeDao nodeDao,
                           SnmpInterfaceDao snmpInterfaceDao,
                           SessionUtils sessionUtils)

Method Detail

getFlowCount

public java.lang.Long getFlowCount(javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FlowRestService

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

Specified by:

getFlowCount in interface FlowRestService

Parameters:

uriInfo - JAX-RS context

Returns:

number of flows that match the given query

getFlowExporters

public java.util.List<FlowNodeSummary> getFlowExporters()

Description copied from interface: FlowRestService

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

Specified by:

getFlowExporters in interface FlowRestService

Returns:

node summaries

getFlowExporter

public FlowNodeDetails getFlowExporter(java.lang.Integer nodeId)

Description copied from interface: FlowRestService

Retrieved detailed information about a specific node. Supports filtering.

Specified by:

getFlowExporter in interface FlowRestService

Parameters:

nodeId - node id

Returns:

node details

getDscpValues

public java.util.List<java.lang.Integer> getDscpValues(javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getDscpValues in interface FlowRestService

getDscpSummaries

public FlowSummaryResponse getDscpSummaries(javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getDscpSummaries in interface FlowRestService

getDscpSeries

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

Specified by:

getDscpSeries in interface FlowRestService

getApplications

public java.util.List<java.lang.String> getApplications(java.lang.String matchingPrefix,
                                                        long limit,
                                                        javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FlowRestService

Retrieve the list of applications. Supports filtering.

Specified by:

getApplications in interface FlowRestService

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

public FlowSummaryResponse getApplicationSummary(java.lang.Integer N,
                                                 java.util.Set<java.lang.String> applications,
                                                 boolean includeOther,
                                                 javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getApplicationSummary in interface FlowRestService

getApplicationSeries

public FlowSeriesResponse getApplicationSeries(long step,
                                               java.lang.Integer N,
                                               java.util.Set<java.lang.String> applications,
                                               boolean includeOther,
                                               javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getApplicationSeries in interface FlowRestService

getHosts

public java.util.List<java.lang.String> getHosts(java.lang.String regex,
                                                 long limit,
                                                 javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FlowRestService

Retrieve the list of hosts. Supports filtering.

Specified by:

getHosts in interface FlowRestService

limit - the maximum number of hosts to return

Returns:

the list of hosts

getHostSummary

public FlowSummaryResponse getHostSummary(java.lang.Integer N,
                                          java.util.Set<java.lang.String> hosts,
                                          boolean includeOther,
                                          javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getHostSummary in interface FlowRestService

getHostSeries

public FlowSeriesResponse getHostSeries(long step,
                                        java.lang.Integer N,
                                        java.util.Set<java.lang.String> hosts,
                                        boolean includeOther,
                                        javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getHostSeries in interface FlowRestService

getConversations

public java.util.List<java.lang.String> getConversations(java.lang.String locationPattern,
                                                         java.lang.String protocolPattern,
                                                         java.lang.String lowerIPPattern,
                                                         java.lang.String upperIPPattern,
                                                         java.lang.String applicationPattern,
                                                         long limit,
                                                         javax.ws.rs.core.UriInfo uriInfo)

Description copied from interface: FlowRestService

Retrieve the list of conversations. Supports filtering.

Specified by:

getConversations in interface FlowRestService

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

public FlowSummaryResponse getConversationSummary(java.lang.Integer N,
                                                  java.util.Set<java.lang.String> conversations,
                                                  boolean includeOther,
                                                  javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getConversationSummary in interface FlowRestService

getConversationSeries

public FlowSeriesResponse getConversationSeries(long step,
                                                java.lang.Integer N,
                                                java.util.Set<java.lang.String> conversations,
                                                boolean includeOther,
                                                javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getConversationSeries in interface FlowRestService

getFlowGraphUrlInfo

public FlowGraphUrlInfo getFlowGraphUrlInfo(javax.ws.rs.core.UriInfo uriInfo)

Specified by:

getFlowGraphUrlInfo in interface FlowRestService

getFlowGraphUrl

public java.lang.String getFlowGraphUrl()

setFlowGraphUrl

public void setFlowGraphUrl(java.lang.String flowGraphUrl)

getFiltersFromQueryString

protected static java.util.List<Filter> getFiltersFromQueryString(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> queryParams)