org.opennms.netmgt.dao.support

Class DefaultResourceDao

java.lang.Object

org.opennms.netmgt.dao.support.DefaultResourceDao

All Implemented Interfaces:

ResourceDao, org.springframework.beans.factory.InitializingBean

public class DefaultResourceDao
extends Object
implements ResourceDao, org.springframework.beans.factory.InitializingBean

Retrieves and enumerates elements from the resource tree. This class is responsible for maintaining the list of resource types and coordinating amongst these. All resource type specific logic should be contained in the resource type implementations rather than this class.

Author:

Jesse White, Seth Leger , Lawrence Karnowski , DJ Gregor

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXIMUM_NODE_METRIC_RESOURCE_DEPTH Largest depth at which we will find node related metrics: [0] will catch node-level resources [1] will catch interface-level resources [2] will catch generic index type resources

Constructor Summary

Constructors

Constructor and Description
DefaultResourceDao() Constructor for DefaultResourceDao.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() afterPropertiesSet
static String	decode(String string) Encapsulate the deprecated decode method to fix it in one place.
boolean	deleteResource(OnmsResource resource, boolean recursive)
boolean	deleteResourceById(ResourceId resourceId) Deletes the resource identified by the given resource ID.
List<OnmsResource>	findTopLevelResources() findTopLevelResources
protected OnmsResource	getChildResource(OnmsResource parentResource, String resourceType, String resource) getChildResource
CollectdConfigFactory	getCollectdConfig() getCollectdConfig
IpInterfaceDao	getIpInterfaceDao()
LocationMonitorDao	getLocationMonitorDao() getLocationMonitorDao
NodeDao	getNodeDao() getNodeDao
OnmsResource	getResourceById(ResourceId id) Fetch a specific resource by string ID.
OnmsResource	getResourceForIpInterface(OnmsIpInterface ipInterface, OnmsLocationMonitor locMon) getResourceForIpInterface
OnmsResource	getResourceForNode(OnmsNode node) Creates a resource for the given node using the most appropriate type.
ResourceStorageDao	getResourceStorageDao()
Collection<OnmsResourceType>	getResourceTypes() getResourceTypes
ResourceTypesDao	getResourceTypesDao()
protected boolean	hasAnyChildResources(OnmsResource resource) Used to determine whether or not the given (parent) resource has any child resources.
void	setCollectdConfig(CollectdConfigFactory collectdConfig) setCollectdConfig
void	setIpInterfaceDao(IpInterfaceDao ipInterfaceDao)
void	setLocationMonitorDao(LocationMonitorDao locationMonitorDao) setLocationMonitorDao
void	setNodeDao(NodeDao nodeDao) setNodeDao
void	setResourceStorageDao(ResourceStorageDao resourceStorageDao)
void	setResourceTypesDao(ResourceTypesDao resourceTypesDao)

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_NODE_METRIC_RESOURCE_DEPTH

public static final int MAXIMUM_NODE_METRIC_RESOURCE_DEPTH

Largest depth at which we will find node related metrics: [0] will catch node-level resources [1] will catch interface-level resources [2] will catch generic index type resources

See Also:

Constant Field Values

Constructor Detail

DefaultResourceDao

public DefaultResourceDao()

Constructor for DefaultResourceDao.

Method Detail

getResourceTypesDao

public ResourceTypesDao getResourceTypesDao()

setResourceTypesDao

public void setResourceTypesDao(ResourceTypesDao resourceTypesDao)

getNodeDao

public NodeDao getNodeDao()

getNodeDao

Returns:

a NodeDao object.

setNodeDao

public void setNodeDao(NodeDao nodeDao)

setNodeDao

Parameters:

nodeDao - a NodeDao object.

getCollectdConfig

public CollectdConfigFactory getCollectdConfig()

getCollectdConfig

Returns:

a CollectdConfigFactory object.

setCollectdConfig

public void setCollectdConfig(CollectdConfigFactory collectdConfig)

setCollectdConfig

Parameters:

collectdConfig - a CollectdConfigFactory object.

getLocationMonitorDao

public LocationMonitorDao getLocationMonitorDao()

getLocationMonitorDao

Returns:

a LocationMonitorDao object.

setLocationMonitorDao

public void setLocationMonitorDao(LocationMonitorDao locationMonitorDao)

setLocationMonitorDao

Parameters:

locationMonitorDao - a LocationMonitorDao object.

getIpInterfaceDao

public IpInterfaceDao getIpInterfaceDao()

setIpInterfaceDao

public void setIpInterfaceDao(IpInterfaceDao ipInterfaceDao)

setResourceStorageDao

public void setResourceStorageDao(ResourceStorageDao resourceStorageDao)

getResourceStorageDao

public ResourceStorageDao getResourceStorageDao()

afterPropertiesSet

public void afterPropertiesSet()

afterPropertiesSet

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getResourceTypes

public Collection<OnmsResourceType> getResourceTypes()

getResourceTypes

Specified by:

getResourceTypes in interface ResourceDao

Returns:

a Collection object.

findTopLevelResources

@Transactional(readOnly=true)
public List<OnmsResource> findTopLevelResources()

findTopLevelResources

Specified by:

findTopLevelResources in interface ResourceDao

Returns:

a List object.

hasAnyChildResources

protected boolean hasAnyChildResources(OnmsResource resource)

Used to determine whether or not the given (parent) resource has any child resources.

getResourceById

@Transactional(readOnly=true)
public OnmsResource getResourceById(ResourceId id)

Fetch a specific resource by string ID.

Specified by:

getResourceById in interface ResourceDao

Parameters:

id - a String object.

Returns:

Resource or null if resource cannot be found.

Throws:

IllegalArgumentException - When the resource ID string does not match the expected regex pattern

org.springframework.orm.ObjectRetrievalFailureException - If any exceptions are thrown while searching for the resource

getResourceForNode

public OnmsResource getResourceForNode(OnmsNode node)

Creates a resource for the given node using the most appropriate type.

Specified by:

getResourceForNode in interface ResourceDao

Parameters:

node - a OnmsNode object.

Returns:

a OnmsResource object.

getResourceForIpInterface

public OnmsResource getResourceForIpInterface(OnmsIpInterface ipInterface,
                                              OnmsLocationMonitor locMon)

Description copied from interface: ResourceDao

getResourceForIpInterface

Specified by:

getResourceForIpInterface in interface ResourceDao

Parameters:

ipInterface - a OnmsIpInterface object.

locMon - a OnmsLocationMonitor object.

Returns:

OnmsResource for the distributedStatus resource on the interface or null if the distributedStatus resource cannot be found for the given IP interface.

deleteResourceById

public boolean deleteResourceById(ResourceId resourceId)

Description copied from interface: ResourceDao

Deletes the resource identified by the given resource ID.

Specified by:

deleteResourceById in interface ResourceDao

Parameters:

resourceId - the ID of the resource to delete

Returns:

true iff, the resource was found and deleted

deleteResource

public boolean deleteResource(OnmsResource resource,
                              boolean recursive)

getChildResource

protected OnmsResource getChildResource(OnmsResource parentResource,
                                        String resourceType,
                                        String resource)

getChildResource

Parameters:

parentResource - a OnmsResource object.

resourceType - a String object.

resource - a String object.

Returns:

a OnmsResource object.

decode

public static String decode(String string)

Encapsulate the deprecated decode method to fix it in one place.

Parameters:

string - string to be decoded

Returns:

decoded string