com.ibm.tivoli.nm.collectors.impl.alcatel5620sam

Class Alcatel5620SamConnectionManager

java.lang.Object

com.ibm.tivoli.nm.collectors.impl.alcatel5620sam.Alcatel5620SamConnectionManager

public class Alcatel5620SamConnectionManager
extends java.lang.Object

This class is responsible for establishing connection and communicating with the Alcatel 5620 SAM using SOAP.

Author:

Khalid Alqinyah

Constructor Summary

Constructors

Constructor and Description
Alcatel5620SamConnectionManager(Alcatel5620SamCollectorProperties collProps) Initialize the Alcatel5620SamConnectionManager and its dependencies

Method Summary

Modifier and Type	Method and Description
void	findToFile(java.lang.String fullClassName, java.lang.String fileName, ChildrenFilterHolder filter, ResultFilter resultFilter) Calls the EMS findToFile API method.
void	initializeConnection(java.lang.String host, java.lang.String port, java.lang.String username, java.lang.String password, boolean secure, boolean hashedPassword) Establishes a connection with the EMS and performs a ping to verify the link.
static void	setPassword(java.lang.String password)
void	setProperties(java.util.Properties props) Sets the properties file Properties
boolean	switchEMS()

Methods inherited from class java.lang.Object

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

Constructor Detail

Alcatel5620SamConnectionManager

public Alcatel5620SamConnectionManager(Alcatel5620SamCollectorProperties collProps)
                                throws SOAPException

Initialize the Alcatel5620SamConnectionManager and its dependencies

Parameters:

collProps - Alcatel5620SamCollectorProperties instance

Throws:

SOAPException - if any of the SOAP elements failed to initialize

Method Detail

switchEMS

public boolean switchEMS()

initializeConnection

public void initializeConnection(java.lang.String host,
                                 java.lang.String port,
                                 java.lang.String username,
                                 java.lang.String password,
                                 boolean secure,
                                 boolean hashedPassword)
                          throws SOAPException

Establishes a connection with the EMS and performs a ping to verify the link. Call this method once after creating the class.

Parameters:

host - The host address of the EMS

port - The port number of the EMS

username - The username to access the EMS

password - The password to access the EMS

secure - Whether to use a secure or a normal connection to the EMS. Default is false using normal http://

hashedPassword - Whether the password provided is hashed or plain text

Throws:

SOAPException - If connection to the EMS fails

javax.xml.bind.JAXBException - If marshalling from Java to XML fails

java.lang.IllegalArgumentException - If any of the required arguments are null or empty

findToFile

public void findToFile(java.lang.String fullClassName,
                       java.lang.String fileName,
                       ChildrenFilterHolder filter,
                       ResultFilter resultFilter)
                throws javax.xml.bind.JAXBException,
                       SOAPException

Calls the EMS findToFile API method.

Parameters:

fullClassName - The name of the class to retrieve from the EMS (e.g. netw.NetworkElement)

fileName - The full path of the location to save the file in the following form

ftp[s]://ftpUsername:ftpPassword@ftpHost/fileName

filter - To filter which objects to return from the EMS. null value will return all objects of the class

resultFilter - To filter the attributes of a returned object. null value will return all the attributes for the returned objects

Throws:

javax.xml.bind.JAXBException - If marshalling from Java to XML fails

SOAPException - If the SOAP response contains faults or exceptions

setProperties

public void setProperties(java.util.Properties props)

Sets the properties file Properties

Parameters:

props -

setPassword

public static void setPassword(java.lang.String password)