kirillius
/
mikrotik-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #9 from GideonLeGrange/2.0.0 

2.0.0
This commit is contained in:
Gideon le Grange 2014-08-29 08:23:19 +02:00
parent f2f3614ff8 9e0f38149d
commit e7bb8a4f42
7 changed files with 64 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -16,6 +16,10 @@ The current stable version is 1.1.6, which managed to get into Maven Central.
* 1.1.2 added support for handling multi-line results, like for example /file print.
* 1.1 added TLS (SSL) support to encrypt API traffic.
The latest development version is 2.0.0 which is available using the 2.0.0 branch.
* Changed ResultListener to receive errors and completion notifications.
Getting the API
---------------
@ -116,7 +120,7 @@ Asynchronous commands
We can run some commands asynchronously in order to continue receiving updates:
This example shows how to run '/interface wireless monitor' and have the result sent to a listener object, which prints it
This example shows how to run '/interface wireless monitor' and have the result sent to a listener object, which prints it:
```java
String tag = con.execute("/interface/wireless/monitor .id=wlan1 return signal-to-noise",
@ -125,6 +129,14 @@ String tag = con.execute("/interface/wireless/monitor .id=wlan1 return signal-to
public void receive(Map<String, String> result) {
System.out.println(result);
}
public void error(MikrotikApiException e) {
System.out.println("An error occurred: " + e.getMessage());
}
public void completed() {
System.out.println("Asynchronous command has finished");
}
}
);
@ -136,6 +148,8 @@ The above command will run and send results asynchronously as they become availa
con.cancel(tag);
```
From version 2.0.0 of the API the error() and completed() methods are part of the ResultListener interface.
References
==========

2
src/main/java/examples/Config.java
View File

@ -7,7 +7,7 @@ package examples;
public class Config {
public static final String HOST = "10.0.1.134";
public static final String HOST = "10.0.1.1";
public static final String USERNAME = "admin";
public static final String PASSWORD = "";

14
src/main/java/examples/Example4.java
View File

@ -19,14 +19,24 @@ public class Example4 extends Example {
}
private void test() throws MikrotikApiException, InterruptedException {
String id = con.execute("/interface/wireless/monitor .id=wlan1", new ResultListener() {
String id = con.execute("/interface/wireless/monitor .id=wlan1 .proplist=signal-strength", new ResultListener() {
private int prev = 0;
public void receive(Map<String, String> result) {
int val = Integer.parseInt(result.get("signal-strength"));
System.out.println(result);
/* int val = Integer.parseInt(result.get("signal-strength"));
String sym = (val == prev) ? " " : ((val < prev) ? "-" : "+");
System.out.printf("%d %s\n", val, sym);
prev = val;
*/ }
@Override
public void error(MikrotikApiException ex) {
throw new RuntimeException(ex.getMessage(), ex);
}
@Override
public void completed() {
}

4
src/main/java/examples/Example5.java
View File

@ -2,7 +2,7 @@ package examples;
import java.util.Map;
import me.legrange.mikrotik.MikrotikApiException;
import me.legrange.mikrotik.ResponseListener;
import me.legrange.mikrotik.ResultListener;
/**
* Example 5: Asynchronous results, with error and completion. Run a command and receive results, errors and completion notification for it asynchronously with a ResponseListener
@ -20,7 +20,7 @@ public class Example5 extends Example {
private void test() throws MikrotikApiException, InterruptedException {
boolean completed = false;
String id = con.execute("/interface/wireless/monitor .id=wlan1", new ResponseListener() {
String id = con.execute("/interface/wireless/monitor .id=wlan1", new ResultListener() {
private int prev = 0;
public void receive(Map<String, String> result) {

17
src/main/java/me/legrange/mikrotik/ResponseListener.java
View File

@ -1,17 +0,0 @@
package me.legrange.mikrotik;
/**
* A listener that receives life cycle command events from the Mikrotik API,
* and not just results.
* @author GideonLeGrange
*/
public interface ResponseListener extends ResultListener {
/** called if the command associated with this listener experiences an error */
void error(MikrotikApiException ex);
/** called when the command associated with this listener is done */
void completed();
}

7
src/main/java/me/legrange/mikrotik/ResultListener.java
View File

@ -9,5 +9,12 @@ import java.util.Map;
public interface ResultListener {
void receive(Map<String, String> result);
/** called if the command associated with this listener experiences an error
* @param ex Exception encountered */
void error(MikrotikApiException ex);
/** called when the command associated with this listener is done */
void completed();
}

58
src/main/java/me/legrange/mikrotik/impl/ApiConnectionImpl.java
View File

@ -33,7 +33,8 @@ public final class ApiConnectionImpl extends ApiConnection {
* @param port The TCP port to use.
* @param secure Is TLS required
* @return The ApiConnection
* @throws me.legrange.mikrotik.ApiConnectionException Thrown if there is a problem connecting
* @throws me.legrange.mikrotik.ApiConnectionException Thrown if there is a
* problem connecting
*/
public static ApiConnection connect(String host, int port, boolean secure) throws ApiConnectionException {
ApiConnectionImpl con = new ApiConnectionImpl();
@ -53,7 +54,9 @@ public final class ApiConnectionImpl extends ApiConnection {
/**
* Disconnect from the remote API
* @throws me.legrange.mikrotik.ApiConnectionException Thrown if there is a problem disconnecting
*
* @throws me.legrange.mikrotik.ApiConnectionException Thrown if there is a
* problem disconnecting
*/
@Override
public void disconnect() throws ApiConnectionException {
@ -284,22 +287,15 @@ public final class ApiConnectionImpl extends ApiConnection {
if (l != null) {
if (res instanceof Result) {
l.receive((Result) res);
} else {
if (res instanceof Done) {
listeners.remove(res.getTag());
}
if (l instanceof ResponseListener) {
ResponseListener rl = (ResponseListener) l;
if (res instanceof Done) {
if (rl instanceof SyncListener) {
((SyncListener) rl).completed((Done) res);
} else {
rl.completed();
}
} else if (res instanceof Error) {
rl.error(new ApiCommandException((Error) res));
}
} else if (res instanceof Done) {
if (l instanceof SyncListener) {
((SyncListener) l).completed((Done) res);
} else {
l.completed();
}
listeners.remove(res.getTag());
} else if (res instanceof Error) {
l.error(new ApiCommandException((Error) res));
}
}
}
@ -322,16 +318,17 @@ public final class ApiConnectionImpl extends ApiConnection {
if (line == null) {
nextLine();
}
if (line.equals("!re")) {
return unpackRe();
} else if (line.equals("!done")) {
return unpackDone();
} else if (line.equals("!trap")) {
return unpackError();
} else if (line.equals("!halt")) {
return unpackError();
} else {
throw new ApiDataException(String.format("Unexpected line '%s'", line));
switch (line) {
case "!re":
return unpackRe();
case "!done":
return unpackDone();
case "!trap":
return unpackError();
case "!halt":
return unpackError();
default:
throw new ApiDataException(String.format("Unexpected line '%s'", line));
}
}
@ -346,8 +343,7 @@ public final class ApiConnectionImpl extends ApiConnection {
if (parts.length == 3) {
if (!parts[2].endsWith("\r")) {
res.put(parts[1], parts[2]);
}
else {
} else {
res.put(parts[1], unpackMultiLine(parts[2]));
}
} else {
@ -379,7 +375,7 @@ public final class ApiConnectionImpl extends ApiConnection {
} while (line.endsWith("\r"));
return buf.toString();
}
private Done unpackDone() throws MikrotikApiException {
Done done = new Done(null);
if (hasNextLine()) {
@ -451,7 +447,7 @@ public final class ApiConnectionImpl extends ApiConnection {
private String line;
}
private class SyncListener implements ResponseListener {
private class SyncListener implements ResultListener {
public synchronized void error(MikrotikApiException ex) {
this.err = ex;