https://github.com/yyuu/jetty-nosql-memcached
memcached session manager for jetty (based on jetty-nosql)
https://github.com/yyuu/jetty-nosql-memcached
Last synced: about 1 year ago
JSON representation
memcached session manager for jetty (based on jetty-nosql)
- Host: GitHub
- URL: https://github.com/yyuu/jetty-nosql-memcached
- Owner: yyuu
- License: apache-2.0
- Created: 2011-09-08T13:11:29.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2022-07-07T22:07:19.000Z (about 4 years ago)
- Last Synced: 2025-04-27T02:33:50.866Z (about 1 year ago)
- Language: Java
- Homepage: https://github.com/yyuu/jetty-nosql-memcached
- Size: 313 KB
- Stars: 44
- Watchers: 7
- Forks: 36
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Jetty NoSQL Memcached
README
# jetty-nosql-memcached
[](http://travis-ci.org/yyuu/jetty-nosql-memcached)
## Overview
SessionManager implementation for Jetty based on jetty-nosql.
## Install
jetty-nosql-memcached is an extension for Jetty.
You have to install jars into jetty's `${jetty.home}/lib/ext`.
Built jars of jetty-nosql-memcached can be found on Maven Central.
You can install one of them without building.
- http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22jetty-nosql-memcached%22
*NOTE*
You must install jetty-nosql-memcached into Jetty with all dependent jars, such like jetty-nosql and SpyMemcached.
If you're not sure, it's better to use all-in-one jar like `jetty-nosql-memcached-${version}-jar-with-dependencies.jar`.
You don't have to be aware of missing dependencies since all-in-one jar includes all dependencies in single jar file.
## Configuration
You need to configure both "session manager" and "session ID manager".
### Configuring "session ID manager"
SessionIdManagers can be configured in files under `${JETTY_HOME}/etc`. In following example, using `${JETTY_HOME}/etc/jetty.xml`.
```xml
(... snip ...)
localhost:11211
session:
memcachedSessionIdManager
```
#### Extra options for "session ID manager"
You can configure the behavior of session ID manager with following setters.
* setClientFactory(AbstractMemcachedClientFactory cf)
* set memcached client. org.eclipse.jetty.nosql.memcached.spymemcached.SpyMemcachedClientFactory is used by default.
* setDefaultExpiry(int defaultExpiry)
* set default expiry of sessions on memcached.
* setKeyPrefix(String keyPrefix)
* use keyPrefix for session key prefix on memcached.
* setKeySuffix(String keySuffix)
* use keySuffix for session key suffix on memcached.
* setServerString(String serverString)
* specify server address and port in string. multiple hosts can be specified with spaces.
* setTimeoutInMs(int timeoutInMS)
* set timeout for memcached connections.
### Configuring "session manager"
SessionManagers can be configured by either `${APP_ROOT}/WEB-INF/jetty-web.xml` or `${JETTY_HOME}/webapps/${APP_NAME}.xml`.
Sample configuration for `${APP_ROOT}/WEB-INF/jetty-web.xml`:
```xml
(... snip ...)
```
Sample configuration for `${JETTY_HOME}/webapps/${APP_NAME}.xml`:
```xml
(... snip ...)
memcachedSessionIdManager
```
#### Extra options for "session manager"
You can configure the behavior of session manager with following setters.
* setSessionIdManager(SessionIdManager idManager)
* session id manager you created.
* setSessionFactory(AbstractSessionFactory sf)
* set session serializer. org.eclipse.jetty.nosql.kvs.session.serializable.SerializableSessionFactory is used by default.
## Development
### Requirements
All library dependencies can be resolved from Maven.
* [maven](http://maven.apache.org/)
* [jetty](http://eclipse.org/jetty/)
* [spymemcached](http://code.google.com/p/spymemcached/)
* [xmemcached](http://code.google.com/p/xmemcached/)
* [kryo](http://code.google.com/p/kryo/)
* [xstream](http://xstream.codehaus.org/)
### Build
You can build project tree from top of the repository.
```sh
$ git clone git://github.com/yyuu/jetty-nosql-memcached.git
$ cd jetty-nosql-memcached
$ mvn clean package
```
### Release
Use nexus-staging-maven-plugin.
```sh
$ mvn versions:set -DnewVersion="${VERSION}"
$ git commit -a -m "v${VERSION}"
$ mvn clean deploy -DperformRelease -Dgpg.keyname="${GPG_KEYNAME}" -Dgpg.passphrase="${GPG_PASSPHRASE}"
$ mvn nexus-staging:release # may not work
$ git tag "jetty-nosql-memcached-parent-${VERSION}"
```
## License
* Copyright (c) 2011-2015 Yamashita, Yuu
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
and Apache License v2.0 which accompanies this distribution.
The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
The Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php
You may elect to redistribute this code under either of these licenses.