Package org.opennms.web.svclayer

Interface SiteStatusViewService

  • All Known Implementing Classes:
    DefaultSiteStatusViewService
    @Transactional(readOnly=true)
public interface SiteStatusViewService
    Service layer API for the use cases that require the monitoed status of OpenNMS entities (i.e. OnmsNode) to be aggregated with status information that provides color and numberic indicators of status.
    Author:
    David Hustace, DJ Gregor

    • Method Detail

      • createAggregateStatusView

        AggregateStatusView createAggregateStatusView​(java.lang.String statusViewName)
        This method returns method returns a collection of aggregated status of nodes for each device category. In this case a column in the assets table is used as "site" for which to select devices. The devices are aggregated by the list of categories specified in categoryGrouping.
        Parameters:
        statusViewName - a String object.
        Returns:
        a AggregateStatusView object.

      • createAggregateStatuses

        java.util.Collection<AggregateStatus> createAggregateStatuses​(AggregateStatusView statusView,
                                                              java.lang.String statusSite)

        createAggregateStatuses

        Parameters:
        statusView - a AggregateStatusView object.
        statusSite - a String object.
        Returns:
        a Collection object.

      • createAggregateStatusesUsingNodeId

        java.util.Collection<AggregateStatus> createAggregateStatusesUsingNodeId​(int nodeId,
                                                                         java.lang.String viewName)

        createAggregateStatusesUsingNodeId

        Parameters:
        nodeId - a int.
        viewName - a String object.
        Returns:
        a Collection object.

      • getAggregateStatus

        AggregateStatus getAggregateStatus​(java.lang.String statusViewName,
                                   java.lang.String statusSite,
                                   java.lang.String rowLabel)

        getAggregateStatus

        Parameters:
        statusViewName - a String object.
        statusSite - a String object.
        rowLabel - a String object.
        Returns:
        a AggregateStatus object.

      • getNodes

        java.util.Collection<OnmsNode> getNodes​(java.lang.String statusViewName,
                                        java.lang.String statusSite,
                                        java.lang.String rowLabel)

        getNodes

        Parameters:
        statusViewName - a String object.
        statusSite - a String object.
        rowLabel - a String object.
        Returns:
        a Collection object.