Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaschmid/taskwarrior-java-client
A Java client to communicate with a taskwarrior server (= taskd).
https://github.com/aaschmid/taskwarrior-java-client
client java java-client pem pkcs taskd taskserver taskwarrior taskwarrior-java-client
Last synced: 12 days ago
JSON representation
A Java client to communicate with a taskwarrior server (= taskd).
- Host: GitHub
- URL: https://github.com/aaschmid/taskwarrior-java-client
- Owner: aaschmid
- License: apache-2.0
- Created: 2017-02-25T11:57:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-09T23:00:41.000Z (almost 5 years ago)
- Last Synced: 2024-10-12T11:14:10.239Z (about 1 month ago)
- Topics: client, java, java-client, pem, pkcs, taskd, taskserver, taskwarrior, taskwarrior-java-client
- Language: Java
- Homepage:
- Size: 287 KB
- Stars: 17
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/aaschmid/taskwarrior-java-client)
[](https://circleci.com/gh/aaschmid/taskwarrior-java-client)
[](https://codebeat.co/projects/github-com-aaschmid-taskwarrior-java-client-master)
[](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22de.aaschmid%22%20AND%20a%3A%22taskwarrior-java-client%22)
[](https://github.com/aaschmid/taskwarrior-java-client/blob/master/LICENSE)
[](https://github.com/aaschmid/taskwarrior-java-client/issues)
taskwarrior-java-client
=======================
#### Table of Contents
* [What is it](#what-is-it)
* [Motivation and distinction](#motivation-and-distinction)
* [Requirements](#requirements)
* [Download](#download)
* [Usage example](#usage-example)
* [Release notes](#release-notes)
What is it
----------
A Java client to communicate with a [taskwarrior][] server (= [taskd](https://taskwarrior.org/docs/taskserver/why.html)).
[taskwarrior]: https://taskwarrior.org/
Motivation and distinction
--------------------------
The current taskwarrior Android app does not satisfy my requirements. Therefore I created this client library to
integrate it into my preferred task app. And I also want to share it with everybody who will love to use it.
Requirements
-----------
* JDK 8
Download
--------
Currently there is no released version available but feel free to clone / fork and build it yourself. If you would
love to see this on [Maven Central](http://search.maven.org/) feel free to create an issue.
Usage example
-------------
For example using it with [Java](https://www.java.com/):
```java
import java.io.IOException;
import java.net.URL;
import de.aaschmid.taskwarrior.TaskwarriorClient;
import de.aaschmid.taskwarrior.config.TaskwarriorConfiguration;
import de.aaschmid.taskwarrior.message.MessageType;
import de.aaschmid.taskwarrior.message.TaskwarriorMessage;
import de.aaschmid.taskwarrior.message.TaskwarriorRequestHeader;
import static de.aaschmid.taskwarrior.config.TaskwarriorConfiguration.taskwarriorPropertiesConfiguration;
import static de.aaschmid.taskwarrior.message.TaskwarriorMessage.taskwarriorMessage;
import static de.aaschmid.taskwarrior.message.TaskwarriorRequestHeader.taskwarriorRequestHeaderBuilder;
class Taskwarrior {
private static final URL PROPERTIES_TASKWARRIOR = Taskwarrior.class.getResource("/taskwarrior.properties");
public static void main(String[] args) {
if (PROPERTIES_TASKWARRIOR == null) {
throw new IllegalStateException(
"No 'taskwarrior.properties' found on Classpath. Create it by copy and rename 'taskwarrior.properties.template'. Also fill in proper values.");
}
TaskwarriorConfiguration config = taskwarriorPropertiesConfiguration(PROPERTIES_TASKWARRIOR);
TaskwarriorRequestHeader header = taskwarriorRequestHeaderBuilder().authentication(config).type(MessageType.STATISTICS).build();
TaskwarriorMessage message = taskwarriorMessage(header.toMap());
TaskwarriorClient client = new TaskwarriorClient(config);
TaskwarriorMessage response = client.sendAndReceive(message);
System.out.println(response);
}
}
```
Used `taskwarrior.properties` can be created by copying and adjusting
[`src/main/resources/taskwarrior.properties.template`](https://github.com/aaschmid/taskwarrior-java-client/tree/master/src/main/resources/taskwarrior.properties.template).
Testing
-------
To run tests manually you will need to build and run taskwarrior server container. [See here how](docker/taskd/README.md).
Keys formats
------------
| Key specification | [PEM]() format¹ | [DER]() format |
| ----------------- |:---------------:|:--------------:|
| [PKCS#1]() | yes | |
| [PKCS#8]() | yes | yes |
¹: The kind of format is currently detected by file extentions.
Note: Keys can be transformed using `openssl`, e.g. from [PKCS#8]() in [PEM]() format to [PKCS#1]() in [DER]() format:
```sh
openssl pkcs8 -topk8 -nocrypt -in $TASKD_GENERATED_KEY.key.pem -inform PEM -out $KEY_NAME.key.pkcs8.der -outform DER
```
[PKCS#1]: https://en.wikipedia.org/wiki/PKCS_1
[PKCS#8]: https://en.wikipedia.org/wiki/PKCS_8
[PEM]: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail
[DER]: https://en.wikipedia.org/wiki/X.690#DER_encoding
Release notes
-------------
Releases and Release Notes are available [here](https://github.com//aaschmid/taskwarrior-java-client/releases).