com.ecec.rweber.multispeak

Class MultiSpeakService

java.lang.Object

com.ecec.rweber.multispeak.MultiSpeakService

public class MultiSpeakService
extends Object

This is an abstract class representing a service endpoint such as MR (meter reading), OA (outage managment), etc. To interact in a meaningful way with any MultiSpeak endpoint this class should be extended and specific methods implemented per vendor implementations of each Multispeak Service. This class can be created standalone with the call() method being used to pass method names as String objects.

Author:

rweber

Field Summary

Fields

Modifier and Type	Field and Description
protected MultiSpeakClient	m_client
protected org.apache.log4j.Logger	m_log

Constructor Summary

Constructors

Constructor and Description
MultiSpeakService(MultiSpeakEndpoint endpoint)

Method Summary

Modifier and Type	Method and Description
MultiSpeakResult	call(String method) This is a convenience method for Multispeak calls with no parameters
MultiSpeakResult	call(String method, String[] params) Call a Multispeak method with the given parameters.
MultiSpeakResult	getLastResult()
List<String>	getMethods() All MultiSpeak Endpoints should implement this
boolean	ping() All MultiSpeak Endpoints should implement this

Methods inherited from class java.lang.Object

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

Field Detail

m_log

protected org.apache.log4j.Logger m_log

m_client

protected MultiSpeakClient m_client

Constructor Detail

MultiSpeakService

public MultiSpeakService(MultiSpeakEndpoint endpoint)

Parameters:

endpoint - a valid MultiSpeakEndpoint - connection information

Method Detail

getLastResult

public MultiSpeakResult getLastResult()

getMethods

public List<String> getMethods()

All MultiSpeak Endpoints should implement this

Returns:

List of methods accepted by this server

ping

public boolean ping()

All MultiSpeak Endpoints should implement this

Returns:

true/false if the ping was successful

call

public MultiSpeakResult call(String method)

This is a convenience method for Multispeak calls with no parameters

Parameters:

method - the method to send to the MultiSpeak Service

Returns:

the result element with the SOAP envelope stripped off

call

public MultiSpeakResult call(String method,
                             String[] params)

Call a Multispeak method with the given parameters. Results are returned as an XML element of the payload

Parameters:

method - the method to send to the MultiSpeak Service

params - any parameters to pass, can be null

Returns:

the result element with the SOAP envelope stripped off - can be NULL