edu.wisc.trace.uch
Interface IUIPM

All Known Implementing Classes:

UrcHttpUIPM

public interface IUIPM

After getting information from ITDMListener regarding Discovery and Discarding of devices, UCH instantiates UIPM if it is not instantiated, if it is already instantiated then UCH informs UIPM about Discovery and Discarding of the devices. It forwards relative call from UCH to ITA and get desired response and forwards to UCH for further process.

Version:

$Revision: 1.11 $

Author:

Parikshit Thakur & Team, Trace R&D Center

Method Summary

void	controllerRequest(HttpServletRequest request, HttpServletResponse response) The UCH calls this function if it has received a request from a controller to a URI that the UIPM has claimed for itself by a previous call to startUriService().It call desired methods of IUIPMListener and make changes to response object.
void	finalize() The UCH should call finalize() before it uninstalls or unloads the UIPM.
Map<String,String>	getUIPMProps() Returns Properties of UIPM.
void	init(IUIPMListener uipmListener, Map<String,String> uipmProps, Map<String,String> uchProps) When the UIPM is installed and loaded, the UCH calls this method prior to any other UIPM function and allows the UIPM to initialize itself.
boolean	isImplemented(String functionName) Return whether specified function is implemented or not.
void	sessionAborted(String sessionId) The target has terminated a session.
void	sessionForwardRequest(String sessionId, Map<String,String> forwardInfo) The target requests the UIPM to open a session with a different socket.
void	targetDiscarded(String targetId) This function is called from UCH when a target has been discarded after initialization of the UIPM.
void	targetDiscovered(String targetId) This function is called from UCH when a new target has been discovered after initialization of the UIPM.
void	updateValues(List<String> sessionIds, List<String> paths, List<String> operations, List<String> values, List<Boolean> hasDynRes) The target’s status has changed, affecting one or more sessions.

Method Detail

init

void init(IUIPMListener uipmListener,
          Map<String,String> uipmProps,
          Map<String,String> uchProps)
          throws UIPMFatalException

When the UIPM is installed and loaded, the UCH calls this method prior to any other UIPM function and allows the UIPM to initialize itself.

Parameters:

uipmListener - an Object of IUIPMListener

uipmProps - a Map<String, String> of IUIPM Properties

uchProps - a Map<String, String> of UCH Properties

Throws:

UIPMFatalException

finalize

void finalize()

The UCH should call finalize() before it uninstalls or unloads the UIPM.

getUIPMProps

Map<String,String> getUIPMProps()

Returns Properties of UIPM.

Returns:

Map<String, String>

targetDiscovered

void targetDiscovered(String targetId)
                      throws UIPMFatalException

This function is called from UCH when a new target has been discovered after initialization of the UIPM.

Parameters:

targetId - a String value of targetId

Throws:

UIPMFatalException

targetDiscarded

void targetDiscarded(String targetId)
                     throws UIPMFatalException

This function is called from UCH when a target has been discarded after initialization of the UIPM.

Parameters:

targetId - a String value of targetId

Throws:

UIPMFatalException

sessionForwardRequest

void sessionForwardRequest(String sessionId,
                           Map<String,String> forwardInfo)
                           throws UIPMFatalException

The target requests the UIPM to open a session with a different socket.

Parameters:

sessionId - a String value of sessionId

forwardInfo - a Map<String, String> value

Throws:

UIPMFatalException

sessionAborted

void sessionAborted(String sessionId)
                    throws UIPMFatalException

The target has terminated a session.

Parameters:

sessionId - a String value of sessionId

Throws:

UIPMFatalException

updateValues

void updateValues(List<String> sessionIds,
                  List<String> paths,
                  List<String> operations,
                  List<String> values,
                  List<Boolean> hasDynRes)
                  throws UIPMFatalException

The target’s status has changed, affecting one or more sessions.

Parameters:

sessionIds - a List<String> of sessionIds

paths - a List<String> of paths

operations - a List<String> of operations

values - a List<String> of values

hasDynRes - a List<Boolean> of hadDynRes

Throws:

UIPMFatalException

isImplemented

boolean isImplemented(String functionName)

Return whether specified function is implemented or not.

Parameters:

functionName - a String value of function Name

Returns:

whether the function is implemented or not

controllerRequest

void controllerRequest(HttpServletRequest request,
                       HttpServletResponse response)

The UCH calls this function if it has received a request from a controller to a URI that the UIPM has claimed for itself by a previous call to startUriService().It call desired methods of IUIPMListener and make changes to response object.

Parameters:

request - an Object of HttpServletRequest

response - an Object of HttpServletResponse