https://github.com/kiesel/johanna

JoHannah Session Server
https://github.com/kiesel/johanna

Last synced: 1 day ago
JSON representation

JoHannah Session Server

• Host: GitHub
• URL: https://github.com/kiesel/johanna
• Owner: kiesel
• License: mit
• Created: 2013-10-03T20:24:25.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-05-23T19:49:34.000Z (over 2 years ago)
• Last Synced: 2024-11-08T18:23:34.018Z (about 2 months ago)
• Language: Java
• Size: 118 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Johanna

=======

[![Build Status on TravisCI](https://secure.travis-ci.org/kiesel/johanna.svg)](http://travis-ci.org/kiesel/johanna)

Johanna is a server implementation of the Hannah session server `hannahd` and

is written in Java.

## Usage

```sh

$ java org.oneandone.idev.johanna.JohannahServer [--port=2001] \

  [--backend=memory|redis] \

  [--host=127.0.0.1] \

  [--identifier=md5|uuid]

```

or - if you run the uber-jar:

```sh

$ java -jar /path/to/johanna-jar.jar  [--port=2001] \

  [--backend=memory|redis] \

  [--host=127.0.0.1] \

  [--identifier=md5|uuid]

```

* port: defaults to 2001.

* backend: supports `memory` (keep sessions in RAM), `redis` (use Redis key-value

  store as session storage).

* host: host of Redis store

* identifier: use MD5 or UUID as session identifier implementation 

## Implemented protocol commands

The following commands are implemented:

* `session_create `

* `session_terminate `

* `session_isvalid `

* `session_settimeout  `

* `session_keys `

* `var_write    `

* `var_read   `

* `var_delete   `

* `bye` and `exit`

Parameters explained:

* `` is a session unique identifier generated by the server

* `` is a timeout in seconds

* `` is the type of storage, it can be `tmp`, `perm` or `sec`. Currently

  only `tmp` is implemented

* `` is a whitespace delimited key name

* `` is a whitespace delimited value` - a common approach to store arbitrary

  data there is to first urlencode the data.

## Prerequisites

* The build requires Java 7

* A non-global dependency jcli is contained in the `contrib/` folder

## Protocol

### Basics

The Hannah-protocol is a line-based, human readable & writable protocol. Clients

issue a command, the server replies. There are no server-initiated actions on

the wire.

### Requests