TransportI (MyTISM API Documentation)

All Known Implementing Classes:

SocketTransport
```
public interface TransportI
```

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String $0

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`$0`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`aboutToListen()` Sets this TransportI to a listening mode, which will not send any keep-alives nor enforce timeouts.
`void`	`aboutToSend()` Sets this TransportI to a sending mode, which will send keep-alives and enforce timeouts.
`void`	`authenticated(boolean b, int pid)` Sets the authenticated-state and the pid for this TransportI (after login).
`boolean`	`canReconnect()` Returns true, if this TransportI can reconnect.
`void`	`close()` Closes this TransportI, possibly raising an IO-Exception that may have been signalled during closing.
`void`	`closeLater()`
`void`	`closeNT()` Closes this TransportI silently.
`CryptoHandlerI`	`getCryptoHandler()` Retrieves a `CryptoHandlerI` object from the `BackendProtocolServer`.
`java.lang.String`	`getGateway(java.lang.String claddr, java.lang.String clport)` Returns a String representation of the gateway of this TransportI (if any).
`SecureObjectInputI`	`getIn()` Exposes the underlying SecureObjectInputI.
`int`	`getKeepAliveInterval()` Returns the current keep-alive interval of the underlying output or -1 if no keep-alive is possible or active there.
`java.lang.String`	`getLocalHostAddress()` Returns the host address for the local part of the connection.
`java.lang.String`	`getLocalPort()` Returns the port for the local part of the connection.
`java.lang.String`	`getName()` Returns an identifier for this TransportI.
`SecureObjectOutputI`	`getOut()` Exposes the underlying SecureObjectOutputI.
`int`	`getPid()` Returns the pid that was assigned by the server-side.
`java.lang.String`	`getServerEndpoint()` Returns a String representation of the server-endpoint of this TransportI.
`java.lang.String`	`getSubVersion()` Returns the protocol subversion, namely the additional parameters for the connection.
`int`	`getTimeout()` Returns the current connection-timeout or -1 if a TransportException occurred while getting that value.
`void`	`initServerSide(BackendCommandHandlerI commandHandler, BOLoaderI loader)` Initializes the protocol and the TransportI and creates input and output.
`boolean`	`isAuthenticated()` Returns true, if this TransportI is already associated with a session on the server.
`boolean`	`isClosed()` Returns true, if the underlying means of connection is closed, false otherwise.
`boolean`	`isLocalConnection()` Returns true if the connection comes and goes to the same interface
`boolean`	`isLoggedIn()` Returns true if the connection this TransportI is used in is in a logged-in state.
`boolean`	`isTotallyReliable()` Returns true if the connection doesn't need any keep-alive tests or similar monitoring
`void`	`readMagic()` Tries to read the defined protocol-magic from the input.
`void`	`readMagic(boolean updateLastUsed)` Tries to read the defined protocol-magic from the input.
`void`	`reset()` Resets the underlying output.
`int`	`setTimeout(int t)` Sets the timeout of the underlying transport to the specified amount, but at least to 1000ms.
`int`	`testConnection()` Sends a test-command to the server and waits for the expected answer.
`java.lang.String`	`toString()` Returns a readable description of this TransportI.

- Field Detail
  - $0
```
static final java.lang.String $0
```
    See Also:
    
    Constant Field Values
- Method Detail
  - reset
```
void reset()
    throws java.io.IOException
```
    Resets the underlying output.
    
    Throws:
    
    java.io.IOException
  - close
```
void close()
    throws java.io.IOException
```
    Closes this TransportI, possibly raising an IO-Exception that may have been signalled during closing.
    
    Throws:
    
    java.io.IOException
  - closeNT
```
void closeNT()
```
    Closes this TransportI silently.
  - initServerSide
```
void initServerSide(BackendCommandHandlerI commandHandler,
                    BOLoaderI loader)
             throws java.io.IOException,
                    TransportException,
                    IncompatibleProtocolException
```
    Initializes the protocol and the TransportI and creates input and output.
    
    Throws:
    
    java.io.IOException
    
    TransportException
    
    IncompatibleProtocolException
  - getName
```
java.lang.String getName()
```
    Returns an identifier for this TransportI.
  - getServerEndpoint
```
java.lang.String getServerEndpoint()
```
    Returns a String representation of the server-endpoint of this TransportI.
  - getGateway
```
java.lang.String getGateway(java.lang.String claddr,
                            java.lang.String clport)
```
    Returns a String representation of the gateway of this TransportI (if any).
  - isTotallyReliable
```
boolean isTotallyReliable()
```
    Returns true if the connection doesn't need any keep-alive tests or similar monitoring
  - isLocalConnection
```
boolean isLocalConnection()
```
    Returns true if the connection comes and goes to the same interface
  - isClosed
```
boolean isClosed()
```
    Returns true, if the underlying means of connection is closed, false otherwise.
  - closeLater
```
void closeLater()
```
  - isAuthenticated
```
boolean isAuthenticated()
```
    Returns true, if this TransportI is already associated with a session on the server.
  - isLoggedIn
```
boolean isLoggedIn()
```
    Returns true if the connection this TransportI is used in is in a logged-in state.
  - canReconnect
```
boolean canReconnect()
```
    Returns true, if this TransportI can reconnect.
  - getIn
```
SecureObjectInputI getIn()
```
    Exposes the underlying SecureObjectInputI.
  - getOut
```
SecureObjectOutputI getOut()
```
    Exposes the underlying SecureObjectOutputI.
  - getPid
```
int getPid()
```
    Returns the pid that was assigned by the server-side.
  - toString
```
java.lang.String toString()
```
    Returns a readable description of this TransportI.
    
    Overrides:
    
    toString in class java.lang.Object
  - getTimeout
```
int getTimeout()
```
    Returns the current connection-timeout or -1 if a TransportException occurred while getting that value.
  - getKeepAliveInterval
```
int getKeepAliveInterval()
```
    Returns the current keep-alive interval of the underlying output or -1 if no keep-alive is possible or active there.
  - aboutToListen
```
void aboutToListen()
            throws TransportException
```
    Sets this TransportI to a listening mode, which will not send any keep-alives nor enforce timeouts.
    
    Throws:
    
    TransportException
  - aboutToSend
```
void aboutToSend()
          throws TransportException
```
    Sets this TransportI to a sending mode, which will send keep-alives and enforce timeouts.
    
    Throws:
    
    TransportException
  - setTimeout
```
int setTimeout(int t)
        throws TransportException
```
    Sets the timeout of the underlying transport to the specified amount, but at least to 1000ms. May signal a TransportException if the timeout cannot be set.
    
    Parameters:
    
    t - an int specifying the new timeout for this TransportI in milliseconds, 0 means no timeout
    
    Returns:
    
    old value
    
    Throws:
    
    TransportException
  - getSubVersion
```
java.lang.String getSubVersion()
```
    Returns the protocol subversion, namely the additional parameters for the connection.
  - getLocalHostAddress
```
java.lang.String getLocalHostAddress()
```
    Returns the host address for the local part of the connection.
  - getLocalPort
```
java.lang.String getLocalPort()
```
    Returns the port for the local part of the connection.
  - readMagic
```
void readMagic()
        throws java.io.IOException
```
    Tries to read the defined protocol-magic from the input. Signals an IO-Exception if any other value was read. Signals a de.ipcon.db.ServerConnectionException if a timeout occurred.
    
    Throws:
    
    java.io.IOException
  - readMagic
```
void readMagic(boolean updateLastUsed)
        throws java.io.IOException
```
    Tries to read the defined protocol-magic from the input. Signals an IO-Exception if any other value was read. Signals a de.ipcon.db.ServerConnectionException if a timeout occurred.
    
    Parameters:
    
    updateLastUsed - a boolean defining if the last-used-timestamp shall be updated upon reading the protocol-magic
    
    Throws:
    
    java.io.IOException
  - authenticated
```
void authenticated(boolean b,
                   int pid)
```
    Sets the authenticated-state and the pid for this TransportI (after login).
  - getCryptoHandler
```
CryptoHandlerI getCryptoHandler()
                         throws ServerConnectionException
```
    Retrieves a CryptoHandlerI object from the BackendProtocolServer. Does not read a protocol-magic afterwards! May signal a de.ipcon.db.FatalServerConnectionException if anything else than a CryptoHandlerI was received from the server. In case of errors the transport is closed.
    
    Throws:
    
    ServerConnectionException
  - testConnection
```
int testConnection()
            throws ServerConnectionException
```
    Sends a test-command to the server and waits for the expected answer.
    
    Returns:
    
    an int specifying the protocol-version expected and used by the server May signal a ServerConnectionException if an IO-excpetion occurred while trying to read the answer (e.g. socket-timeout).
    
    Throws:
    
    ServerConnectionException

Interface TransportI

Field Summary

Method Summary

Field Detail

$0

Method Detail

reset

close

closeNT

initServerSide

getName

getServerEndpoint

getGateway

isTotallyReliable

isLocalConnection

isClosed

closeLater

isAuthenticated

isLoggedIn

canReconnect

getIn

getOut

getPid

toString

getTimeout

getKeepAliveInterval

aboutToListen

aboutToSend

setTimeout

getSubVersion

getLocalHostAddress

getLocalPort

readMagic

readMagic

authenticated

getCryptoHandler

testConnection