Skip to main content

Source code file content

Revision: 53

article "WebSocket API in JDK 8 - MessageHandler issue"
» Project Revision History

» Checkout URL

web / www / dependencies.html

Size: 12313 bytes, 1 line
<!DOCTYPE html>
<!--
 Generated by Apache Maven Doxia at 2014-03-18
 Rendered using Maven Reflow Skin 1.0.0 (http://andriusvelykis.github.com/reflow-maven-skin)
-->
<html  xml:lang="en" lang="en">

	<head>
		<meta charset="UTF-8" />
		<title>Project Tyrus - Dependencies</title>
		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
		<meta name="description" content="" />
		<meta http-equiv="content-language" content="en" />
 
		<link href="//netdna.bootstrapcdn.com/bootswatch/2.2.2/cosmo/bootstrap.min.css" rel="stylesheet" />
		<link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/css/bootstrap-responsive.min.css" rel="stylesheet" />
		<link href="https://tyrus.java.net/css/bootswatch.css" rel="stylesheet" />
		<link href="https://tyrus.java.net/css/reflow-skin.css" rel="stylesheet" />
		
		<link href="//yandex.st/highlightjs/7.3/styles/solarized_dark.min.css" rel="stylesheet" />
		
		<link href="https://tyrus.java.net/css/lightbox.css" rel="stylesheet" />
		
		<link href="https://tyrus.java.net/css/site.css" rel="stylesheet" />
		<link href="https://tyrus.java.net/css/print.css" rel="stylesheet" media="print" />
		
		<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
		<!--[if lt IE 9]>
			<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
		<![endif]-->

		<!-- Google Analytics -->
		<script type="text/javascript">
		
			var _gaq = _gaq || [];
			_gaq.push(['_setAccount', 'UA-41373632-1']);
			_gaq.push(['_trackPageview']);

			(function() {
				var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
				ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
				var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
			})();

		</script>
		</head>

	<body class="page-dependencies project-site" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">

		<div class="navbar navbar-fixed-top">
			<div class="navbar-inner">
				<div class="container">
					<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
						<span class="icon-bar"></span>
						<span class="icon-bar"></span>
						<span class="icon-bar"></span>
					</a>
					<a class="brand" href="index.html"><img src="images/websocket_logo_white.png" style="width:35px; margin-right:10px;" /> Project <span class="color-highlight">Tyrus</span></a>
					<div class="nav-collapse">
						<ul class="nav pull-right">
							<li class="dropdown">
								<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
								<ul class="dropdown-menu">
									<li><a href="documentation/1.5/user-guide.html" title="User Guide - One Page">User Guide - One Page </a></li>
									<li class="dropdown-submenu">
										<a href="documentation/1.5/index/index.html" title="User Guide">User Guide </a>
										<ul class="dropdown-menu">
											<li><a href="documentation/1.5/index/getting-started.html" title="Getting Started">Getting Started </a></li>
											<li><a href="documentation/1.5/index/modules-and-dependencies.html" title="Modules and Dependencies">Modules and Dependencies </a></li>
											<li><a href="documentation/1.5/index/deployment.html" title="Deploying WebSocket Endpoints">Deploying WebSocket Endpoints </a></li>
											<li><a href="documentation/1.5/index/websocket-api.html" title="WebSocket API">WebSocket API </a></li>
											<li><a href="documentation/1.5/index/configurations.html" title="Configurations">Configurations </a></li>
											<li><a href="documentation/1.5/index/lifecycle.html" title="Endpoint Lifecycle, Sessions, Sending Messages">Endpoint Lifecycle, Sessions, Sending Messages </a></li>
											<li><a href="documentation/1.5/index/injection.html" title="Injection Support">Injection Support </a></li>
											<li><a href="documentation/1.5/index/tyrus-proprietary-config.html" title="Proprietary configuration">Proprietary configuration </a></li>
										</ul>
									</li>
									<li><a href="documentation/1.0/user-guide.html" title="User Guide - Tyrus 1.0">User Guide - Tyrus 1.0 </a></li>
									<li><a href="https://tyrus.java.net/apidocs/1.5/index.html" title="Tyrus 1.5 Javadocs" class="externalLink">Tyrus 1.5 Javadocs </a></li>
									<li><a href="https://tyrus.java.net/apidocs/1.0/index.html" title="Tyrus 1.0 Javadocs" class="externalLink">Tyrus 1.0 Javadocs </a></li>
									<li><a href="contribute.html" title="Contribute">Contribute </a></li>
								</ul>
							</li>
						</ul>
					</div><!--/.nav-collapse -->
				</div>
			</div>
		</div>
		
	<div class="container">
	
	<!-- Masthead
	================================================== -->
	<header class="jumbotron subhead">
		<div class="row" id="banner">
			<div class="span12">
				<div class="pull-left">
					<a href="index.html" id="bannerLeft"><h1>Project <span class="color-highlight">Tyrus</span></h1></a>
					<p class="lead">JSR 356: Java API for WebSocket - Reference Implementation</p>
				</div>
				<div class="pull-right">
				</div>
			</div>
		</div>
	</header>

	<div class="main-body">
	<div class="row">
		<div class="span12">
			<div class="body-content">
<div class="section"> 
 <div class="page-header">
  <h2 id="Dependencies">Dependencies</h2>
 </div> 
 <p>Tyrus is built, assembled and installed using Maven. Tyrus is deployed to the Maven Central repository at the following location: <a class="externalLink" href="http://repo1.maven.org/">http://repo1.maven.org/</a>. Jars, Jar sources, Jar JavaDoc and samples are all available on the Maven Central repository.</p> 
 <p>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.</p> 
 <p>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.</p> 
 <p>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.</p> 
 <p>In general, if you’re not using Maven, most probably you’d need to download dependencies (jar files) directly from the Maven repository.</p> 
 <div class="section"> 
  <h3 id="Running_on_Glassfish">Running on Glassfish</h3> 
  <p>All you need for your project if you are using Glassfish 4.0 and newer is to declare provided dependency on websocket-api.</p> 
  <div class="source"> 
   <pre>&lt;dependency&gt;
    &lt;groupId&gt;javax.websocket&lt;/groupId&gt;
    &lt;artifactId&gt;javax.websocket-api&lt;/artifactId&gt;
    &lt;scope&gt;provided&lt;/scope&gt;
    &lt;version&gt;1.0&lt;/version&gt;
&lt;/dependency&gt;
</pre> 
  </div> 
 </div> 
 <div class="section"> 
  <h3 id="Running_on_Servlet_3.1_compatible_container">Running on Servlet 3.1 compatible container</h3> 
  <p>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).</p> 
  <div class="source"> 
   <pre>&lt;dependency&gt;
    &lt;groupId&gt;org.glassfish.tyrus&lt;/groupId&gt;
    &lt;artifactId&gt;tyrus-container-servlet&lt;/artifactId&gt;
    &lt;version&gt;1.5&lt;/version&gt;
&lt;/dependency&gt;

&lt;dependency&gt;
    &lt;groupId&gt;org.glassfish.tyrus&lt;/groupId&gt;
    &lt;artifactId&gt;tyrus-client&lt;/artifactId&gt;
    &lt;version&gt;1.5&lt;/version&gt;
&lt;/dependency&gt;
</pre> 
  </div> 
 </div> 
 <div class="section"> 
  <h3 id="Standalone_client">Standalone client</h3> 
  <p>WebSocket client can be run on Java SE 6.</p> 
  <div class="source"> 
   <pre>&lt;dependency&gt;
    &lt;groupId&gt;org.glassfish.tyrus.bundles&lt;/groupId&gt;
    &lt;artifactId&gt;tyrus-standalone-client&lt;/artifactId&gt;
    &lt;version&gt;1.5&lt;/version&gt;
&lt;/dependency&gt;
</pre> 
  </div> 
 </div> 
 <div class="section"> 
  <h3 id="Bundle_for_non-maven_users">Bundle for non-maven users</h3> 
  <p>There is a bundle which contains all files needed successful deployment and run of any JSR-356 (WebSocket API for Java) based application</p> 
  <p><a class="externalLink" href="http://search.maven.org/remotecontent?filepath=org/glassfish/tyrus/bundles/websocket-ri-archive/1.5/websocket-ri-archive-1.5.zip">WebSocket RI archive</a></p> 
  <p>If you need just client implementation, you should use Tyrus Standalone Client bundle</p> 
  <p><a class="externalLink" href="http://search.maven.org/#artifactdetails%7Corg.glassfish.tyrus.bundles%7Ctyrus-standalone-client%7C1.5%7Cjar">Tyrus Standalone Client</a></p> 
 </div> 
</div>
			</div>
		</div>
	</div>
	</div>

	</div><!-- /container -->
	
	<!-- Footer
	================================================== -->
	<footer class="well">
		<div class="container">
			<div class="row">
				<div class="span3 bottom-nav">
					<ul class="nav nav-list">
						<li class="nav-header">Main</li>
						<li>
							<a href="index.html" title="Home">Home </a>
						</li>
						<li>
							<a href="license.html" title="License">License </a>
						</li>
						<li class="nav-header">Download</li>
						<li class="active">
							<a href="#" title="Download">Download </a>
						</li>
					</ul>
				</div>
				<div class="span3 bottom-nav">
					<ul class="nav nav-list">
						<li class="nav-header">Contribute</li>
						<li>
							<a href="contribute.html" title="Contribute">Contribute </a>
						</li>
						<li>
							<a href="http://stackoverflow.com/questions/tagged/tyrus" title="StackOverflow" class="externalLink">StackOverflow </a>
						</li>
						<li>
							<a href="mailing.html" title="Mailing Lists">Mailing Lists </a>
						</li>
					</ul>
				</div>
				<div class="span3 bottom-nav">
					<ul class="nav nav-list">
						<li class="nav-header">Project Info</li>
						<li>
							<a href="scm.html" title="Source Control">Source Control </a>
						</li>
						<li>
							<a href="https://java.net/jira/browse/TYRUS/" title="Issue Tracking" class="externalLink">Issue Tracking </a>
						</li>
						<li>
							<a href="mailing.html" title="Mailing Lists">Mailing Lists </a>
						</li>
						<li>
							<a href="team-list.html" title="Project Team">Project Team </a>
						</li>
					</ul>
				</div>
				<div class="span3 bottom-description">
					<a href="https://glassfish.java.net" style="border:0; display:block"><img src="images/glassfish_logo.png" width="200" /></a>
				</div>
			</div>
		</div>
	</footer>
		
	<div class="container subfooter">
		<div class="row">
			<div class="span12">
				<p class="pull-right"><a href="#">Back to top</a></p>
				<p class="copyright">Copyright &copy;2014 <a href="http://oracle.com">Oracle Corporation</a>. All Rights Reserved.</p>
			</div>
		</div>
	</div>

	<!-- Le javascript
	================================================== -->
	<!-- Placed at the end of the document so the pages load faster -->

	<!-- Fallback jQuery loading from Google CDN:
	     http://stackoverflow.com/questions/1014203/best-way-to-use-googles-hosted-jquery-but-fall-back-to-my-hosted-library-on-go -->
	<script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
	<script type="text/javascript">
		if (typeof jQuery == 'undefined')
		{
			document.write(unescape("%3Cscript src='https://tyrus.java.net/js/jquery-1.8.3.min.js' type='text/javascript'%3E%3C/script%3E"));
		}
	</script>
	
	<script src="//netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/js/bootstrap.min.js"></script>
	<script src="https://tyrus.java.net/js/lightbox.js"></script>
	<script src="https://tyrus.java.net/js/jquery.smooth-scroll.min.js"></script>
	<!-- back button support for smooth scroll -->
	<script src="https://tyrus.java.net/js/jquery.ba-bbq.min.js"></script>
	<script src="//yandex.st/highlightjs/7.3/highlight.min.js"></script>

	<script src="https://tyrus.java.net/js/reflow-skin.js"></script>
	
	</body>
</html>
 
 
Close
loading
Please Confirm
Close