SAMv1Handler (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.sam.SAMHandler
- - net.i2p.sam.SAMv1Handler

All Implemented Interfaces:
Runnable, Handler, SAMDatagramReceiver, SAMRawReceiver, SAMStreamReceiver
Direct Known Subclasses:
SAMv2Handler, SAMv3Handler
```
class SAMv1Handler
extends SAMHandler
implements SAMRawReceiver, SAMDatagramReceiver, SAMStreamReceiver
```
Class able to handle a SAM version 1 client connections.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`_id` _id.
`protected SAMMessageSess`	`datagramSession` datagramSession.
`protected SAMMessageSess`	`rawSession` rawSession.
`protected static String`	`SESSION_ERROR` SESSION_ERROR.
`protected SAMStreamSession`	`streamSession` streamSession.

Fields inherited from class net.i2p.sam.SAMHandler
_log, bridge, i2cpProps, socket, stopHandler, stopLock, thread, verMajor, verMinor

Constructor Summary

Constructors
Constructor and Description
`SAMv1Handler(SocketChannel s, int verMajor, int verMinor, Properties i2cpProps, SAMBridge parent)` Create a new SAM version 1 handler.
`SAMv1Handler(SocketChannel s, int verMajor, int verMinor, SAMBridge parent)` Create a new SAM version 1 handler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static String`	`createMessageString(String msg)` Create a string to be appended to a status.
`protected boolean`	`execDatagramMessage(String opcode, Properties props)` Parse and execute a DATAGRAM message.
`protected boolean`	`execDestMessage(String opcode, Properties props)` Parse and execute a DEST message.
`protected boolean`	`execNamingMessage(String opcode, Properties props)` Parse and execute a NAMING message.
`protected boolean`	`execRawMessage(String opcode, Properties props)` Parse and execute a RAW message.
`protected boolean`	`execSessionMessage(String opcode, Properties props)` Parse and execute a SESSION message.
`protected boolean`	`execStreamClose(Properties props)` Parse and execute a STREAM CLOSE message.
`protected boolean`	`execStreamConnect(Properties props)` Parse and execute a STREAM CONNECT message.
`protected boolean`	`execStreamMessage(String opcode, Properties props)` Parse and execute a STREAM message.
`protected boolean`	`execStreamSend(Properties props)` Parse and execute a STREAM SEND message.
`protected SAMMessageSess`	`getDatagramSession()`
`protected SAMMessageSess`	`getRawSession()`
`protected SAMStreamSession`	`getStreamSession()`
`void`	`handle()` Handle a SAM v1 client connection by reading and dispatching commands in a loop until the connection is closed or an error occurs.
`void`	`notifyStreamDisconnection(int id, String result, String msg)` Notify the SAM client that a stream connection has been disconnected.
`void`	`notifyStreamIncomingConnection(int id, Destination d)` Notify the SAM client of an incoming stream connection.
`void`	`notifyStreamOutgoingConnection(int id, String result, String msg)` Notify about a new outgoing connection
`void`	`notifyStreamSendBufferFree(int id)` Notify the SAM client that the stream send buffer is free for more data.
`void`	`receiveDatagramBytes(Destination sender, byte[] data, int proto, int fromPort, int toPort)` Receive datagram bytes from the network and forward them to the SAM client.
`void`	`receiveRawBytes(byte[] data, int proto, int fromPort, int toPort)` Receive raw bytes from the network and forward them to the SAM client.
`void`	`receiveStreamBytes(int id, ByteBuffer data)` Receive stream bytes from the network and forward them to the SAM client.
`void`	`stopDatagramReceiving()` Stop receiving datagram bytes and close the client socket.
`void`	`stopRawReceiving()` Stop receiving raw bytes and close the client socket.
`void`	`stopStreamReceiving()` Stop receiving stream bytes and close the client socket.
`void`	`streamSendAnswer(int id, String result, String bufferState)` Notify the SAM client of the result of a stream SEND operation.
`boolean`	`verifVersion()` Verify the SAM protocol version is supported by this handler.
`protected boolean`	`writeString(String s, String msg)` Write a string and message, escaping the message.

Methods inherited from class net.i2p.sam.SAMHandler
closeClientSocket, getClientSocket, getWriteLock, run, shouldStop, startHandling, stopHandling, toString, writeBytes, writeString, writeString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - _id
```
protected final long _id
```
    _id.
  - datagramSession
```
protected SAMMessageSess datagramSession
```
    datagramSession.
  - rawSession
```
protected SAMMessageSess rawSession
```
    rawSession.
  - SESSION_ERROR
```
protected static final String SESSION_ERROR
```
    SESSION_ERROR.
    See Also:
    Constant Field Values
  - streamSession
```
protected SAMStreamSession streamSession
```
    streamSession.
- Constructor Detail
  - SAMv1Handler
```
public SAMv1Handler(SocketChannel s,
                    int verMajor,
                    int verMinor,
                    Properties i2cpProps,
                    SAMBridge parent)
             throws SAMException,
                    IOException
```
    Create a new SAM version 1 handler. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
    Parameters:
    s - Socket attached to a SAM client
    verMajor - SAM major version to manage (should be 1)
    verMinor - SAM minor version to manage
    i2cpProps - properties to configure the I2CP connection (host, port, etc)
    parent - the SAM bridge managing this handler
    Throws:
    SAMException - if the version is not supported
    IOException - if an I/O error occurs
  - SAMv1Handler
```
public SAMv1Handler(SocketChannel s,
                    int verMajor,
                    int verMinor,
                    SAMBridge parent)
             throws SAMException,
                    IOException
```
    Create a new SAM version 1 handler. This constructor expects that the SAM HELLO message has been still answered (and stripped) from the socket input stream.
    Parameters:
    s - Socket attached to a SAM client
    verMajor - SAM major version to manage (should be 1)
    verMinor - SAM minor version to manage
    parent - the SAM bridge managing this handler
    Throws:
    SAMException - if the version is not supported
    IOException - if an I/O error occurs
- Method Detail
  - createMessageString
```
protected static String createMessageString(String msg)
```
    Create a string to be appended to a status.
    Parameters:
    msg - may be null
    Returns:
    non-null, "" if msg is null, MESSAGE=msg or MESSAGE="msg a b c" with leading space if msg is non-null
  - execDatagramMessage
```
protected boolean execDatagramMessage(String opcode,
                                      Properties props)
```
    Parse and execute a DATAGRAM message.
    Parameters:
    opcode - the DATAGRAM sub-command (e.g. SEND)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execDestMessage
```
protected boolean execDestMessage(String opcode,
                                  Properties props)
```
    Parse and execute a DEST message.
    Parameters:
    opcode - the DEST sub-command (e.g. GENERATE)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execNamingMessage
```
protected boolean execNamingMessage(String opcode,
                                    Properties props)
```
    Parse and execute a NAMING message.
    Parameters:
    opcode - the NAMING sub-command (e.g. LOOKUP)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execRawMessage
```
protected boolean execRawMessage(String opcode,
                                 Properties props)
```
    Parse and execute a RAW message.
    Parameters:
    opcode - the RAW sub-command (e.g. SEND)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execSessionMessage
```
protected boolean execSessionMessage(String opcode,
                                     Properties props)
```
    Parse and execute a SESSION message.
    Parameters:
    opcode - the SESSION sub-command (e.g. CREATE)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execStreamClose
```
protected boolean execStreamClose(Properties props)
```
    Parse and execute a STREAM CLOSE message.
    Parameters:
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execStreamConnect
```
protected boolean execStreamConnect(Properties props)
```
    Parse and execute a STREAM CONNECT message.
    Parameters:
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execStreamMessage
```
protected boolean execStreamMessage(String opcode,
                                    Properties props)
```
    Parse and execute a STREAM message.
    Parameters:
    opcode - the STREAM sub-command (e.g. SEND, CONNECT, CLOSE)
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - execStreamSend
```
protected boolean execStreamSend(Properties props)
```
    Parse and execute a STREAM SEND message.
    Parameters:
    props - the parsed message properties
    Returns:
    true if the handler should continue processing commands
  - getDatagramSession
```
protected final SAMMessageSess getDatagramSession()
```
    Returns:
    the datagram session
  - getRawSession
```
protected final SAMMessageSess getRawSession()
```
    Returns:
    the raw session
  - getStreamSession
```
protected final SAMStreamSession getStreamSession()
```
    Returns:
    the stream session
  - handle
```
public void handle()
```
    Handle a SAM v1 client connection by reading and dispatching commands in a loop until the connection is closed or an error occurs.
    Specified by:
    handle in class SAMHandler
  - notifyStreamDisconnection
```
public void notifyStreamDisconnection(int id,
                                      String result,
                                      String msg)
                               throws IOException
```
    Notify the SAM client that a stream connection has been disconnected.
    Specified by:
    notifyStreamDisconnection in interface SAMStreamReceiver
    Parameters:
    id - the stream connection ID
    result - the result code (e.g. OK, TIMEOUT)
    msg - optional message, may be null
    Throws:
    IOException - if writing to the client socket fails
  - notifyStreamIncomingConnection
```
public void notifyStreamIncomingConnection(int id,
                                           Destination d)
                                    throws IOException
```
    Notify the SAM client of an incoming stream connection.
    Specified by:
    notifyStreamIncomingConnection in interface SAMStreamReceiver
    Parameters:
    id - the stream connection ID
    d - the destination of the remote peer
    Throws:
    IOException - if writing to the client socket fails
  - notifyStreamOutgoingConnection
```
public void notifyStreamOutgoingConnection(int id,
                                           String result,
                                           String msg)
                                    throws IOException
```
    Description copied from interface: SAMStreamReceiver
    Notify about a new outgoing connection
    Specified by:
    notifyStreamOutgoingConnection in interface SAMStreamReceiver
    Parameters:
    msg - may be null
    id - New connection id
    result - message result
    Throws:
    IOException
  - notifyStreamSendBufferFree
```
public void notifyStreamSendBufferFree(int id)
                                throws IOException
```
    Notify the SAM client that the stream send buffer is free for more data.
    Specified by:
    notifyStreamSendBufferFree in interface SAMStreamReceiver
    Parameters:
    id - the stream connection ID
    Throws:
    IOException - if writing to the client socket fails
  - receiveDatagramBytes
```
public void receiveDatagramBytes(Destination sender,
                                 byte[] data,
                                 int proto,
                                 int fromPort,
                                 int toPort)
                          throws IOException
```
    Receive datagram bytes from the network and forward them to the SAM client.
    Specified by:
    receiveDatagramBytes in interface SAMDatagramReceiver
    Parameters:
    sender - the destination of the datagram sender
    data - the received datagram data
    proto - the protocol number
    fromPort - the source port
    toPort - the destination port
    Throws:
    IOException - if writing to the client socket fails
  - receiveRawBytes
```
public void receiveRawBytes(byte[] data,
                            int proto,
                            int fromPort,
                            int toPort)
                     throws IOException
```
    Receive raw bytes from the network and forward them to the SAM client.
    Specified by:
    receiveRawBytes in interface SAMRawReceiver
    Parameters:
    data - the received raw data
    proto - the protocol number
    fromPort - the source port
    toPort - the destination port
    Throws:
    IOException - if writing to the client socket fails
  - receiveStreamBytes
```
public void receiveStreamBytes(int id,
                               ByteBuffer data)
                        throws IOException
```
    Receive stream bytes from the network and forward them to the SAM client.
    Specified by:
    receiveStreamBytes in interface SAMStreamReceiver
    Parameters:
    id - the stream connection ID
    data - the received data
    Throws:
    IOException - if writing to the client socket fails
  - stopDatagramReceiving
```
public void stopDatagramReceiving()
```
    Stop receiving datagram bytes and close the client socket.
    Specified by:
    stopDatagramReceiving in interface SAMDatagramReceiver
  - stopRawReceiving
```
public void stopRawReceiving()
```
    Stop receiving raw bytes and close the client socket.
    Specified by:
    stopRawReceiving in interface SAMRawReceiver
  - stopStreamReceiving
```
public void stopStreamReceiving()
```
    Stop receiving stream bytes and close the client socket.
    Specified by:
    stopStreamReceiving in interface SAMStreamReceiver
  - streamSendAnswer
```
public void streamSendAnswer(int id,
                             String result,
                             String bufferState)
                      throws IOException
```
    Notify the SAM client of the result of a stream SEND operation.
    Specified by:
    streamSendAnswer in interface SAMStreamReceiver
    Parameters:
    id - the stream connection ID
    result - the result code (e.g. OK, TIMEOUT)
    bufferState - the current buffer state
    Throws:
    IOException - if writing to the client socket fails
  - verifVersion
```
public boolean verifVersion()
```
    Verify the SAM protocol version is supported by this handler.
    Returns:
    true if the major version matches this handler's version
  - writeString
```
protected boolean writeString(String s,
                              String msg)
```
    Write a string and message, escaping the message. Writes s + createMessageString(msg) + \n
    Parameters:
    s - The string, non-null

Class SAMv1Handler

Field Summary

Fields inherited from class net.i2p.sam.SAMHandler

Constructor Summary

Method Summary

Methods inherited from class net.i2p.sam.SAMHandler

Methods inherited from class java.lang.Object

Field Detail

_id

datagramSession

rawSession

SESSION_ERROR

streamSession

Constructor Detail

SAMv1Handler

SAMv1Handler

Method Detail

createMessageString

execDatagramMessage

execDestMessage

execNamingMessage

execRawMessage

execSessionMessage

execStreamClose

execStreamConnect

execStreamMessage

execStreamSend

getDatagramSession

getRawSession

getStreamSession

handle

notifyStreamDisconnection

notifyStreamIncomingConnection

notifyStreamOutgoingConnection

notifyStreamSendBufferFree

receiveDatagramBytes

receiveRawBytes

receiveStreamBytes

stopDatagramReceiving

stopRawReceiving

stopStreamReceiving

streamSendAnswer

verifVersion

writeString