org.jactr.tools.async.controller
Class RemoteInterface

java.lang.Object
  extended by org.jactr.tools.async.common.MINAEndpoint
      extended by org.jactr.tools.async.controller.RemoteInterface
All Implemented Interfaces:
org.jactr.core.utils.IInitializable, org.jactr.core.utils.IInstallable, org.jactr.core.utils.parameter.IParameterized, org.jactr.instrument.IInstrument

public class RemoteInterface
extends MINAEndpoint
implements org.jactr.instrument.IInstrument, org.jactr.core.utils.parameter.IParameterized

An instrument that permits the remote control of a runtime. The remote interface sets up the connection and networking on the runtime side so that a ShadowController can issue commands and receive run events

Author:
developer

Field Summary
static java.lang.String EXECUTOR_PARAM
           
static java.lang.String SEND_MODEL_ON_SUSPEND_PARAM
           
 
Fields inherited from class org.jactr.tools.async.common.MINAEndpoint
ADDRESS, CRED_CLASS, CREDENTAILS, PROTOCOL_CLASS, SERVICE_CLASS, TRANSPORT_CLASS
 
Constructor Summary
RemoteInterface()
           
 
Method Summary
 void disconnectSafe(boolean force)
          safely disconnect asynchronously..
static RemoteInterface getActiveRemoteInterface()
           
 java.util.concurrent.Executor getExecutor()
           
 RemoteIOHandler getHandler()
           
 BaseIOHandler getIOHandler()
          return the io handler that handles all the communications
 java.lang.String getParameter(java.lang.String key)
           
 java.util.Collection<java.lang.String> getPossibleParameters()
           
 void initialize()
           
 void install(org.jactr.core.model.IModel model)
           
 void setExecutor(java.util.concurrent.Executor executor)
           
 void setParameter(java.lang.String key, java.lang.String value)
           
 void setSendOnSuspend(boolean send)
           
 void uninstall(org.jactr.core.model.IModel model)
           
 boolean willSendOnSuspend()
           
 
Methods inherited from class org.jactr.tools.async.common.MINAEndpoint
getActualAddress, getActualCredentials, getExecutorService, getSetableParameters, setAddressInfo, setCredentialInformation, setCredentialsClass, setExecutorService, setProtocol, setService, setTransportProvider
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jactr.core.utils.parameter.IParameterized
getSetableParameters
 

Field Detail

EXECUTOR_PARAM

public static final java.lang.String EXECUTOR_PARAM
See Also:
Constant Field Values

SEND_MODEL_ON_SUSPEND_PARAM

public static final java.lang.String SEND_MODEL_ON_SUSPEND_PARAM
See Also:
Constant Field Values
Constructor Detail

RemoteInterface

public RemoteInterface()
Method Detail

getActiveRemoteInterface

public static RemoteInterface getActiveRemoteInterface()

getHandler

public RemoteIOHandler getHandler()

getIOHandler

public BaseIOHandler getIOHandler()
Description copied from class: MINAEndpoint
return the io handler that handles all the communications

Specified by:
getIOHandler in class MINAEndpoint
Returns:

getExecutor

public java.util.concurrent.Executor getExecutor()

setExecutor

public void setExecutor(java.util.concurrent.Executor executor)

initialize

public void initialize()
Specified by:
initialize in interface org.jactr.core.utils.IInitializable
Specified by:
initialize in interface org.jactr.instrument.IInstrument
See Also:
IInstrument.initialize()

install

public void install(org.jactr.core.model.IModel model)
Specified by:
install in interface org.jactr.core.utils.IInstallable
Specified by:
install in interface org.jactr.instrument.IInstrument
See Also:
IInstrument.install(org.jactr.core.model.IModel)

uninstall

public void uninstall(org.jactr.core.model.IModel model)
Specified by:
uninstall in interface org.jactr.core.utils.IInstallable
Specified by:
uninstall in interface org.jactr.instrument.IInstrument
See Also:
IInstrument.uninstall(org.jactr.core.model.IModel)

disconnectSafe

public void disconnectSafe(boolean force)
safely disconnect asynchronously.. this queues up the disconnect on the background executor, allowing other processing that has already been queued to finish up


getPossibleParameters

public java.util.Collection<java.lang.String> getPossibleParameters()
Specified by:
getPossibleParameters in interface org.jactr.core.utils.parameter.IParameterized
Overrides:
getPossibleParameters in class MINAEndpoint
See Also:
IParameterized.getPossibleParameters()

getParameter

public java.lang.String getParameter(java.lang.String key)
Specified by:
getParameter in interface org.jactr.core.utils.parameter.IParameterized
Overrides:
getParameter in class MINAEndpoint
See Also:
IParameterized.getParameter(java.lang.String)

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)
Specified by:
setParameter in interface org.jactr.core.utils.parameter.IParameterized
Overrides:
setParameter in class MINAEndpoint
See Also:
IParameterized.setParameter(java.lang.String, java.lang.String)

willSendOnSuspend

public boolean willSendOnSuspend()

setSendOnSuspend

public void setSendOnSuspend(boolean send)