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

Compare commits

base: kirillius:master
Branches Tags
kirillius:master
kirillius:issue-55
kirillius:v3.0.7
kirillius:v3.0.6
kirillius:v3.0.5
kirillius:v3.0.4
kirillius:v3.0.3
kirillius:v3.0.2
kirillius:v3.0.1
kirillius:v3.0
kirillius:v2.2
kirillius:v2.1
kirillius:2.0.3
kirillius:2.0.2
kirillius:2.0.1
kirillius:2.0.0
kirillius:mikrotik-1.1.6
kirillius:1.1.5
kirillius:1.1.4
kirillius:1.1.3
kirillius:1.1.2
kirillius:1.1.1
kirillius:v1.1
kirillius:mikrotik-java-1.0
..
compare: kirillius:v3.0.1
Branches Tags
kirillius:master
kirillius:issue-55
kirillius:v3.0.7
kirillius:v3.0.6
kirillius:v3.0.5
kirillius:v3.0.4
kirillius:v3.0.3
kirillius:v3.0.2
kirillius:v3.0.1
kirillius:v3.0
kirillius:v2.2
kirillius:v2.1
kirillius:2.0.3
kirillius:2.0.2
kirillius:2.0.1
kirillius:2.0.0
kirillius:mikrotik-1.1.6
kirillius:1.1.5
kirillius:1.1.4
kirillius:1.1.3
kirillius:1.1.2
kirillius:1.1.1
kirillius:v1.1
kirillius:mikrotik-java-1.0

No commits in common. "master" and "v3.0.1" have entirely different histories.
master ... v3.0.1

21 changed files with 339 additions and 576 deletions
Show Stats Expand all files Collapse all files

24
.github/workflows/maven.yml vendored
View File

@ -1,24 +0,0 @@
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
name: Java CI with Maven
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 1.8
uses: actions/setup-java@v1
with:
java-version: 1.8
- name: Build with Maven
run: mvn -B package --file pom.xml

3
.gitignore vendored
View File

@ -22,6 +22,3 @@ nbactions.xml
# Maven
pom.xml.versionsBackup
# MacOS
.DS_Store

1
.travis.yml
View File

@ -1 +0,0 @@
language: java

54
CONTRIBUTING.md
View File

@ -1,54 +0,0 @@
Thank you for considering contributing to this project. This library is one tiny way I am giving back to the open source community, and I am
always amazed and humbled when users contribute back.
There are several ways of contributing to this small open source library:
* You can ask for help
* You can log a bug
* You can contribute code
# Ask for help
If you experience a problem using the mikrotik-java library, the best way to get in touch with me is to either send me an
email or open an issue on GitHub. While you can seek help on StackOverflow or the Mikrotik Forums (both of which I've seen
people do), I do not read those sites often. If you wish to log your question there (it makes sense for it to be searchable or
in a place where other interested people can find it) and want me to take a look at it, please send me an email pointing to
the question.
I find that it is very easy to help users of this library if they include the following things which are usually quite relevant:
* A snipped of sample code showing what they're doing
* The stack trace (if there is one) when it goes wrong
* Version of the library they're using
# Log a bug
If you are pretty sure you have found a bug in the library, please log a bug by opening an issue on GithHub. When things get buggy,
the following information (mostly the same as for asking help) becomes important:
* A snipped of sample code showing what they're doing
* The stack trace (if there is one) when it goes wrong
* Version of the library they're using
* The version of RouterOS they're connecting to
I take bug reports very seriously, and will usually bring out immediate minor versions to fix show stoppers.
# Contribute code
If you want to contribute code to this library, you're welcome. Please read this section before submitting pull requests.
## If you're fixing a bug
If you've fixed a bug, please submit the pull request on GitHub. If there is an already existing issue being fixed, please
reference that issue so I can look at what you're fixing, and if not, please explain the issue you're fixing in the pull request.
## If you want new functionality or API changes
Please contact me via email before you create a pull request for feature additions or API changes. The mikrotik-java library is stable and,
for it's current purpose, feature complete. The situations in which I will add features to the library or change it's interface are:
* If Mikrotik adds new RouterOS functionality that requires an API change to remain feature complete
* If some very bad design flaw in the interface is discovered
* If somebody has a truly compelling reason for adding to the library. To be compelling means the added functionality must be useful
for more users than just the submitter
* If some new pattern or convention arises in the Java standard libraries that is useful
I *really* hate declining people's PRs, but I will do so if I don't think they add value as explained above, or if I can't figure out why
they want the change. For this reason, if you are at all unsure if your PR will be accepted, please contact me and discuss what you want
before submitting a PR.
Gideon

71
README.md
View File

@ -1,4 +1,4 @@
# mikrotik-java
# mikrotik-java
A Java client library implementation for the Mikrotik RouterOS API.
@ -6,14 +6,14 @@ This project provides a Java client to manipulate Mikrotik routers using the rem
## Versions
![Java CI with Maven](https://github.com/GideonLeGrange/mikrotik-java/workflows/Java%20CI%20with%20Maven/badge.svg)
**The current stable version is 3.0.1**
**The current stable version is 3.0.8**
Version 3.0.8 fixes a null pointer error
This library uses [semantic versioning](http://semver.org/)
### Changes in version 3.0:
Version 3.0.1 fixes a harmless but annoying stack trace bug (#34).
Version 3.0 addresses the problems the API had around TLS encryption. The way secure connections are implemented is changed so that the user has complete control over the creation of TLS sockets. To this end:
* A new method, `connect(SocketFactory fact, String host, int port, int timeout)`, was added to allow for better user control over sockets and especially encryption.
* The `connectTLS()` API methods were removed.
@ -23,9 +23,13 @@ Version 3.0 addresses the problems the API had around TLS encryption. The way se
Further changes include:
* The previously deprecated `disconnect()` method is removed.
#### Versions 1.x and 2.x
#### Version 2.x
Versions 1 and 2 are considered *obsolete* and will no longer be supported or patched.
Version 2.2 is the last version 2.x release and will be supported for a limited time.
#### Version 1.x
Version 1 is considered *obsolete* and will no longer be supported or patched.
## Getting the API
@ -35,28 +39,19 @@ Maven users can use the artifact from Maven Central with this dependency:
<dependency>
<groupId>me.legrange</groupId>
<artifactId>mikrotik</artifactId>
<version>3.0.8</version>
<version>3.0.1</version>
</dependency>
```
You can also download the pre-built jar file, or a zip or tar.gz file with the source for the latest release [here](https://github.com/GideonLeGrange/mikrotik-java/releases/latest)
## Asking for help or contributing
## Contributing
I welcome contributions, be it bug fixes or other improvements.
I welcome contributions, be it bug fixes or other improvements. If you fix or change something, please submit a pull request. If you want to report a bug, please open an issue. General questions are also welcome.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to contribute to this project.
# Examples
# Using the API
How to use the API is best illustrated by examples.
These examples should illustrate how to use this library. Please note that I assume that the user is proficient in Java and understands the Mikrotik command line syntax. The command line syntax gives you an indication of what commands you can pass, but the RouterOS API used by this library does not support everyting.
Some things to consider when debugging your API calls are:
* The RouterOS API does not support auto-completion. You need to write out command and parameter names. For example, you can't say `/ip/hotspot/user/add name=john add=10.0.0.1`, you need to write out `address`.
* You need to quote values with spaces in. You can't say `name=Joe Blogs`, you need to use `name="Joe Blogs"`
* Exceptions with a root cause of `ApiCommandException` are errors received from the remote RouterOS device and contain the error message received.
These examples should illustrate how to use this library. Please note that I assume that the user is proficient in Java and understands the Mikrotik command line syntax.
## Opening a connection
Here is a simple example: Connect to a router and reboot it.
@ -65,7 +60,7 @@ Here is a simple example: Connect to a router and reboot it.
ApiConnection con = ApiConnection.connect("10.0.1.1"); // connect to router
con.login("admin","password"); // log in to router
con.execute("/system/reboot"); // execute a command
con.close(); // disconnect from router
con.disconnect(); // disconnect from router
```
The above example shows a easy way of creating an unencrypted connection using the default API port and timeout, which is useful for development and testing.
@ -81,6 +76,7 @@ Above an instance of the default SSL socket factory is passed to the API. This w
RouterOS also supports anonymous TLS. An example showing how to create a socket factory for anonymous TLS is `AnonymousSocketFactory` in the examples directory.
### Connection timeouts
By default, the API will generate an exception if it cannot connect to the specified router. This can take place immediately (typically if the OS returns a 'Connection refused' error), but can also take up to 60 seconds if the router host is firewalled or if there are other network problems. This 60 seconds is the 'default connection timeout' an can be overridded by passing the preferred timeout to the APi as last parameter in a ```connect()``` call. For example:
@ -98,22 +94,12 @@ DEFAULT_PORT | Default TCP `port` value for unencrypyted connections | 8728
DEFAULT_TLS_PORT | Default TCP `port` value for encrypyted connections | 8729
DEFAULT_CONNECTION_TIMEOUT | Default connection `timeout` value (ms) | 60000
### Try with resources
The API can also be used in a "try with resources" statement which will ensure that the connection is closed:
```java
try (ApiConnection con = ApiConnection.connect(SocketFactory.getDefault(), Config.HOST, ApiConnection.DEFAULT_PORT, 2000)) {
con.login(Config.USERNAME, Config.PASSWORD);
con.execute("/user/add name=eric");
}
```
In following examples the connection, login and disconnection code will not be repeated. In all cases it is assumed that an `ApiConnection` has been established, `login()` has been called, and that the connection is called `con`.
## Reading data
A simple example that returns a result - Print all interfaces:
A simple example that returns a result: Print all interfaces.
```java
@ -141,7 +127,7 @@ List<Map<String, String>> rs = con.execute("/interface/print where type=vlan");
### Selecting returned fields
The same query, but we only want certain result fields names: Print all interfaces of type 'vlan' and return just their name:
The same query, but we only want certain result fields names: Print all interfaces of type 'vlan' and return just their name.
```java
List<Map<String, String>> rs = con.execute("/interface/print where type=vlan return name");
@ -175,19 +161,6 @@ And now remove the object:
con.execute("/interface/gre/remove .id=gre1");
```
### Un-setting a variable on an object
Un-setting a variable is a bit different, and you need to use a parameter called `value-name`. This isn't well documented. Let's say you have a firewall rule that was set up like this:
```java
con.execute("/ip/firewall/filter/add action=accept chain=forward time=00:00:01-01,mon")
```
Assuming the rule can be accessed as `.id=*1`, you un-set it by using `value-name` as seen below:
```java
con.execute("/ip/firewall/filter/unset .id=*1 value-name=time");
```
## Asynchronous commands
We can run some commands asynchronously in order to continue receiving updates:
@ -225,6 +198,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.
## Command timeouts
Command timeouts can be used to make sure that synchronous commands either return or fail within a specific time. Command timeouts are separate from the connection timeout used in ```connect()```, and can be set using ```setTimeout()```. Here is an example:
@ -246,5 +221,5 @@ The RouterOS API is documented here: http://wiki.mikrotik.com/wiki/Manual:API
# Licence
This library is released under the Apache 2.0 licence. See the [LICENCE.md](LICENCE.md) file
This library is released under the Apache 2.0 licence. See the [Licence.md](Licence.md) file

337
pom.xml
View File

@ -1,168 +1,173 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<groupId>org.sonatype.oss</groupId>
<artifactId>oss-parent</artifactId>
<version>9</version>
</parent>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<groupId>org.sonatype.oss</groupId>
<artifactId>oss-parent</artifactId>
<version>9</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>me.legrange</groupId>
<artifactId>mikrotik</artifactId>
<version>3.0.8.1</version>
<packaging>jar</packaging>
<name>Mikrotik API Java Client Library</name>
<url>https://github.com/GideonLeGrange/mikrotik-java</url>
<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
<scm>
<url>git@github.com:GideonLeGrange/mikrotik-java.git</url>
<connection>scm:git:git@github.com:GideonLeGrange/mikrotik-java.git</connection>
<developerConnection>scm:git:git@github.com:GideonLeGrange/mikrotik-java.git</developerConnection>
</scm>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<showDeprecation>true</showDeprecation>
<source>8</source>
<target>8</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.3.2</version>
<executions>
<execution>
<id>default-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<excludes>
<exclude>**/examples</exclude>
<exclude>**/examples/*</exclude>
</excludes>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.7.0</version>
<configuration>
<excludePackageNames>example;*.impl</excludePackageNames>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.4</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.5</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>
</plugins>
</build>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
</profile>
</profiles>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
<scope>test</scope>
</dependency>
</dependencies>
<modelVersion>4.0.0</modelVersion>
<groupId>me.legrange</groupId>
<artifactId>mikrotik</artifactId>
<version>3.0.1</version>
<packaging>jar</packaging>
<name>Mikrotik API Java Client Library</name>
<url>https://github.com/GideonLeGrange/mikrotik-java</url>
<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
<scm>
<url>git@github.com:GideonLeGrange/mikrotik-java.git</url>
<connection>scm:git:git@github.com:GideonLeGrange/mikrotik-java.git</connection>
<developerConnection>scm:git:git@github.com:GideonLeGrange/mikrotik-java.git</developerConnection>
</scm>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3.2</version>
<configuration>
<showDeprecation>true</showDeprecation>
<source>1.7</source>
<target>1.7</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.3.2</version>
<executions>
<execution>
<id>default-jar</id>
<phase>package</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<excludes>
<exclude>**/examples</exclude>
<exclude>**/examples/*</exclude>
</excludes>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<excludePackageNames>example;*.impl</excludePackageNames>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.4</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.1</version>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.5</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>
</plugins>
</build>
<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
</profile>
</profiles>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>

34
src/main/java/examples/CharacterSets.java
View File

@ -1,34 +0,0 @@
package examples;
import java.util.List;
import java.util.Map;
import me.legrange.mikrotik.MikrotikApiException;
/**
* Example to show that different character sets may work some times.
*
* @author gideon
*/
public class CharacterSets extends Example {
private static final String JAPANESE = "事報ハヤ久送とゅ歳用ト候新放すルドう二5春園ユヲロ然納レ部悲と被状クヘ芸一ーあぽだ野健い産隊ず";
private static final String CRYLLIC = "Лорем ипсум долор сит амет, легере елояуентиам хис ид. Елигенди нолуиссе вих ут. Нихил";
private static final String ARABIC = "تجهيز والمانيا تم قام. وحتّى المتاخمة ما وقد. أسر أمدها تكبّد عل. فقد بسبب ترتيب استدعى أم, مما مع غرّة، لأداء. الشتاء، عسكرياً";
public static void main(String... args) throws Exception {
CharacterSets ex = new CharacterSets();
ex.connect();
ex.test();
ex.disconnect();
}
private void test() throws MikrotikApiException {
con.execute("/ip/hotspot/user/add name=userJ comment='" + JAPANESE + "'");
con.execute("/ip/hotspot/user/add name=userC comment='" + CRYLLIC + "'");
con.execute("/ip/hotspot/user/add name=userA comment='" + ARABIC + "'");
for (Map<String, String> res : con.execute("/ip/hotspot/user/print return name,comment")) {
System.out.printf("%s : %s\n", res.get("name"), res.get("comment"));
}
}
}

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

@ -7,8 +7,8 @@ package examples;
*/
public class Config {
public static final String HOST = "ce2.ter.cpt.adept.za.net";
public static final String USERNAME = "adept";
public static final String PASSWORD = "34ffp9";
public static final String HOST = "192.168.1.34";
public static final String USERNAME = "admin";
public static final String PASSWORD = "";
}

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

@ -21,9 +21,9 @@ public class DownloadConfig extends Example {
private void test() throws MikrotikApiException, InterruptedException {
con.execute("/export file=conf");
List<Map<String, String>> res = con.execute("/file/print detail where name=conf.rsc");
con.execute("/file/remove .id=conf.rsc");
con.execute("/file/remove conf.rsc");
String text = res.get(0).get("contents");
for (String line : text.split("\r")) {
for (String line : text.split("\r")) {
System.out.println(line);
}
}

33
src/main/java/examples/NestedExpressions.java
View File

@ -1,33 +0,0 @@
package examples;
import me.legrange.mikrotik.MikrotikApiException;
import java.util.List;
import java.util.Map;
/**
* Example 2: A command that returns results. Print all interfaces
*
* @author gideon
*/
public class NestedExpressions extends Example {
public static void main(String... args) throws Exception {
NestedExpressions ex = new NestedExpressions();
ex.connect();
ex.test("/ip/firewall/nat/print where (src-address=\"192.168.15.52\" or src-address=\"192.168.15.53\")");
ex.test("/ip/firewall/nat/print where chain=api_test and (src-address=192.168.15.52) and action=log ");
ex.test("/ip/firewall/nat/print where chain=api_test and (src-address=192.168.15.53 or src-address=192.168.15.52) and action=log ");
ex.test("/ip/firewall/nat/print where chain=api_test and (src-address=\"192.168.15.53\" or src-address=\"192.168.15.52\") and action=log ");
ex.disconnect();
}
private void test(String cmd) throws MikrotikApiException {
System.out.println("Command: " + cmd);
List<Map<String, String>> results = con.execute(cmd);
for (Map<String, String> result : results) {
System.out.println(result);
}
System.out.println();
}
}

28
src/main/java/examples/ScriptCommand.java
View File

@ -1,28 +0,0 @@
package examples;
import me.legrange.mikrotik.MikrotikApiException;
/**
* Example 1: A very simple command: Reboot the remote router
* @author gideon
*/
public class ScriptCommand extends Example {
public static void main(String...args) throws Exception {
ScriptCommand ex = new ScriptCommand();
ex.connect();
ex.test();
ex.disconnect();
}
private void test() throws MikrotikApiException {
con.execute("/ip/hotspot/user/profile/add name=\"cahyo-cek-2\" idle-timeout=none keepalive-timeout=2m status-autorefresh=1m shared-users=1 add-mac-cookie=true mac-cookie-timeout=3d parent-queue=none rate-limit=512k/512k on-login=:put(\",re,3000,12d,3000,,Enable,\")");
}
///
/*
/ip/hotspot/user/profile/add name="cahyo-cek-2" idle-timeout=none keepalive-timeout=2m status-autorefresh=1m shared-users=1 add-mac-cookie=true mac-cookie-timeout=3d parent-queue=none rate-limit=512k/512k on-login=:put (",re,3000,12d,3000,,Enable,");
/system scheduler add name="usercahyo-cek-2-$user" interval=12:00:00 on-even="/ip hotspot active remove [find user=\"$user\"] ; /ip hotspot user set \"$user\" disable=yes ; /system scheduler remove [find name=usercahyo-cek-2-$user]"
*/
}

10
src/main/java/me/legrange/mikrotik/ApiConnectionException.java
View File

@ -6,20 +6,10 @@ package me.legrange.mikrotik;
*/
public class ApiConnectionException extends MikrotikApiException {
/**
* Create a new exception.
*
* @param msg The message
*/
public ApiConnectionException(String msg) {
super(msg);
}
/**
* Create a new exception
* @param msg The message
* @param err The underlying cause
*/
public ApiConnectionException(String msg, Throwable err) {
super(msg, err);
}

11
src/main/java/me/legrange/mikrotik/MikrotikApiException.java
View File

@ -7,21 +7,10 @@ package me.legrange.mikrotik;
*/
public class MikrotikApiException extends Exception {
/**
* Create a new exception
* @param msg The message
*/
public MikrotikApiException(String msg) {
super(msg);
}
/**
* Create a new exception
* @param msg The message
* @param err The underlying cause
*/
public MikrotikApiException(String msg, Throwable err) {
super(msg, err);
}

3
src/main/java/me/legrange/mikrotik/grammar.txt → src/main/java/me/legrange/mikrotik/grammar.txt
View File

@ -1,13 +1,12 @@
command = action [ query ] [ return ]
action = ("/" word)+
query = "where" expr
expr = expr "and" expr | expr "or" expr | "not" expr | hasExpr | eqExpr | lessExpr | moreExpr | notExpr | nestedExpr
expr = expr "and" expr | expr "or" expr | "not" expr | hasExpr | eqExpr | lessExpr | moreExpr | notExpr
hasExpr = name
eqExpr = name "=" value
lessExpr = name "<" value
moreExpr = name ">" value
notExpr = name "!=" value
nestedExpr = "(" expr ")"
return = "return" (name)+

23
src/main/java/me/legrange/mikrotik/impl/ApiCommandException.java
View File

@ -4,40 +4,31 @@ import me.legrange.mikrotik.MikrotikApiException;
/**
* Thrown when the Mikrotik returns an error when receiving our command.
*
* @author GideonLeGrange
*/
public class ApiCommandException extends MikrotikApiException {
private String tag = null;
private int category = 0;
/**
* return the tag associated with this exception, if there is one
*
* @return the tag associated with this exception. Null if there is no tag
*/
/** return the tag associated with this exception, if there is one
* @return the tag associated with this exception. Null if there is no tag*/
public String getTag() {
return tag;
}
ApiCommandException(String msg) {
ApiCommandException(String msg) {
super(msg);
}
ApiCommandException(String msg, Throwable err) {
ApiCommandException(String msg, Throwable err) {
super(msg, err);
}
public int getCategory() {
return category;
}
ApiCommandException(Error err) {
super(err.getMessage());
tag = err.getTag();
category = err.getCategory();
}
private String tag = null;
}

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

@ -14,7 +14,6 @@ import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.atomic.AtomicInteger;
import javax.net.SocketFactory;
import me.legrange.mikrotik.ApiConnection;
import me.legrange.mikrotik.ApiConnectionException;
@ -32,9 +31,9 @@ public final class ApiConnectionImpl extends ApiConnection {
/**
* Create a new API connection to the give device on the supplied port
*
* @param fact The socket factory used to construct the connection socket.
* @param host The host to which to connect.
* @param port The TCP port to use.
* @param secure Is TLS required
* @param timeOut The connection timeout
* @return The ApiConnection
* @throws me.legrange.mikrotik.ApiConnectionException Thrown if there is a
@ -56,19 +55,12 @@ public final class ApiConnectionImpl extends ApiConnection {
if (username.trim().isEmpty()) {
throw new ApiConnectionException("API username cannot be empty");
}
Command cmd = new Command("/login");
cmd.addParameter("name", username);
cmd.addParameter("password", password);
List<Map<String, String>> list = execute(cmd, timeout);
if (!list.isEmpty()) {
Map<String, String> res = list.get(0);
if (res.containsKey("ret")) {
String hash = res.get("ret");
String chal = Util.hexStrToStr("00") + new String(password.toCharArray()) + Util.hexStrToStr(hash);
chal = Util.hashMD5(chal);
execute("/login name=" + username + " response=00" + chal);
}
}
List<Map<String, String>> list = execute("/login");
Map<String, String> res = list.get(0);
String hash = res.get("ret");
String chal = Util.hexStrToStr("00") + new String(password.toCharArray()) + Util.hexStrToStr(hash);
chal = Util.hashMD5(chal);
execute("/login name=" + username + " response=00" + chal);
}
@Override
@ -163,7 +155,8 @@ public final class ApiConnectionImpl extends ApiConnection {
}
private synchronized String nextTag() {
return Integer.toHexString(_tag.incrementAndGet());
_tag++;
return Integer.toHexString(_tag);
}
private Socket sock = null;
@ -173,7 +166,7 @@ public final class ApiConnectionImpl extends ApiConnection {
private Reader reader;
private Processor processor;
private final Map<String, ResultListener> listeners;
private final AtomicInteger _tag = new AtomicInteger(0);
private Integer _tag = 0;
private int timeout = ApiConnection.DEFAULT_COMMAND_TIMEOUT;
/**
@ -181,12 +174,8 @@ public final class ApiConnectionImpl extends ApiConnection {
*/
private class Reader extends Thread {
private Reader() {
super("Mikrotik API Reader");
}
private String take() throws ApiConnectionException, ApiDataException {
Object val;
Object val = null;
try {
val = queue.take();
} catch (InterruptedException ex) {
@ -209,7 +198,9 @@ public final class ApiConnectionImpl extends ApiConnection {
while (connected) {
try {
String s = Util.decode(in);
put(s);
if (s != null) {
put(s);
}
} catch (ApiDataException ex) {
put(ex);
} catch (ApiConnectionException ex) {
@ -223,7 +214,7 @@ public final class ApiConnectionImpl extends ApiConnection {
private void put(Object data) {
try {
queue.put(data);
} catch (InterruptedException ignored) {
} catch (InterruptedException ex) {
}
}
@ -235,10 +226,6 @@ public final class ApiConnectionImpl extends ApiConnection {
*/
private class Processor extends Thread {
private Processor() {
super("Mikrotik API Result Processor");
}
@Override
public void run() {
while (connected) {
@ -248,31 +235,27 @@ public final class ApiConnectionImpl extends ApiConnection {
} catch (ApiCommandException ex) {
String tag = ex.getTag();
if (tag != null) {
res = new Error(tag, ex.getMessage(), ex.getCategory());
res = new Error(tag, ex.getMessage());
} else {
continue;
}
} catch (MikrotikApiException ex) {
continue;
}
if (res.getTag() != null) {
ResultListener l = listeners.get(res.getTag());
if (l != null) {
if (res instanceof Result) {
l.receive((Result) 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));
ResultListener l = listeners.get(res.getTag());
if (l != null) {
if (res instanceof Result) {
l.receive((Result) 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));
}
} else {
nextTag();
}
}
}
@ -280,7 +263,7 @@ public final class ApiConnectionImpl extends ApiConnection {
private void nextLine() throws ApiConnectionException, ApiDataException {
if (lines.isEmpty()) {
String block = reader.take();
String[] parts = block.split("\n");
String parts[] = block.split("\n");
lines.addAll(Arrays.asList(parts));
}
line = lines.remove(0);
@ -293,7 +276,7 @@ public final class ApiConnectionImpl extends ApiConnection {
private String peekLine() throws ApiConnectionException, ApiDataException {
if (lines.isEmpty()) {
String block = reader.take();
String[] parts = block.split("\n");
String parts[] = block.split("\n");
lines.addAll(Arrays.asList(parts));
}
return lines.get(0);
@ -306,10 +289,10 @@ public final class ApiConnectionImpl extends ApiConnection {
switch (line) {
case "!re":
return unpackRe();
case "!empty":
case "!done":
return unpackDone();
case "!trap":
return unpackError();
case "!halt":
return unpackError();
case "":
@ -320,27 +303,21 @@ public final class ApiConnectionImpl extends ApiConnection {
private Result unpackRe() throws ApiDataException, ApiConnectionException {
nextLine();
int l = 0;
Result res = new Result();
while (!line.startsWith(("!"))) {
l++;
if (line.startsWith(("="))) {
String[] parts = line.split("=", 3);
String parts[] = line.split("=", 3);
if (parts.length == 3) {
if (!parts[2].endsWith("\r")) {
res.put(parts[1], unpackResult(parts[2]));
} else {
final StringBuilder sb = new StringBuilder();
sb.append(parts[2]);
while (!lines.isEmpty()) {
nextLine();
sb.append(line);
}
res.put(parts[1], sb.toString());
}
} else {
throw new ApiDataException(String.format("Malformed line '%s'", line));
}
} else if (line.startsWith(".tag=")) {
String[] parts = line.split("=", 2);
String parts[] = line.split("=", 2);
if (parts.length == 2) {
res.setTag(parts[1]);
}
@ -381,12 +358,12 @@ public final class ApiConnectionImpl extends ApiConnection {
while (!line.startsWith("!")) {
if (line.startsWith(".tag=")) {
String[] parts = line.split("=", 2);
String parts[] = line.split("=", 2);
if (parts.length == 2) {
done.setTag(parts[1]);
}
} else if (line.startsWith(("=ret"))) {
String[] parts = line.split("=", 3);
String parts[] = line.split("=", 3);
if (parts.length == 3) {
done.setHash(parts[2]);
} else {
@ -410,16 +387,13 @@ public final class ApiConnectionImpl extends ApiConnection {
if (hasNextLine()) {
while (!line.startsWith("!")) {
if (line.startsWith(".tag=")) {
String[] parts = line.split("=", 2);
String parts[] = line.split("=", 2);
if (parts.length == 2) {
err.setTag(parts[1]);
}
} else if (line.startsWith("=message=")) {
err.setMessage(line.split("=", 3)[2]);
}
else if (line.startsWith("=category=")) {
err.setCategory(Integer.parseInt(line.split("=", 3)[2]));
}
if (hasNextLine()) {
nextLine();
} else {
@ -431,22 +405,35 @@ public final class ApiConnectionImpl extends ApiConnection {
return err;
}
private void queue(Response res) {
String tag = res.getTag();
if (tag != null) {
ResultListener rl = listeners.get(tag);
if (rl != null) {
if (res instanceof Result) {
rl.receive((Result) res);
} else {
// rl.error((Error)res);
}
}
}
}
private final List<String> lines = new LinkedList<>();
private String line;
}
private static class SyncListener implements ResultListener {
private class SyncListener implements ResultListener {
@Override
public synchronized void error(MikrotikApiException ex) {
this.err = ex;
notifyAll();
notify();
}
@Override
public synchronized void completed() {
complete = true;
notifyAll();
notify();
}
synchronized void completed(Done done) {
@ -456,7 +443,7 @@ public final class ApiConnectionImpl extends ApiConnection {
results.add(res);
}
complete = true;
notifyAll();
notify();
}
@Override

19
src/main/java/me/legrange/mikrotik/impl/Error.java
View File

@ -1,16 +1,12 @@
package me.legrange.mikrotik.impl;
/**
* Used to encapsulate API error information. We need to pass both the message and the tag (if one was used).
*
* Used to encapsulate API error information. We need to pass both the message and the tag (if one was used).
* @author GideonLeGrange
*/
class Error extends Response {
private String message;
private int category;
Error(String tag, String message, int category) {
Error(String tag, String message) {
super(tag);
this.message = message;
}
@ -22,16 +18,11 @@ class Error extends Response {
String getMessage() {
return message;
}
void setMessage(String message) {
this.message = message;
}
private String message;
int getCategory() {
return category;
}
void setCategory(int category) {
this.category = category;
}
}

66
src/main/java/me/legrange/mikrotik/impl/Parser.java
View File

@ -3,30 +3,24 @@ package me.legrange.mikrotik.impl;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import me.legrange.mikrotik.impl.Scanner.Token;
/**
* Parse the pseudo-command line into command objects.
*
* Parse the pseudo-command line into command objects.
* @author GideonLeGrange
*/
class Parser {
/**
* parse the given bit of text into a Command object
*/
/** parse the given bit of text into a Command object */
static Command parse(String text) throws ParseException {
Parser parser = new Parser(text);
return parser.parse();
}
/**
* run parse on the internal data and return the command object
*/
/** run parse on the internal data and return the command object */
private Command parse() throws ParseException {
command();
while (!is(Token.WHERE, Token.RETURN, Token.EOL)) {
while (!is(Token.WHERE, Token.RETURN, Token.EOL)) {
param();
}
if (token == Token.WHERE) {
@ -38,7 +32,7 @@ class Parser {
expect(Token.EOL);
return cmd;
}
private void command() throws ParseException {
StringBuilder path = new StringBuilder();
do {
@ -73,7 +67,8 @@ class Parser {
next();
}
cmd.addParameter(new Parameter(name, val.toString()));
} else {
}
else {
cmd.addParameter(new Parameter(name));
}
}
@ -84,7 +79,7 @@ class Parser {
}
private void expr() throws ParseException {
expect(Token.NOT, Token.TEXT, Token.LEFT_BRACKET);
expect(Token.NOT, Token.TEXT);
switch (token) {
case NOT:
notExpr();
@ -97,7 +92,7 @@ class Parser {
case EQUALS:
eqExpr(name);
break;
case NOT_EQUALS:
case NOT_EQUALS :
notExpr(name);
break;
case LESS:
@ -111,36 +106,23 @@ class Parser {
}
}
break;
case LEFT_BRACKET:
nestedExpr();
break;
}
// if you get here, you had a expression, see if you want more.
switch (token) {
case AND:
andExpr();
case AND : andExpr();
break;
case OR:
orExpr();
case OR : orExpr();
break;
}
}
private void nestedExpr() throws ParseException {
expect(Token.LEFT_BRACKET);
next();
expr();
expect(Token.RIGHT_BRACKET);
next();
}
private void andExpr() throws ParseException {
next(); // eat and
expr();
cmd.addQuery("?#&");
}
private void orExpr() throws ParseException {
private void orExpr() throws ParseException {
next(); // eat or
expr();
cmd.addQuery("?#|");
@ -153,7 +135,7 @@ class Parser {
cmd.addQuery("?#!");
}
private void eqExpr(String name) throws ParseException {
private void eqExpr(String name) throws ParseException {
next(); // eat =
expect(Token.TEXT);
cmd.addQuery(String.format("?%s=%s", name, text));
@ -172,7 +154,7 @@ class Parser {
cmd.addQuery("?#!");
next();
}
private void moreExpr(String name) throws ScanException {
next(); // eat >
cmd.addQuery(String.format("?>%s=%s", name, text));
@ -193,24 +175,22 @@ class Parser {
}
next();
}
cmd.addProperty(props.toArray(new String[props.size()]));
cmd.addProperty(props.toArray(new String[]{}));
}
private void expect(Token... tokens) throws ParseException {
if (!is(tokens))
private void expect(Token...tokens) throws ParseException {
if (!is(tokens))
throw new ParseException(String.format("Expected %s but found %s at position %d", Arrays.asList(tokens), this.token, scanner.pos()));
}
private boolean is(Token... tokens) {
private boolean is(Token...tokens) {
for (Token want : tokens) {
if (this.token == want) return true;
}
return false;
}
/**
* move to the next token returned by the scanner
*/
/** move to the next token returned by the scanner */
private void next() throws ScanException {
token = scanner.next();
while (token == Token.WS) {
@ -224,7 +204,7 @@ class Parser {
scanner = new Scanner(line);
next();
}
private final Scanner scanner;
private Token token;
private String text;

23
src/main/java/me/legrange/mikrotik/impl/Scanner.java
View File

@ -15,7 +15,6 @@
*/
package me.legrange.mikrotik.impl;
import java.util.Locale;
import static me.legrange.mikrotik.impl.Scanner.Token.*;
/**
* A simple scanner.
@ -28,7 +27,6 @@ class Scanner {
SLASH("/"), COMMA(","), EOL(), WS, TEXT,
LESS("<"), MORE(">"), EQUALS("="), NOT_EQUALS("!="), PIPE("!"),
LEFT_BRACKET("("), RIGHT_BRACKET(")"),
WHERE, NOT, AND, OR, RETURN;
@Override
@ -81,12 +79,6 @@ class Scanner {
case '=':
nextChar();
return EQUALS;
case '(' :
nextChar();
return LEFT_BRACKET;
case ')' :
nextChar();
return RIGHT_BRACKET;
case '!':
return pipe();
case '"':
@ -121,11 +113,11 @@ class Scanner {
*/
private Token name() throws ScanException {
text = new StringBuilder();
while (!in(c, "[ \t\r\n=<>!)]")) {
while (!in(c, "[ \t\r\n=<>!]")) {
text.append(c);
nextChar();
}
String val = text.toString().toLowerCase(Locale.getDefault());
String val = text.toString().toLowerCase();
switch (val) {
case "where":
return WHERE;
@ -192,6 +184,17 @@ class Scanner {
}
}
/**
* look ahead one character
*/
private char peek() {
if (pos < line.length()) {
return line.charAt(pos);
} else {
return '\n';
}
}
/**
* check if the character matches the give expression
*/

11
src/main/java/me/legrange/mikrotik/impl/Util.java
View File

@ -4,7 +4,6 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.List;
@ -72,7 +71,7 @@ final class Util {
}
buf[i] = (byte) (c & 0xFF);
}
String res = new String(buf, Charset.forName("UTF-8"));
String res = new String(buf);
if (result.length() > 0) {
result.append("\n");
}
@ -122,11 +121,11 @@ final class Util {
* @return - converted string.
*/
static String hexStrToStr(String s) {
StringBuilder ret = new StringBuilder();
String ret = "";
for (int i = 0; i < s.length(); i += 2) {
ret.append((char) Integer.parseInt(s.substring(i, i + 2), 16));
ret += (char) Integer.parseInt(s.substring(i, i + 2), 16);
}
return ret.toString();
return ret;
}
/**
@ -134,7 +133,7 @@ final class Util {
* stream.
*/
private static void encode(String word, OutputStream out) throws UnsupportedEncodingException, IOException {
byte bytes[] = word.getBytes("UTF-8");
byte bytes[] = word.getBytes("US-ASCII");
int len = bytes.length;
if (len < 0x80) {
out.write(len);

31
src/test/java/me/legrange/mikrotik/ApiConnectionTest.java Normal file
View File

@ -0,0 +1,31 @@
package me.legrange.mikrotik;
import java.util.List;
import java.util.Map;
import junit.framework.TestCase;
public class ApiConnectionTest extends TestCase {
private static final String HOSTNAME = "192.168.88.1";
private static final String ADMIN = "admin";
private static final String PASSWORD = "plasma";
public void testConnectTLSStringInt() throws MikrotikApiException, InterruptedException {
/* ApiConnection connect = ApiConnection.connectTLS(HOSTNAME, 8729);
connect.login(ADMIN, PASSWORD);
List<Map<String, String>> result = connect.execute("/system/resource/print");
assertEquals(1, result.size());
assertEquals("MikroTik", result.get(0).get("platform")); */
}
public void testConnectStringInt() throws MikrotikApiException, InterruptedException {
/* ApiConnection connect = ApiConnection.connect(HOSTNAME, 8728);
connect.login(ADMIN, PASSWORD);
List<Map<String, String>> result = connect.execute("/system/resource/print");
assertEquals(1, result.size());
assertEquals("MikroTik", result.get(0).get("platform")); */
}
}