com.ibm.tivoli.nm.collectors.framework.corba.impl.tmf814

Class TMF814CorbaProperties

java.lang.Object

com.ibm.tivoli.nm.collectors.framework.corba.properties.CorbaPropertiesBase

com.ibm.tivoli.nm.collectors.framework.corba.impl.tmf814.TMF814CorbaProperties

All Implemented Interfaces:

CorbaProperties

Direct Known Subclasses:

EciLightsoftProperties

public class TMF814CorbaProperties
extends CorbaPropertiesBase
implements CorbaProperties

TMF814 v2.1 implementation of the CORBA Properties

Author:

Yeo Eng Seng

Constructor Summary

Constructors

Constructor and Description
TMF814CorbaProperties(java.util.Properties _propsFile) Constructor

Method Summary

Modifier and Type	Method and Description
void	configureAllProperties() Configures all properties read from the Properties file
protected void	configureEmsSessionFactoryProps() Configures EmsSessionFactory properties
protected void	configureIteratorProps() Configures CORBA Iterator properties
protected void	configureManagerNames() Configures Manager interface names properties
protected void	configureNameServiceProps() Configures Naming Service properties
java.lang.String	getEmsMgr() Gets emsMgr
java.lang.String	getEquipmentInventoryMgr() Gets getEquipmentInventoryMgr
java.lang.String	getEsfIORFile() Gets the esfIORFile
java.util.Map<java.lang.String,java.lang.String>	getEsfNamingContextProperties() Gets corbaNamingContextProperties Map
int	getIntResultSize() Gets intResultSize
java.lang.String	getManagedElementMgr() Gets managedElementMgr
java.lang.String	getMultiLayerSubnetworkMgr() Gets multiLayerSubnetworkMgr
java.lang.String	getNameservice() Gets the nameService
java.lang.String	getNsIORFile() Gets the nsIORFile
java.util.Set<java.lang.String>	getPropsMapping(java.lang.String strPrefix, java.lang.String strSuffix) Returns property groups based on the prefix or suffix of the property names
boolean	isBlnDestroyIterator() Gets blnDestroyIterator
boolean	isEsfUseNameService() Gets esfUseNameService
boolean	isNsUseNameService() Gets nsUseNameService
void	setBlnDestroyIterator(boolean blnDestroyIterator) Sets blnDestroyIterator
void	setEmsMgr(java.lang.String emsMgr) Sets emsMgr
void	setEquipmentInventoryMgr(java.lang.String equipmentInventoryMgr) Sets setEquipmentInventoryMgr
void	setEsfIORFile(java.lang.String esfIORFile) Sets esfIORFile
void	setEsfNamingContextProperties(java.util.Map<java.lang.String,java.lang.String> corbaNamingContextProperties) Sets corbaNamingContextProperties Map
void	setEsfUseNameService(boolean esfUseNameService) Sets esfUseNameService
void	setIntResultSize(int intResultSize) Sets intResultSize
void	setManagedElementMgr(java.lang.String managedElementMgr) Sets managedElementMgr
void	setMultiLayerSubnetworkMgr(java.lang.String multiLayerSubnetworkMgr) Sets multiLayerSubnetworkMgr
void	setNameservice(java.lang.String nameService) Sets nameService
void	setNsIORFile(java.lang.String nsIORFile) Sets nsIORFile
void	setNsUseNameService(boolean nsUseNameService) Sets nsUseNameService

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.corba.properties.CorbaPropertiesBase

configureDataAcquisitionProps, configureEMSProps, configureOrbProps, getEmshost, getEmspassword, getEmsport, getEmsusername, getOrbProp, getPropsMapping, isCollectDataFlag, isGetEntitiesFlag, isGetLayer1ConnFlag, isGetLayer2ConnFlag, setCollectDataFlag, setEmshost, setEmspassword, setEmsport, setEmsusername, setGetEntitiesFlag, setGetLayer1ConnFlag, setGetLayer2ConnFlag, setOrbProp

Methods inherited from class java.lang.Object

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

Constructor Detail

TMF814CorbaProperties

public TMF814CorbaProperties(java.util.Properties _propsFile)

Constructor

Parameters:

_propsFile - Java Properties object containing all property values from the Collector Properties file

Method Detail

configureAllProperties

public void configureAllProperties()

Configures all properties read from the Properties file

Specified by:

configureAllProperties in interface CorbaProperties

configureNameServiceProps

protected void configureNameServiceProps()

Configures Naming Service properties

The following properties are configured:

• nameService.useNameService (default is true)
• nameService.iorFile (default is nameservice.ior)
• nameService.nameServiceName (default is NameService)

These properties specify how the Collector interacts with the Naming Service of an EMS. The Collector has to obtain the root naming context reference of the Naming Service, and the Collector has the following options:

• Use a corbaloc URL
The Collector will obtain the root naming context reference using a corbaloc URL. The URL will be in the form of corbaloc:iiop:hostname:port/nameServiceName
• From an IOR file
The IOR file may be provided locally or remotely. If provided locally, the full filepath must be specified. If provided remotely, the specified filepath should be in the form of a URL for a commonly used service eg. HTTP or FTP.

It should be noted that only one option can be used at a time. As some EMSes only support one option or the other, and it is up to discretion of the user to select the appropriate option.

configureEmsSessionFactoryProps

protected void configureEmsSessionFactoryProps()

Configures EmsSessionFactory properties

The following properties are configured:

• emsSessionFactory.useNameService (default is true)
• emsSessionFactory.iorFile (default is file://esf.ior)
• Naming context properties of the form of emsSessionFactory.namingContext.*.id and emsSessionFactory.namingContext.*.kind pairs

These properties specify how the Collector resolves the EmsSessionFactory_I reference. The Collector has the following options:

• Resolve the naming context bindings through the Naming Service
The Collector will access the EMS Naming Service using a corbaloc URL. If successful, the Collector will resolve the naming context bindings using the naming context properties that have been specified.
• From an IOR file
The IOR file may be provided locally or remotely. If provided locally, the full filepath must be specified. If provided remotely, the specified filepath should be in the form of a URL for a commonly used service eg. HTTP or FTP.

An example of the naming context entries can be found in the sample Properties file in the specific Collector directory. If the EMS requires more naming context entries to be specified than in the example, additional entries may be added to the list eg.

emsSessionFactory.namingContext.6.id=idValue6
emsSessionFactory.namingContext.6.kind=kindValue6
emsSessionFactory.namingContext.7.kind=kindValue7
emsSessionFactory.namingContext.7.kind=kindValue7

If the EMS requires less naming context entries to be specified than in the example, remove all unneeded entries.

All entries must be in *.id and *.kind pairs. The entries must also be in the correct sequence in order for the EmsSessionFactory_I object reference to be correctly resolved. The entry for the EmsSessionFactory_I object must always be specified as the last entry.

It should be noted that only one option can be used at a time. As some EMSes only support one option or the other, and it is up to discretion of the user to select the appropriate option.

configureManagerNames

protected void configureManagerNames()

Configures Manager interface names properties

The following properties are configured:

• emsMgr (default is EMS)
• equipmentInventoryMgr (default is EquipmentInventory)
• managedElementMgr (default is ManagedElement)
• multiLayerSubnetworkMgr (default is MultiLayerSubnetwork)

These properties specify the names of the Manager interfaces on the EMS.

getPropsMapping

public java.util.Set<java.lang.String> getPropsMapping(java.lang.String strPrefix,
                                                       java.lang.String strSuffix)

Returns property groups based on the prefix or suffix of the property names

Parameters:

strPrefix - User-specified prefix for the mappings

strSuffix - User-specified suffix for the mappings

Returns:

Set containing mappings

configureIteratorProps

protected void configureIteratorProps()

Configures CORBA Iterator properties

The following properties are configured:

• iterator.intResultSize (default is 20)
• iterator.destroyIterator (default is false)

These properties control the behaviour of the CORBA Iterator object returned after a CORBA method is invoked.

getNsIORFile

public java.lang.String getNsIORFile()

Gets the nsIORFile

Returns:

nsIORFile

setNsIORFile

public void setNsIORFile(java.lang.String nsIORFile)

Sets nsIORFile

Parameters:

nsIORFile - nsIORFile

getNameservice

public java.lang.String getNameservice()

Gets the nameService

Returns:

nameService

setNameservice

public void setNameservice(java.lang.String nameService)

Sets nameService

Parameters:

nameService - nameService

getEsfIORFile

public java.lang.String getEsfIORFile()

Gets the esfIORFile

Returns:

esfIORFile

setEsfIORFile

public void setEsfIORFile(java.lang.String esfIORFile)

Sets esfIORFile

Parameters:

esfIORFile -

getEsfNamingContextProperties

public java.util.Map<java.lang.String,java.lang.String> getEsfNamingContextProperties()

Gets corbaNamingContextProperties Map

Returns:

corbaNamingContextProperties

setEsfNamingContextProperties

public void setEsfNamingContextProperties(java.util.Map<java.lang.String,java.lang.String> corbaNamingContextProperties)

Sets corbaNamingContextProperties Map

Parameters:

corbaNamingContextProperties - corbaNamingContextProperties Map

getEmsMgr

public java.lang.String getEmsMgr()

Gets emsMgr

Returns:

emsMgr

setEmsMgr

public void setEmsMgr(java.lang.String emsMgr)

Sets emsMgr

Parameters:

emsMgr - emsMgr

getEquipmentInventoryMgr

public java.lang.String getEquipmentInventoryMgr()

Gets getEquipmentInventoryMgr

Returns:

getEquipmentInventoryMgr

setEquipmentInventoryMgr

public void setEquipmentInventoryMgr(java.lang.String equipmentInventoryMgr)

Sets setEquipmentInventoryMgr

Parameters:

equipmentInventoryMgr - setEquipmentInventoryMgr

getManagedElementMgr

public java.lang.String getManagedElementMgr()

Gets managedElementMgr

Returns:

managedElementMgr

setManagedElementMgr

public void setManagedElementMgr(java.lang.String managedElementMgr)

Sets managedElementMgr

Parameters:

managedElementMgr - managedElementMgr

getMultiLayerSubnetworkMgr

public java.lang.String getMultiLayerSubnetworkMgr()

Gets multiLayerSubnetworkMgr

Returns:

multiLayerSubnetworkMgr

setMultiLayerSubnetworkMgr

public void setMultiLayerSubnetworkMgr(java.lang.String multiLayerSubnetworkMgr)

Sets multiLayerSubnetworkMgr

Parameters:

multiLayerSubnetworkMgr - multiLayerSubnetworkMgr

isNsUseNameService

public boolean isNsUseNameService()

Gets nsUseNameService

Returns:

nsUseNameService

setNsUseNameService

public void setNsUseNameService(boolean nsUseNameService)

Sets nsUseNameService

Parameters:

nsUseNameService - nsUseNameService

isEsfUseNameService

public boolean isEsfUseNameService()

Gets esfUseNameService

Returns:

esfUseNameService

setEsfUseNameService

public void setEsfUseNameService(boolean esfUseNameService)

Sets esfUseNameService

Parameters:

esfUseNameService - esfUseNameService

getIntResultSize

public int getIntResultSize()

Gets intResultSize

Returns:

the intResultSize

setIntResultSize

public void setIntResultSize(int intResultSize)

Sets intResultSize

Parameters:

intResultSize - the intResultSize to set

isBlnDestroyIterator

public boolean isBlnDestroyIterator()

Gets blnDestroyIterator

Returns:

the blnDestroyIterator

setBlnDestroyIterator

public void setBlnDestroyIterator(boolean blnDestroyIterator)

Sets blnDestroyIterator

Parameters:

blnDestroyIterator - the blnDestroyIterator to set