Package | Description |
---|---|
com.ibm.tivoli.nm.collectors.framework.collector |
Contains all of the base classes for creating and defining an ITNM Java™ collector.
|
com.ibm.tivoli.nm.collectors.framework.store |
Provides implementations for the
CollectorDataStore
interface for storing network data collected by a given collector. |
com.ibm.tivoli.nm.collectors.framework.utils |
Contains utility methods for performing common functions within the Java™ collector framework.
|
Modifier and Type | Class and Description |
---|---|
class |
CollectorValidationException
Exception thrown when collector data validation checking fails.
|
Modifier and Type | Method and Description |
---|---|
void |
CollectorDataStore.addAssociatedAddress(int dataSourceId,
java.lang.String deviceId,
java.lang.String interfaceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Associate an address with a given device.
|
void |
CollectorDataStore.addConnection(int dataSourceId,
java.lang.String deviceId,
java.lang.String topologyType,
java.util.Map<java.lang.String,java.lang.Object> connection)
Add a connection within a given topology for a given device.
|
void |
CollectorDataStore.addDataSource(DataSource ds)
Add a new source of collector data from a given DataSource object
|
void |
CollectorDataStore.addDataSource(int dataSourceId,
java.lang.String dataSourceDescription)
Add a new source of collector data.
|
void |
CollectorDataStore.addDataSource(int dataSourceId,
java.lang.String dataSourceDescription,
java.util.Map<java.lang.String,?> data)
Add a new source of collector data with pre-existing data
|
java.lang.Object |
CollectorDataStore.addDeviceData(int dataSourceId,
java.lang.String deviceId,
java.lang.Object data)
Add device data to a given device.
|
void |
CollectorDataStore.addEntity(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Add entity data to a given device.
|
void |
CollectorDataStore.addGeographicLocation(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Adds geographical data to a given device.
|
void |
CollectorDataStore.addInterface(int dataSourceId,
java.lang.String deviceId,
java.lang.String interfaceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Add interface data to a given device.
|
void |
CollectorDataStore.addL2Vpn(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Add layer 2 VPN data to a device.
|
void |
CollectorDataStore.addL3Vpn(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Add layer 3 VPN data to a device.
|
void |
CollectorDataStore.addL3VpnInterface(int dataSourceId,
java.lang.String deviceId,
java.lang.String interfaceId,
java.lang.String vpnName,
java.util.Map<java.lang.String,java.lang.Object> interfaceData)
Add VPN interface data for a given layer 3 VPN.
|
void |
CollectorDataStore.addL3VpnRouteTarget(int dataSourceId,
java.lang.String deviceId,
java.lang.String vpnName,
java.lang.String routeTarget,
int routeTargetType)
Adds VPN route target data for a given layer 3 VPN
|
void |
CollectorDataStore.addLayer1Connection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> connection)
Add a layer 1 connection for a given device.
|
void |
CollectorDataStore.addLayer2Connection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> connection)
Add a layer 2 connection for a given device.
|
void |
CollectorDataStore.addLayer3Connection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> connection)
Add a layer 3 connection for a given device.
|
void |
CollectorDataStore.addLsp(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Add LSP data to a given device.
|
void |
CollectorDataStore.addMplsInterface(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data)
Add MPLS interface data to a given device.
|
void |
CollectorDataStore.removeDeviceEntityData(int dataSourceId,
java.lang.String deviceId)
Delete/remove entity data associated with a given device and data source
|
void |
CollectorDataStore.removeDeviceInterfaceData(int dataSourceId,
java.lang.String deviceId)
Delete/remove interface data associated with a given device and data source
|
void |
CollectorDataStore.removeDeviceLayer2ConnectionData(int dataSourceId,
java.lang.String deviceId)
Delete/remove layer 2 connection data associated with a given device and data source
|
void |
CollectorDataStore.removeDeviceLayer2VpnData(int dataSourceId,
java.lang.String deviceId)
Delete/remove layer 2 Vpn data associated with a given device and data source
|
void |
CollectorDataStore.removeDeviceLayer3VpnData(int dataSourceId,
java.lang.String deviceId)
Delete/remove layer 3 VPN data associated with a given device and data source
|
void |
CollectorDataStore.removeDeviceMplsData(int dataSourceId,
java.lang.String deviceId)
Delete/remove MPLS data associated with a given device and data source
|
Modifier and Type | Method and Description |
---|---|
void |
DataStore.addAssociatedAddress(int dataSourceId,
java.lang.String deviceId,
java.lang.String interfaceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
RANNetworkDevice |
RANDataStore.addBaseStation(int dataSourceId,
java.lang.String deviceId,
java.lang.String baseStationId,
java.lang.String controllerId,
java.lang.String technologyType)
Add a new base station to the data store
|
RANNetworkDevice |
RANDataStore.addBaseStationController(int dataSourceId,
java.lang.String deviceId,
java.lang.String controllerId,
java.lang.String technologyType)
Add a new base station controller to the data store
|
void |
DataStore.addConnection(int dataSourceId,
java.lang.String deviceId,
java.lang.String topologyType,
java.util.Map<java.lang.String,java.lang.Object> connection) |
void |
DataStore.addDataSource(DataSource ds)
Add a new source of collector data.
|
void |
DataStore.addDataSource(int dataSourceId,
java.lang.String dataSourceDescription) |
void |
DataStore.addDataSource(int dataSourceId,
java.lang.String dataSourceDescription,
java.util.Map<java.lang.String,?> data)
WARNING: No validation is done on this addition of data, validation can
be performed afterwards using the methods available in
CollectorValidationUtils |
java.lang.Object |
DataStore.addDeviceData(int dataSourceId,
java.lang.String deviceId,
java.lang.Object data) |
LTEEIR |
LTEDataStore.addEIR(int dataSourceId,
java.lang.String deviceId,
java.lang.String parentChassisId,
java.lang.String parentChassisDn)
Add an EIR to store
|
LTEENodeB |
LTEDataStore.addENodeB(int dataSourceId,
java.lang.String deviceId,
java.lang.String parentChassisId,
java.lang.String parentChassisDn)
Add a eNodeB to store
|
void |
DataStore.addEntity(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
void |
DataStore.addGeographicLocation(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
RANNetworkDevice |
RANDataStore.addGGSN(int dataSourceId,
java.lang.String deviceId,
java.lang.String ggsnId,
java.lang.String technologyType,
java.lang.String accessPointName)
Add a new Gateway GPRS Serving Node (GGSN) to the data store
|
RANLogicalElement |
RANDataStore.addGSMCell(int dataSourceId,
java.lang.String cellId,
java.lang.String technologyType,
java.util.Map<java.lang.String,java.lang.Object> cellData)
Add a GSM cell to the data store.
|
LTEHSS |
LTEDataStore.addHSS(int dataSourceId,
java.lang.String deviceId,
java.lang.String parentChassisId,
java.lang.String parentChassisDn)
Add an HSS to the store
|
void |
DataStore.addInterface(int dataSourceId,
java.lang.String deviceId,
java.lang.String interfaceKey,
java.util.Map<java.lang.String,java.lang.Object> data) |
void |
DataStore.addL2Vpn(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
void |
DataStore.addL3Vpn(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
void |
DataStore.addL3VpnInterface(int dataSourceId,
java.lang.String deviceId,
java.lang.String interfaceKey,
java.lang.String vpnName,
java.util.Map<java.lang.String,java.lang.Object> interfaceData) |
void |
NetworkDevice.addL3VpnInterface(java.lang.String vpnName,
java.lang.String interfaceKey,
java.util.Map<java.lang.String,java.lang.Object> interfaceData)
Add VPN interface data for a given layer 3 VPN.
|
void |
DataSource.addL3VpnInterface(java.lang.String deviceId,
java.lang.String interfaceKey,
java.lang.String vpnName,
java.util.Map<java.lang.String,java.lang.Object> interfaceData)
Add VPN interface data for a given layer 3 VPN.
|
void |
DataStore.addL3VpnRouteTarget(int dataSourceId,
java.lang.String deviceId,
java.lang.String vpnName,
java.lang.String routeTarget,
int routeTargetType) |
void |
NetworkDevice.addL3VpnRouteTarget(java.lang.String vpnName,
java.lang.String routeTarget,
int routeTargetType)
Adds VPN route target data for a given VPN
|
void |
DataSource.addL3VpnRouteTarget(java.lang.String deviceId,
java.lang.String vpnName,
java.lang.String routeTarget,
int routeTargetType)
Adds VPN route target data for a given layer 3 VPN
|
void |
DataStore.addLayer1Connection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
void |
DataStore.addLayer2Connection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
void |
DataStore.addLayer3Connection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
void |
DataStore.addLsp(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
RANNetworkDevice |
RANDataStore.addMediaGateway(int dataSourceId,
java.lang.String deviceId,
java.lang.String mgwId)
Add a new media gateway to the store
|
LTEMME |
LTEDataStore.addMME(int dataSourceId,
java.lang.String deviceId,
java.lang.String parentChassisId,
java.lang.String parentChassisDn)
Add an MME to store
|
RANNetworkDevice |
RANDataStore.addMobileSwitchingCentre(int dataSourceId,
java.lang.String deviceId,
java.lang.String mscId,
java.lang.String technologyType,
java.lang.String mscType)
Add a new mobile switching centre to the data store
|
void |
DataStore.addMplsInterface(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> data) |
RANNetworkDevice |
RANDataStore.addMSS(int dataSourceId,
java.lang.String deviceId,
java.lang.String mssId)
Add a new mobile switching centre server (MSS) to the data store
|
RANNetworkDevice |
RANDataStore.addMultiplexer(int dataSourceId,
java.lang.String deviceId)
Add a device that is a multiplexer.
|
RANNetworkDevice |
RANDataStore.addNodeB(int dataSourceId,
java.lang.String deviceId,
java.lang.String nodeBId,
java.lang.String controllerId,
java.lang.String technologyType)
Add a new Node B to the data store
|
RANNetworkDevice |
RANDataStore.addPacketControlUnit(int dataSourceId,
java.lang.String deviceId,
java.lang.String packetControlUnitId,
java.lang.String controllerId,
java.lang.String technologyType)
Add a new packet control unit to the data store
|
LTEPCRF |
LTEDataStore.addPCRF(int dataSourceId,
java.lang.String deviceId,
java.lang.String parentChassisId,
java.lang.String parentChassisDn)
Add a PCRF to store
|
LTEPGW |
LTEDataStore.addPGW(int dataSourceId,
java.lang.String deviceId,
java.lang.String parentChassisId,
java.lang.String parentChassisDn)
Add an PGW to store
|
RANNetworkDevice |
RANDataStore.addRadioNetworkController(int dataSourceId,
java.lang.String deviceId,
java.lang.String controllerId,
java.lang.String technologyType)
Add a new radio network controller to the data store
|
void |
RANDataStore.addRANConnection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> connection)
Add a logical RAN connection to a specified device.
|
void |
RANDataStore.addRANConnection(int dataSourceId,
java.lang.String deviceId,
java.util.Map<java.lang.String,java.lang.Object> connection,
int nsei)
Add a logical RAN connection to a specified device.
|
RANNetworkDevice |
RANDataStore.addSGSN(int dataSourceId,
java.lang.String deviceId,
java.lang.String sgsnId,
java.lang.String technologyType)
Add a new serving GPRS serving node (SGSN) to the data store
|
LTESGW |
LTEDataStore.addSGW(int dataSourceId,
java.lang.String deviceId,
java.lang.String parentChassisId,
java.lang.String parentChassisDn)
Add an SGW to store
|
RANLogicalElement |
RANDataStore.addUtranCell(int dataSourceId,
java.lang.String cellId,
java.util.Map<java.lang.String,java.lang.Object> cellData)
Add a UTRAN cell to the data store.
|
DataSource |
DataStore.getDataSource(int sourceId) |
Modifier and Type | Method and Description |
---|---|
static void |
CollectorDataUtils.addCollectedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
CollectorDataUtils.addCollectedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int sequence)
Add a collects relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
CollectorDataUtils.addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between two entities.
|
static void |
CollectorDataUtils.addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int sequence)
Add a collects relationship between two entities.
|
static void |
CollectorDataUtils.addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between some entity data and another entity.
|
static void |
CollectorDataUtils.addCollectedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int sequence)
Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
CollectorDataUtils.addContainedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
CollectorDataUtils.addContainedEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int upwardConnection)
Add a contains relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
CollectorDataUtils.addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a containment (contains) relationship between two entities
|
static void |
CollectorDataUtils.addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int upwardConnection)
Add a containment (contains) relationship between two entities
|
static void |
CollectorDataUtils.addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
CollectorDataUtils.addContainedEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int upwardConnection)
Add a collects relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
CollectorDataUtils.addDependentEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
CollectorDataUtils.addDependentEntity(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int dependencyType)
Add a dependency relationship between an element and another entity Note: Adds data under extraInfo or customData
-> dataName fields
|
static void |
CollectorDataUtils.addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a dependency relationship between two entities
|
static void |
CollectorDataUtils.addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int dependencyType)
Add a dependency relationship between two entities
|
static void |
CollectorDataUtils.addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
CollectorDataUtils.addDependentEntity(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails,
int dependencyType)
Add a dependency relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
CollectorDataUtils.addGenericRelationshipData(java.util.Map<java.lang.String,java.lang.Object> customData,
java.lang.String relationship,
java.util.Map<java.lang.String,java.lang.Object> relationshipData)
Add generic relationship data (e.g.
|
static void |
CollectorDataUtils.addHostedService(Element element,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a hostedService relationship between an element and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static void |
CollectorDataUtils.addHostedService(java.util.Map<java.lang.String,java.lang.Object> dataHash,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a hostedService relationship between two entities
|
static void |
CollectorDataUtils.addHostedService(java.util.Map<java.lang.String,java.lang.Object> entityData,
java.lang.String dataName,
java.util.Map<java.lang.String,java.lang.Object> entityDetails)
Add a hostedService relationship between some entity data and another entity Note: Adds data under extraInfo or
customData -> dataName fields
|
static java.io.File |
CollectorFileUtils.getDirectory(java.lang.String strPath,
java.lang.String strRelativeDir)
Returns the File instance for the specified directory
|
static java.io.File |
CollectorFileUtils.getFile(java.lang.String strPath,
java.lang.String strRelativeDir)
Returns the File instance for the specified file
|
static java.io.File |
CollectorFileUtils.getFile(java.lang.String strDirectory,
java.lang.String strFile,
java.lang.String strRelativeDir)
Returns the File instance for the specified directory
|