org.opennms.netmgt.collection.api

Interface StorageStrategy

All Known Implementing Classes:

FrameRelayStorageStrategy, HostFileSystemStorageStrategy, IndexStorageStrategy, JexlIndexStorageStrategy, ObjectNameStorageStrategy, SiblingColumnStorageStrategy, XmlStorageStrategy

public interface StorageStrategy

StorageStrategy interface.

Method Summary

Modifier and Type	Method and Description
ResourcePath	getRelativePathForAttribute(ResourcePath resourceParent, String resource) getRelativePathForAttribute
String	getResourceNameFromIndex(CollectionResource resource) This functions translate resourceIndex into a "unique" and "non-variable" name that could be identify a resource, as described earlier.
void	setParameters(List<Parameter> parameterCollection) setParameters
void	setResourceTypeName(String name) setResourceTypeName
void	setStorageStrategyService(StorageStrategyService agent) Add to a strategy the possibility to get additional information using SNMP when is necessary.

Method Detail

getRelativePathForAttribute

ResourcePath getRelativePathForAttribute(ResourcePath resourceParent,
                                         String resource)

getRelativePathForAttribute

Parameters:

resourceParent - a String object.

resource - a String object.

Returns:

a Path object.

setResourceTypeName

void setResourceTypeName(String name)

setResourceTypeName

Parameters:

name - a String object.

getResourceNameFromIndex

String getResourceNameFromIndex(CollectionResource resource)

This functions translate resourceIndex into a "unique" and "non-variable" name that could be identify a resource, as described earlier. This method could be expensive because it could require send SNMP queries and make complicated functions to build the name. So you must try to call it only when is necessary.

Parameters:

resource - a CollectionResource object

Returns:

a String object.

setStorageStrategyService

void setStorageStrategyService(StorageStrategyService agent)

Add to a strategy the possibility to get additional information using SNMP when is necessary. There are complex tables on some MIBs where indexes depends on indexes from other tables (indirect indexing). For this kind of resources we must send some additional SNMP queries to build a unique name.

Parameters:

agent - a org.opennms.netmgt.config.StorageStrategyService object.

setParameters

void setParameters(List<Parameter> parameterCollection)
            throws IllegalArgumentException

setParameters

Parameters:

parameterCollection - a List object.

Throws:

IllegalArgumentException