me.legrange.mikrotik

Class ApiConnection

java.lang.Object

me.legrange.mikrotik.ApiConnection

All Implemented Interfaces:

AutoCloseable

public abstract class ApiConnection
extends Object
implements AutoCloseable

The Mikrotik API connection. This is the class used to connect to a remote Mikrotik and send commands to it.

Author:

GideonLeGrange

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COMMAND_TIMEOUT default command timeout used for synchronous commands
static int	DEFAULT_CONNECTION_TIMEOUT default connection timeout to use when opening the connection
static int	DEFAULT_PORT default TCP port used by Mikrotik API
static int	DEFAULT_TLS_PORT default TCP TLS port used by Mikrotik API

Constructor Summary

Constructors

Constructor and Description
ApiConnection()

Method Summary

Modifier and Type	Method and Description
abstract void	cancel(String tag) cancel a command
abstract void	close() Disconnect from the remote API
static ApiConnection	connect(SocketFactory fact, String host, int port, int timeout) Create a new API connection to the give device on the supplied port using the supplied socket factory to create the socket.
static ApiConnection	connect(String host) Create a new API connection to the give device on the default API port.
abstract List<Map<String,String>>	execute(String cmd) execute a command and return a list of results.
abstract String	execute(String cmd, ResultListener lis) execute a command and attach a result listener to receive it's results.
abstract boolean	isConnected() Check the state of connection.
abstract void	login(String username, String password) Log in to the remote router.
abstract void	setTimeout(int timeout) set the command timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

default TCP port used by Mikrotik API

See Also:

Constant Field Values

DEFAULT_TLS_PORT

public static final int DEFAULT_TLS_PORT

default TCP TLS port used by Mikrotik API

See Also:

Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

default connection timeout to use when opening the connection

See Also:

Constant Field Values

DEFAULT_COMMAND_TIMEOUT

public static final int DEFAULT_COMMAND_TIMEOUT

default command timeout used for synchronous commands

See Also:

Constant Field Values

Constructor Detail

ApiConnection

public ApiConnection()

Method Detail

connect

public static ApiConnection connect(SocketFactory fact,
                                    String host,
                                    int port,
                                    int timeout)
                             throws MikrotikApiException

Create a new API connection to the give device on the supplied port using the supplied socket factory to create the socket.

Parameters:

fact - SocketFactory to use for TCP socket creation.

host - The host to which to connect.

port - The TCP port to use.

timeout - The connection timeout to use when opening the connection.

Returns:

The ApiConnection

Throws:

MikrotikApiException - Thrown if there is a problem connecting

Since:

3.0

connect

public static ApiConnection connect(String host)
                             throws MikrotikApiException

Create a new API connection to the give device on the default API port.

Parameters:

host - The host to which to connect.

Returns:

The ApiConnection

Throws:

MikrotikApiException - Thrown if there is a problem connecting

isConnected

public abstract boolean isConnected()

Check the state of connection.

Returns:

if connection is established to router it returns true.

login

public abstract void login(String username,
                           String password)
                    throws MikrotikApiException

Log in to the remote router.

Parameters:

username - - username of the user on the router

password - - password for the user

Throws:

MikrotikApiException - Thrown if the API encounters an error on login.

execute

public abstract List<Map<String,String>> execute(String cmd)
                                          throws MikrotikApiException

execute a command and return a list of results.

Parameters:

cmd - Command to execute

Returns:

The list of results

Throws:

MikrotikApiException - Thrown if the API encounters an error executing a command.

execute

public abstract String execute(String cmd,
                               ResultListener lis)
                        throws MikrotikApiException

execute a command and attach a result listener to receive it's results.

Parameters:

cmd - Command to execute

lis - ResultListener that will receive the results

Returns:

A command object that can be used to cancel the command.

Throws:

MikrotikApiException - Thrown if the API encounters an error executing a command.

cancel

public abstract void cancel(String tag)
                     throws MikrotikApiException

cancel a command

Parameters:

tag - The tag of the command to cancel

Throws:

MikrotikApiException - Thrown if there is a problem cancelling the command

setTimeout

public abstract void setTimeout(int timeout)
                         throws MikrotikApiException

set the command timeout. The command timeout is used to time out API commands after a specific time. Note: This is not the same as the timeout value passed in the connect() methods. This timeout is specific to synchronous commands, that timeout is applied to opening the API socket.

Parameters:

timeout - The time out in milliseconds.

Throws:

MikrotikApiException - Thrown if the timeout specified is invalid.

Since:

2.1

close

public abstract void close()
                    throws ApiConnectionException

Disconnect from the remote API

Specified by:

close in interface AutoCloseable

Throws:

ApiConnectionException - Thrown if there is a problem closing the connection.

Since:

2.2