org.opennms.reporting.datablock

Class Interface

java.lang.Object

org.opennms.reporting.datablock.StandardNamedObject

org.opennms.reporting.datablock.Interface

public class Interface
extends StandardNamedObject

This class holds the interface information and list of services that belong to the interface.

Author:

Jacinta Remedios

Constructor Summary

Constructors

Constructor and Description
Interface() Default Constructor.
Interface(List<Service> services) Constructor that sets the services.
Interface(String name) Constructor that sets the name.
Interface(String name, List<Service> services) Constructor that sets the name of interface and sets the services.
Interface(String name, String service) Constructor that sets the name and adds service.
Interface(String name, String service, long losttime) Constructor that sets the name to interface and adds service and outage with lost time.
Interface(String name, String service, long losttime, long regainedtime) Constructor that sets the name to interface and adds service and outage with lost time and regained time.

Method Summary

Modifier and Type	Method and Description
void	addService(Service service) Adds a new service object to this interface
void	addService(String service) Adds a new service to this interface
void	addService(String service, long losttime) Adds a new service to this interface.
void	addService(String service, long losttime, long regainedtime) Adds a service to this interface with outage having lost time and regained time.
boolean	equals(Object obj)
long	getDownTime(long currentTime, long rollingWindow) Returns the down time for this interface.
Service	getService(String svcname) Return the Service object given the service name
int	getServiceAffectCount() Returns the number of services affected.
int	getServiceCount() Returns the number of services that this node/interface has.
List<Service>	getServices() Return the services

Methods inherited from class org.opennms.reporting.datablock.StandardNamedObject

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

Interface

public Interface()

Default Constructor.

Interface

public Interface(String name,
                 List<Service> services)

Constructor that sets the name of interface and sets the services.

Parameters:

name - Name of the interface.

services - Services to be set for this interface.

Interface

public Interface(String name,
                 String service)

Constructor that sets the name and adds service. If there is already an interface with name, this method adds a service to this found service. Otherwise adds a new interface with service.

Parameters:

name - Name of the interface.

service - Name of the service to be added

Interface

public Interface(String name,
                 String service,
                 long losttime)

Constructor that sets the name to interface and adds service and outage with lost time. If there is already an interface with name, adds a service depending upon whether it exists or not. Otherwise adds a new interface with service.

Parameters:

name - Name of the interface.

service - Name of the service to be added

losttime - Lost time

Interface

public Interface(String name,
                 String service,
                 long losttime,
                 long regainedtime)

Constructor that sets the name to interface and adds service and outage with lost time and regained time. If there is already an interface with name, adds a service depending upon whether it exists or not. Otherwise adds a new interface with service.

Parameters:

name - Name of the interface.

service - Name of the service to be added

losttime - Lost time

regainedtime - Regained Time

Interface

public Interface(String name)

Constructor that sets the name.

Parameters:

name - Name of the interface.

Interface

public Interface(List<Service> services)

Constructor that sets the services.

Parameters:

services - Services for this interface to be set.

Method Detail

getServices

public List<Service> getServices()

Return the services

Returns:

Services to be set.

getService

public Service getService(String svcname)

Return the Service object given the service name

Parameters:

svcname - The service name to lookup.

Returns:

Service with matching service name.

addService

public void addService(Service service)

Adds a new service object to this interface

Parameters:

service - The service to be add.

addService

public void addService(String service)

Adds a new service to this interface

Parameters:

service - The name of the service to add.

addService

public void addService(String service,
                       long losttime)

Adds a new service to this interface.

Parameters:

service - Service name to be added

losttime - Outage with lost time to be added to service

addService

public void addService(String service,
                       long losttime,
                       long regainedtime)

Adds a service to this interface with outage having lost time and regained time.

Parameters:

service - Service name

losttime - Lost time

regainedtime - Regained Time

getDownTime

public long getDownTime(long currentTime,
                        long rollingWindow)

Returns the down time for this interface.

Parameters:

currentTime - End of rolling window

rollingWindow - Rolling Window

Returns:

the down time for this interface.

getServiceCount

public int getServiceCount()

Returns the number of services that this node/interface has.

Returns:

a int.

getServiceAffectCount

public int getServiceAffectCount()

Returns the number of services affected.

Returns:

a int.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object