Tyrus is built, assembled and installed using Maven. Tyrus is deployed to the Maven Central repository at the following location: http://repo1.maven.org/. Jars, Jar sources, Jar JavaDoc and samples are all available on the Maven Central repository.

An application depending on Tyrus requires that it in turn includes the set of jars that Tyrus depends on. Tyrus has a pluggable component architecture so the set of jars required to be include in the class path can be different for each application.

All Tyrus components are built using Java SE 7 compiler. It means, you will also need at least Java SE 7 to be able to compile and run your application.

Developers using maven are likely to find it easier to include and manage dependencies of their applications than developers using ant or other build technologies. This document will explain to both maven and non-maven developers how to depend on Tyrus for their application. Ant developers are likely to find the Ant Tasks for Maven very useful.

In general, if you’re not using Maven, most probably you’d need to download dependencies (jar files) directly from the Maven repository.

Running on Glassfish

All you need for your project if you are using Glassfish 4.0 and newer is to declare provided dependency on websocket-api.

<dependency>
    <groupId>javax.websocket</groupId>
    <artifactId>javax.websocket-api</artifactId>
    <scope>provided</scope>
    <version>1.0</version>
</dependency>

Running on Servlet 3.1 compatible container

Assumption here is that Tyrus or WebSocket runtime is not already included, so you need to package it with your application (dependencies are not provided).

<dependency>
    <groupId>org.glassfish.tyrus</groupId>
    <artifactId>tyrus-container-servlet</artifactId>
    <version>1.5</version>
</dependency>

<dependency>
    <groupId>org.glassfish.tyrus</groupId>
    <artifactId>tyrus-client</artifactId>
    <version>1.5</version>
</dependency>

Standalone client

WebSocket client can be run on Java SE 6.

<dependency>
    <groupId>org.glassfish.tyrus.bundles</groupId>
    <artifactId>tyrus-standalone-client</artifactId>
    <version>1.5</version>
</dependency>

Bundle for non-maven users

There is a bundle which contains all files needed successful deployment and run of any JSR-356 (WebSocket API for Java) based application

WebSocket RI archive

If you need just client implementation, you should use Tyrus Standalone Client bundle

Tyrus Standalone Client

Back to top