Package org.opennms.protocols.wmi

Class WmiManager

java.lang.Object

org.opennms.protocols.wmi.WmiManager

public class WmiManager
extends Object

This provides an easy abtraction of the WmiClient functionality. It allows programmers to make simple WMI Class + WMI Object queries and then measure the resulting values against parameters. The purpose of the WMI Manager is to provide poller-style functionality where low-level access to WBEM objects and methods is not essential.

Author:

Matt Raykowski, OpenNMS

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_SOCKET_TIMEOUT	The default socket timeout.

Constructor Summary

Constructors

Constructor	Description
WmiManager(String host, String user, String pass)	Constructor.
WmiManager(String host, String user, String pass, String domain)	Constructor.
WmiManager(String host, String user, String pass, String domain, String matchType)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	close
String	getHostName()	Returns the host name being used to connect to the remote service.
String	getMatchType()	getMatchType
String	getNamespace()	getNamespace
int	getTimeout()	Returns the TCP socket timeout used when connecting to the remote service.
void	init()	This creates a new WmiClient and creates a connection to the host.
void	init(IWmiClient client)	This is for tests to harness and create a mock client.
static boolean	isValidMatchType(String matchType)	isValidMatchType
static boolean	isValidOpType(String opType)	isValidOpType
WmiResult	performExecQuery(WmiParams params)	performExecQuery
WmiResult	performInstanceOf(WmiParams params)	performInstanceOf
WmiResult	performOp(WmiParams params)	performOp
void	setHostName(String host)	This method is used to set the host name to connect to for performing remote service checks.
void	setMatchType(String matchType)	setMatchType
void	setNamespace(String namespace)	setNamespace
void	setPassword(String pass)	This method is used for setting the password used to perform service checks.
void	setTimeout(int timeout)	This method is used to set the TCP socket timeout to be used when connecting to the remote service.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SOCKET_TIMEOUT

public static int DEFAULT_SOCKET_TIMEOUT

The default socket timeout.

Constructor Detail

WmiManager

public WmiManager(String host,
                  String user,
                  String pass)

Constructor.

Parameters:

host - sets the host name to connect to.

user - sets the username to connect with

pass - sets the password to connect with.

WmiManager

public WmiManager(String host,
                  String user,
                  String pass,
                  String domain)

Constructor.

Parameters:

host - sets the host name to connect to.

user - sets the username to connect with

pass - sets the password to connect with.

domain - sets the domain to connect to.

WmiManager

public WmiManager(String host,
                  String user,
                  String pass,
                  String domain,
                  String matchType)

Constructor.

Parameters:

host - sets the host name to connect to.

user - sets the username to connect with

pass - sets the password to connect with.

domain - sets the domain to connect to.

matchType - the type of matching to be used for multiple results: all, none, some, one.

Method Detail

setPassword

public void setPassword(String pass)

This method is used for setting the password used to perform service checks.

Parameters:

pass - the password to use when performing service checks.

setHostName

public void setHostName(String host)

This method is used to set the host name to connect to for performing remote service checks. This method must be called before calling the init() method or it will have no effect.

Parameters:

host - the host name to connect to.

See Also:

init()

getHostName

public String getHostName()

Returns the host name being used to connect to the remote service.

Returns:

the host name being used to connect to the remote service.

setTimeout

public void setTimeout(int timeout)

This method is used to set the TCP socket timeout to be used when connecting to the remote service. This must be called before calling init or it will have no effect.

Parameters:

timeout - the TCP socket timeout.

getTimeout

public int getTimeout()

Returns the TCP socket timeout used when connecting to the remote service.

Returns:

the tcp socket timeout.

isValidMatchType

public static boolean isValidMatchType(String matchType)

isValidMatchType

Parameters:

matchType - a String object.

Returns:

a boolean.

isValidOpType

public static boolean isValidOpType(String opType)

isValidOpType

Parameters:

opType - a String object.

Returns:

a boolean.

init

public void init()
          throws WmiException

This creates a new WmiClient and creates a connection to the host.

Throws:

WmiException - An exception will be thrown if the system is unable to look up the host and if J-Interop throws an exception this will re-throw that exception so that implementors need not know J-Interop exceptions.

init

public void init(IWmiClient client)
          throws WmiException

This is for tests to harness and create a mock client. Do not use!

Parameters:

client - allows a IWmiClient to be pre-instantiated. Used for mock testing.

Throws:

WmiException - is thrown if there are any problems connecting.

close

public void close()
           throws WmiException

close

Throws:

WmiException - if any.

performOp

public WmiResult performOp(WmiParams params)
                    throws WmiException

performOp

Parameters:

params - a WmiParams object.

Returns:

a WmiResult object.

Throws:

WmiException - if any.

performExecQuery

public WmiResult performExecQuery(WmiParams params)
                           throws WmiException

performExecQuery

Parameters:

params - a WmiParams object.

Returns:

a WmiResult object.

Throws:

WmiException - if any.

performInstanceOf

public WmiResult performInstanceOf(WmiParams params)
                            throws WmiException

performInstanceOf

Parameters:

params - a WmiParams object.

Returns:

a WmiResult object.

Throws:

WmiException - if any.

getMatchType

public String getMatchType()

getMatchType

Returns:

the m_MatchType

setMatchType

public void setMatchType(String matchType)

setMatchType

Parameters:

matchType - the m_MatchType to set

getNamespace

public String getNamespace()

getNamespace

Returns:

the m_namespace

setNamespace

public void setNamespace(String namespace)

setNamespace

Parameters:

the - m_namespace to set