https://github.com/atmosphere/nettosphere
A Java WebSocket/HTTP server based on the Atmosphere and Netty Framework
https://github.com/atmosphere/nettosphere
atmosphere java netty-framework reactive
Last synced: 9 months ago
JSON representation
A Java WebSocket/HTTP server based on the Atmosphere and Netty Framework
- Host: GitHub
- URL: https://github.com/atmosphere/nettosphere
- Owner: Atmosphere
- Created: 2012-02-09T16:05:45.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2025-01-21T16:21:26.000Z (about 1 year ago)
- Last Synced: 2025-05-15T11:08:11.792Z (9 months ago)
- Topics: atmosphere, java, netty-framework, reactive
- Language: Java
- Homepage: http://async-io.org/
- Size: 2.86 MB
- Stars: 323
- Watchers: 31
- Forks: 82
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
## Nettosphere: A Java WebSocket and HTTP server powered by the [Atmosphere Framework](http://github.com/Atmosphere/atmosphere) and the [Netty Framework](http://netty.io/)
The easiest way to get started with NettoSphere is to download a sample and start it. [Or look at the Javadoc](http://atmosphere.github.io/nettosphere/apidocs/). You can download one of our [sample](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.atmosphere.nettosphere.samples%22) distribution.
```bash
% unzip nettosphere--distribution.jar
% chmod a+x ./bin/nettosphere.sh
% ./bin/nettosphere.sh
```
[Samples](https://github.com/Atmosphere/atmosphere-samples/tree/master/nettosphere-samples) are the same as the ones available in Atmosphere. Bootstrap classes looks like [Bootstrap](https://github.com/Atmosphere/atmosphere-samples/blob/master/nettosphere-samples/chat/src/main/java/org/nettosphere/samples/chat/NettosphereChat.java#L27) or [Bootstrap Jersey](https://github.com/Atmosphere/atmosphere-samples/blob/master/nettosphere-samples/jersey-chat/src/main/java/org/nettosphere/samples/chat/NettosphereJerseyChat.java#L31)
Download Nettosphere [here](http://search.maven.org/#search%7Cga%7C1%7Cnettosphere) or use Maven
```xml
org.atmosphere
nettosphere
3.2.7
```
### Super Simple Web Application
```java
Nettosphere server = new Nettosphere.Builder().config(
new Config.Builder()
.host("127.0.0.1")
.port(8080)
.resource(MyClass.class)
.build())
.build();
server.start();
```
or
```java
Nettosphere server = new Nettosphere.Builder().config(
new Config.Builder()
.host("127.0.0.1")
.port(8080)
.resource(new Handler() {
public void handle(AtmosphereResource r) {
try {
r.getResponse().write("Hello World").write(" from Nettosphere").flushBuffer();
} catch (IOException e) {
e.printStackTrace();
}
}
})
.build())
.build();
server.start();
```
[Top](#Top)
### Server static and dynamic resources, use atmosphere.xml to configure NettoSphere
```java
Config.Builder b = new Config.Builder();
b.resource("./webapps")
.port(8080)
.host("127.0.0.1")
.configFile("../conf/atmosphere.xml")
.build();
Nettosphere s = new Nettosphere.Builder().config(b.build()).build();
```
[Top](#Top)
### Deploy a Resource (annotated using Jersey), access it using HTTP or WebSocket
```java
Nettosphere server = new Nettosphere.Builder().config(
new Config.Builder()
.host("127.0.0.1")
.port(8080)
.resource(MyResource.class)
.build())
.build();
server.start();
```
[Top](#Top)
### Deploy an AtmosphereHandler, access it using HTTP or WebSocket
```java
Nettosphere server = new Nettosphere.Builder().config(
new Config.Builder()
.host("127.0.0.1")
.port(8080)
.resource("/*", MyAtmosphereHandler.class)
.build())
.build();
server.start();
```
### Deploy an AtmosphereHandler, define a WebSocket protocol
```java
Nettosphere server = new Nettosphere.Builder().config(
new Config.Builder()
.host("127.0.0.1")
.port(8080)
.webSocketProtocol(JMSOverWebSocketProtocol.class)
.resource("/*", MyAtmosphereHandler.class)
.build())
.build();
server.start();
```
[Top](#Top)
### Deploy a Servlet which use Meteor
```java
Nettosphere server = new Nettosphere.Builder().config(
new Config.Builder()
.host("127.0.0.1")
.port(8080)
.resource("/*", MyServlet.class)
.build())
.build();
server.start();
```
[Top](#Top)
### The Server can also be started using java
```java
java -cp nettosphere-all.jar
org.atmosphere.nettosphere.Nettosphere
[/path/to/an/exploded/war/file] [host] [port]
```
[Top](#Top)
### Using Maven and the Git repo
mvn exec:java -Dexec.arguments='path to your exploded war file'
#### Build Status
[](https://travis-ci.org/Atmosphere/nettosphere)
#### [Change Log](./CHANGELOG.md)
* 3.0.x release Netty 4.1.21.Final and Atmosphere 2.4.20 support.
* 2.3 release: [2.3.3](https://github.com/Atmosphere/nettosphere/issues?q=label%3A2.3.3+is%3Aclosed) [2.3.2](https://goo.gl/gaTKLZ ) [2.3.1](https://github.com/Atmosphere/nettosphere/issues?q=label%3A2.3.1+is%3Aclosed) [2.3.0](https://github.com/Atmosphere/nettosphere/issues?q=label%3A2.3.0+is%3Aclosed)
* 2.1 release: [2.1.1](https://github.com/Atmosphere/nettosphere/issues?labels=2.1.1&page=1&sort=updated&state=closed)
* 2.0 release: [2.0.2](https://github.com/Atmosphere/nettosphere/issues?labels=2.0.2&page=1&sort=updated&state=closed) [2.0.1](https://github.com/Atmosphere/nettosphere/issues?labels=2.0.1&milestone=&page=1&sort=updated&state=closed)