org.jactr.tools.async.common
Class MINAEndpoint

java.lang.Object
  extended by org.jactr.tools.async.common.MINAEndpoint
All Implemented Interfaces:
org.jactr.core.utils.parameter.IParameterized
Direct Known Subclasses:
IterativeRunTracker, NetworkedIterativeRunListener, RemoteInterface, ShadowController

public abstract class MINAEndpoint
extends java.lang.Object
implements org.jactr.core.utils.parameter.IParameterized

Both RemoteInterface and ShadowControll rely on this common substrate that deals with all the networking

Author:
developer

Field Summary
static java.lang.String ADDRESS
           
static java.lang.String CRED_CLASS
           
static java.lang.String CREDENTAILS
           
static java.lang.String PROTOCOL_CLASS
           
static java.lang.String SERVICE_CLASS
           
static java.lang.String TRANSPORT_CLASS
           
 
Constructor Summary
MINAEndpoint()
           
 
Method Summary
 java.net.SocketAddress getActualAddress()
          return the socket address that we are actually connected to
 ICredentials getActualCredentials()
          return the actual credentials that we are using
 java.util.concurrent.ExecutorService getExecutorService()
          return the executor service that mina is relying upon
abstract  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()
           
 java.util.Collection<java.lang.String> getSetableParameters()
           
 void setAddressInfo(java.lang.String addressInfo)
          set the string version of the address, if the transport has already been provided, the acutal address will be recomputed
 ICredentials setCredentialInformation(java.lang.String credentialInfo)
          set the connection credentials
 void setCredentialsClass(java.lang.Class<? extends ICredentials> credClass)
           
 void setExecutorService(java.util.concurrent.ExecutorService service)
          set the executor for use by MINA
 void setParameter(java.lang.String key, java.lang.String value)
           
 void setProtocol(org.commonreality.mina.protocol.IMINAProtocolConfiguration protocol)
          set our protocol
 void setService(org.commonreality.mina.service.IMINAService service)
          set the service for this end point (typically ClientServie or ServerService)
 void setTransportProvider(org.commonreality.mina.transport.IMINATransportProvider provider)
          set the provider and possibly update the address information
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TRANSPORT_CLASS

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

PROTOCOL_CLASS

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

ADDRESS

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

SERVICE_CLASS

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

CREDENTAILS

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

CRED_CLASS

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

MINAEndpoint

public MINAEndpoint()
Method Detail

getIOHandler

public abstract BaseIOHandler getIOHandler()
return the io handler that handles all the communications

Returns:

setExecutorService

public void setExecutorService(java.util.concurrent.ExecutorService service)
set the executor for use by MINA

Parameters:
service -

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()
return the executor service that mina is relying upon


setTransportProvider

public void setTransportProvider(org.commonreality.mina.transport.IMINATransportProvider provider)
set the provider and possibly update the address information

Parameters:
provider -

setService

public void setService(org.commonreality.mina.service.IMINAService service)
set the service for this end point (typically ClientServie or ServerService)

Parameters:
service -

setProtocol

public void setProtocol(org.commonreality.mina.protocol.IMINAProtocolConfiguration protocol)
set our protocol

Parameters:
protocol -

setAddressInfo

public void setAddressInfo(java.lang.String addressInfo)
set the string version of the address, if the transport has already been provided, the acutal address will be recomputed

Parameters:
addressInfo -

setCredentialInformation

public ICredentials setCredentialInformation(java.lang.String credentialInfo)
set the connection credentials

Parameters:
credentialInfo -

setCredentialsClass

public void setCredentialsClass(java.lang.Class<? extends ICredentials> credClass)
Parameters:
credClass -

getActualCredentials

public ICredentials getActualCredentials()
return the actual credentials that we are using

Returns:

getActualAddress

public java.net.SocketAddress getActualAddress()
return the socket address that we are actually connected to

Returns:

getParameter

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

getPossibleParameters

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

getSetableParameters

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

setParameter

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