MINAEndpoint

java.lang.Object
- org.jactr.tools.async.common.MINAEndpoint

All Implemented Interfaces:

IParameterized

Direct Known Subclasses:

IterativeRunTracker, NetworkedIterativeRunListener, RemoteInterface, ShadowController
```
public abstract class MINAEndpoint
extends java.lang.Object
implements IParameterized
```
Both RemoteInterface and ShadowControll rely on this common substrate that deals with all the networking

Author:

developer

Field Summary

Fields
Modifier and Type	Field and Description
`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

Constructors
Constructor and Description

MINAEndpoint()

Constructors
Constructor and Description
`MINAEndpoint()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`connect()`
`protected void`	`disconnect()` wait for all the pending writes
`protected void`	`disconnect(boolean force)` try to establish the connection
`java.net.SocketAddress`	`getActualAddress()` return the socket address that we are actually connected to
`ICredentials`	`getActualCredentials()` return the actual credentials that we are using
`protected java.lang.Class`	`getClass(java.lang.String className)` utility for the instantiation of mina parameters
`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)` return parameter value - null if not defined.
`java.util.Collection<java.lang.String>`	`getPossibleParameters()` Return all parameters that can be read
`java.util.Collection<java.lang.String>`	`getSetableParameters()` Return list of all parameters that can be set.
`protected java.lang.Object`	`instance(java.lang.String className)` utility for the instantiation of mina parameters
`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)` Set the named parameter
`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
clone, equals, finalize, 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:
  - connect
```
protected void connect()
                throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - disconnect
```
protected void disconnect()
                   throws java.lang.Exception
```
    wait for all the pending writes
    
    Throws:
    
    java.lang.Exception
  - disconnect
```
protected void disconnect(boolean force)
                   throws java.lang.Exception
```
    try to establish the connection
    
    Throws:
    
    java.lang.Exception
  - getParameter
```
public java.lang.String getParameter(java.lang.String key)
```
    Description copied from interface: IParameterized
    
    return parameter value - null if not defined.
    
    Specified by:
    
    getParameter in interface IParameterized
    
    Parameters:
    
    key - Description of the Parameter
    
    Returns:
    
    The parameter value
    
    See Also:
    
    IParameterized.getParameter(java.lang.String)
  - getPossibleParameters
```
public java.util.Collection<java.lang.String> getPossibleParameters()
```
    Description copied from interface: IParameterized
    
    Return all parameters that can be read
    
    Specified by:
    
    getPossibleParameters in interface IParameterized
    
    Returns:
    
    The possibleParameters value
    
    See Also:
    
    IParameterized.getPossibleParameters()
  - getSetableParameters
```
public java.util.Collection<java.lang.String> getSetableParameters()
```
    Description copied from interface: IParameterized
    
    Return list of all parameters that can be set.
    
    Specified by:
    
    getSetableParameters in interface IParameterized
    
    Returns:
    
    The setableParameters value
    
    See Also:
    
    IParameterized.getSetableParameters()
  - setParameter
```
public void setParameter(java.lang.String key,
                         java.lang.String value)
```
    Description copied from interface: IParameterized
    
    Set the named parameter
    
    Specified by:
    
    setParameter in interface IParameterized
    
    See Also:
    
    IParameterized.setParameter(java.lang.String, java.lang.String)
  - getClass
```
protected java.lang.Class getClass(java.lang.String className)
```
    utility for the instantiation of mina parameters
    
    Parameters:
    
    className -
    
    Returns:
  - instance
```
protected java.lang.Object instance(java.lang.String className)
```
    utility for the instantiation of mina parameters
    
    Parameters:
    
    className -
    
    Returns:

Class MINAEndpoint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRANSPORT_CLASS

PROTOCOL_CLASS

ADDRESS

SERVICE_CLASS

CREDENTAILS

CRED_CLASS

Constructor Detail

MINAEndpoint

Method Detail

getIOHandler

setExecutorService

getExecutorService

setTransportProvider

setService

setProtocol

setAddressInfo

setCredentialInformation

setCredentialsClass

getActualCredentials

getActualAddress

connect

disconnect

disconnect

getParameter

getPossibleParameters

getSetableParameters

setParameter

getClass

instance