Package org.opennms.netmgt.flows.rest

Interface FlowRestService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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)  
      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.
      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)  

    • Method Detail

      • getFlowCount

        java.lang.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

        java.util.List<FlowNodeSummary> getFlowExporters()
        Retrieves a summary of the nodes that have exported flows. Supports filtering.
        Returns:
        node summaries

      • getFlowExporter

        FlowNodeDetails getFlowExporter​(java.lang.Integer nodeId)
        Retrieved detailed information about a specific node. Supports filtering.
        Parameters:
        nodeId - node id
        Returns:
        node details

      • getDscpValues

        java.util.List<java.lang.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

        java.util.List<java.lang.String> getApplications​(java.lang.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​(java.lang.Integer N,
                                          java.util.Set<java.lang.String> applications,
                                          boolean includeOther,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)

      • getApplicationSeries

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

      • getHosts

        java.util.List<java.lang.String> getHosts​(java.lang.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​(java.lang.Integer N,
                                   java.util.Set<java.lang.String> hosts,
                                   boolean includeOther,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo)

      • getHostSeries

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

      • getConversations

        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,
                                                  @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​(java.lang.Integer N,
                                           java.util.Set<java.lang.String> conversations,
                                           boolean includeOther,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)

      • getConversationSeries

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

      • getFlowGraphUrlInfo

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