org.dmd.mvw.client.mvwcomms.extended

Class CommsController

java.lang.Object

org.dmd.mvw.client.mvwcomms.generated.mvw.controllers.CommsControllerBaseImpl

org.dmd.mvw.client.mvwcomms.extended.CommsController

All Implemented Interfaces:

CommsControllerIF, ResponseHandlerIF

public class CommsController
extends CommsControllerBaseImpl
implements CommsControllerIF

The CommsController provides standardized access to the Dark Matter Protocol connection to the server.

Field Summary

Fields inherited from class org.dmd.mvw.client.mvwcomms.generated.mvw.controllers.CommsControllerBaseImpl

commsController, dmpConnection, eventBus, eventService

Constructor Summary

Constructors

Constructor and Description
CommsController(MvwRunContextIF rc)

Method Summary

Modifier and Type	Method and Description
org.dmd.dmp.shared.generated.dmo.ActionCancelRequestDMO	getActionCancelRequest() This method returns a new action cancel request that has its request ID and session initialized.
org.dmd.dmp.shared.generated.dmo.ActionRequestDMO	getActionRequest(org.dmd.dms.extended.ActionTriggerInfo ati) This method returns a new action request that has its request ID, session and action name initialized.
org.dmd.dmp.shared.generated.dmo.CreateRequestDMO	getCreateRequest()
org.dmd.dmp.shared.generated.dmo.DeleteRequestDMO	getDeleteRequest()
org.dmd.dmp.shared.generated.dmo.GetRequestDMO	getGetRequest()
long	getLastRequestTime()
org.dmd.dmp.shared.generated.dmo.LoginRequestDMO	getLoginRequest()
org.dmd.dmp.shared.generated.dmo.LogoutRequestDMO	getLogoutRequest()
protected org.dmd.dmp.shared.generated.dmo.ActionRequestDMO	getPrimeEventChannelRequest(org.dmd.dms.extended.ActionTriggerInfo ati)
org.dmd.dmp.shared.generated.dmo.SetRequestDMO	getSetRequest()
void	handleFailure(ResponseCallback cb, Throwable caught)
protected void	handlePrimeEventChannelResponse(org.dmd.dmp.shared.generated.dmo.ActionResponseDMO response)
protected void	handlePrimeEventChannelResponseError(org.dmd.dmp.shared.generated.dmo.ActionResponseDMO response)
void	handleResponse(ResponseCallback cb, org.dmd.dmp.shared.generated.dmo.ResponseDMO response)
boolean	isCommsSessionReady()
boolean	isLoggedIn()
void	onForceCommsReset() Something has gone wrong from which the application can't recover, so all bets are off.
void	sendActionCancelRequest(org.dmd.dmp.shared.generated.dmo.ActionCancelRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
void	sendActionRequest(org.dmd.dmp.shared.generated.dmo.ActionRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
void	sendCreateRequest(org.dmd.dmp.shared.generated.dmo.CreateRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
void	sendDeleteRequest(org.dmd.dmp.shared.generated.dmo.DeleteRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp) Sends a delete request and associates the specified response handler.
void	sendGetRequest(org.dmd.dmp.shared.generated.dmo.GetRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
void	sendGetRequest(org.dmd.dmp.shared.generated.dmo.GetRequestDMO request, ResponseHandlerIF handler, EventHandlerIF eh, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
void	sendLoginRequest(org.dmd.dmp.shared.generated.dmo.LoginRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
void	sendLogoutRequest(org.dmd.dmp.shared.generated.dmo.LogoutRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
protected void	sendPrimeEventChannelRequest(org.dmd.dmp.shared.generated.dmo.ActionRequestDMO request)
void	sendSetRequest(org.dmd.dmp.shared.generated.dmo.SetRequestDMO request, ResponseHandlerIF handler, ErrorOptionsEnum rpc, ErrorOptionsEnum dmp)
void	setCentralEventHandler(CentralEventHandlerIF eh)
void	setControllerTracing(boolean f) Sets tracing of messages through the CommsController on/off.
void	setGlobalMessageTracking(boolean f) Sets a flag that will turn global message tracking on/off.
void	useCentralDMPErrorHandler(CentralDMPErrorHandlerIF handler)
void	useCentralRPCErrorHandler(CentralRPCErrorHandlerIF handler)

Methods inherited from class org.dmd.mvw.client.mvwcomms.generated.mvw.controllers.CommsControllerBaseImpl

fireCommsSessionFailed, fireCommsSessionReady, fireLoginCompleteEvent, fireLogoutCompleteEvent, handleResponse, handleRPCFailure

Methods inherited from class java.lang.Object

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

Constructor Detail

CommsController

public CommsController(MvwRunContextIF rc)

Method Detail

setControllerTracing

public void setControllerTracing(boolean f)

Sets tracing of messages through the CommsController on/off. The GWT logging level must be set to FINEST in order for the logs to be seen.

Parameters:

f - set to true if you want to see tracing of message handling through the controller.

setGlobalMessageTracking

public void setGlobalMessageTracking(boolean f)

Sets a flag that will turn global message tracking on/off.

Parameters:

f - set to true if you want all message handling tracking

setCentralEventHandler

public void setCentralEventHandler(CentralEventHandlerIF eh)

getLastRequestTime

public long getLastRequestTime()

Returns:

the time at which the last request was sent.

isLoggedIn

public boolean isLoggedIn()

Returns:

true if we've gone through the login process.

isCommsSessionReady

public boolean isCommsSessionReady()

Returns:

true if we've gone through the login process and primed the event channel.

getLoginRequest

public org.dmd.dmp.shared.generated.dmo.LoginRequestDMO getLoginRequest()

sendLoginRequest

public void sendLoginRequest(org.dmd.dmp.shared.generated.dmo.LoginRequestDMO request,
                             ResponseHandlerIF handler,
                             ErrorOptionsEnum rpc,
                             ErrorOptionsEnum dmp)

getLogoutRequest

public org.dmd.dmp.shared.generated.dmo.LogoutRequestDMO getLogoutRequest()

sendLogoutRequest

public void sendLogoutRequest(org.dmd.dmp.shared.generated.dmo.LogoutRequestDMO request,
                              ResponseHandlerIF handler,
                              ErrorOptionsEnum rpc,
                              ErrorOptionsEnum dmp)

getGetRequest

public org.dmd.dmp.shared.generated.dmo.GetRequestDMO getGetRequest()

sendGetRequest

public void sendGetRequest(org.dmd.dmp.shared.generated.dmo.GetRequestDMO request,
                           ResponseHandlerIF handler,
                           ErrorOptionsEnum rpc,
                           ErrorOptionsEnum dmp)

sendGetRequest

public void sendGetRequest(org.dmd.dmp.shared.generated.dmo.GetRequestDMO request,
                           ResponseHandlerIF handler,
                           EventHandlerIF eh,
                           ErrorOptionsEnum rpc,
                           ErrorOptionsEnum dmp)

getSetRequest

public org.dmd.dmp.shared.generated.dmo.SetRequestDMO getSetRequest()

sendSetRequest

public void sendSetRequest(org.dmd.dmp.shared.generated.dmo.SetRequestDMO request,
                           ResponseHandlerIF handler,
                           ErrorOptionsEnum rpc,
                           ErrorOptionsEnum dmp)

getCreateRequest

public org.dmd.dmp.shared.generated.dmo.CreateRequestDMO getCreateRequest()

sendCreateRequest

public void sendCreateRequest(org.dmd.dmp.shared.generated.dmo.CreateRequestDMO request,
                              ResponseHandlerIF handler,
                              ErrorOptionsEnum rpc,
                              ErrorOptionsEnum dmp)

getDeleteRequest

public org.dmd.dmp.shared.generated.dmo.DeleteRequestDMO getDeleteRequest()

sendDeleteRequest

public void sendDeleteRequest(org.dmd.dmp.shared.generated.dmo.DeleteRequestDMO request,
                              ResponseHandlerIF handler,
                              ErrorOptionsEnum rpc,
                              ErrorOptionsEnum dmp)

Sends a delete request and associates the specified response handler. The request is stored in our outstanding requests collection based on its unique request ID. The callback associated with the request has a handle to the response handler and indicates how RPC and Dark Matter Protocol (DMP) errors are to be handled.

Parameters:

request - the request to be sent

handler - handle to entity that will handle the response

rpc - how RPC errors should be handled

dmp - hom DMP errors should be handled

getActionRequest

public org.dmd.dmp.shared.generated.dmo.ActionRequestDMO getActionRequest(org.dmd.dms.extended.ActionTriggerInfo ati)

This method returns a new action request that has its request ID, session and action name initialized. The action name is taken from the action trigger. The actionTrigger is also set on the ActionRequest

sendActionRequest

public void sendActionRequest(org.dmd.dmp.shared.generated.dmo.ActionRequestDMO request,
                              ResponseHandlerIF handler,
                              ErrorOptionsEnum rpc,
                              ErrorOptionsEnum dmp)

getActionCancelRequest

public org.dmd.dmp.shared.generated.dmo.ActionCancelRequestDMO getActionCancelRequest()

This method returns a new action cancel request that has its request ID and session initialized. The action to be cancelled is specified via the serverActionID attribute.

sendActionCancelRequest

public void sendActionCancelRequest(org.dmd.dmp.shared.generated.dmo.ActionCancelRequestDMO request,
                                    ResponseHandlerIF handler,
                                    ErrorOptionsEnum rpc,
                                    ErrorOptionsEnum dmp)

handleFailure

public void handleFailure(ResponseCallback cb,
                          Throwable caught)

Specified by:

handleFailure in interface CommsControllerIF

handleResponse

public void handleResponse(ResponseCallback cb,
                           org.dmd.dmp.shared.generated.dmo.ResponseDMO response)

Specified by:

handleResponse in interface CommsControllerIF

useCentralDMPErrorHandler

public void useCentralDMPErrorHandler(CentralDMPErrorHandlerIF handler)

Specified by:

useCentralDMPErrorHandler in interface CommsControllerIF

useCentralRPCErrorHandler

public void useCentralRPCErrorHandler(CentralRPCErrorHandlerIF handler)

Specified by:

useCentralRPCErrorHandler in interface CommsControllerIF

handlePrimeEventChannelResponseError

protected void handlePrimeEventChannelResponseError(org.dmd.dmp.shared.generated.dmo.ActionResponseDMO response)

Specified by:

handlePrimeEventChannelResponseError in class CommsControllerBaseImpl

handlePrimeEventChannelResponse

protected void handlePrimeEventChannelResponse(org.dmd.dmp.shared.generated.dmo.ActionResponseDMO response)

Specified by:

handlePrimeEventChannelResponse in class CommsControllerBaseImpl

getPrimeEventChannelRequest

protected org.dmd.dmp.shared.generated.dmo.ActionRequestDMO getPrimeEventChannelRequest(org.dmd.dms.extended.ActionTriggerInfo ati)

Overrides:

getPrimeEventChannelRequest in class CommsControllerBaseImpl

sendPrimeEventChannelRequest

protected void sendPrimeEventChannelRequest(org.dmd.dmp.shared.generated.dmo.ActionRequestDMO request)

Overrides:

sendPrimeEventChannelRequest in class CommsControllerBaseImpl

onForceCommsReset

public void onForceCommsReset()

Something has gone wrong from which the application can't recover, so all bets are off. This can happen in the case of RPC errors or when a logout fails and the application just wants to reset things to a known state.

Specified by:

onForceCommsReset in class CommsControllerBaseImpl