blob: ee82d6be90ed18feaf0e8fd58f0da075e4ce0e62 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Apache Wink - Frequently Asked Questions</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<link rel="shortcut icon" href="./images/favicon.ico"/>
</head>
<body class="composite">
<div id="banner">
<a href="http://incubator.apache.org/wink/" id="bannerLeft">
<img src="images/apache-incubator-wink-white.PNG" alt="" />
</a>
<a href="http://incubator.apache.org" id="bannerRight">
<img src="http://incubator.apache.org/images/apache-incubator-logo.png" alt="" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
Last Published: 2009-07-23
</div>
<div class="xright"> <a href="http://svn.apache.org/viewvc/incubator/wink/trunk" class="externalLink">SVN</a>
|
<a href="http://cwiki.apache.org/confluence/display/WINK/Index" class="externalLink">Wiki</a>
|
<a href="http://issues.apache.org/jira/browse/WINK" class="externalLink">Jira</a>
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Main</h5>
<ul>
<li class="none">
<a href="./index.html">Introduction</a>
</li>
<li class="none">
<a href="./downloads.html">Downloads</a>
</li>
<li class="none">
<a href="./documentation.html">Documentation</a>
</li>
<li class="none">
<a href="./community.html">Community</a>
</li>
<li class="none">
<a href="./faqs.html">FAQ</a>
</li>
</ul>
<h5>Project Documentation</h5>
<ul>
<li class="collapsed">
<a href="project-info.html">Project Information</a>
</li>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2><a name="top">Frequently Asked Questions</a></h2>
<p><b>Wink 0.1</b></p>
<ol type="1"><li><a href="#sdk-examples">Where can I find examples for using Wink?</a></li>
<li><a href="#sdk-spring">Does Wink have an integration with spring? Can I expose my REST services using Spring Remoting?</a></li>
<li><a href="#sdk-struts">Is there an integration with Struts?</a></li>
<li><a href="#sdk-struts-usage">Can Wink be used in the same WAR with Struts?</a></li>
<li><a href="#sdk-tested-with-other-clients">Have you tested consuming REST resources developed using Wink from a REST client developed using other tools?</a></li>
<li><a href="#sdk-query-parameters">Does Wink query parameters?</a></li>
<li><a href="#sdk-ide-plugin">Are there any plans for developing an IDE plugin wrapper for Wink?</a></li>
</ol>
<p><b>Building the Apache Wink</b></p>
<ol type="1"><li><a href="#maven-version">What version of Maven is used to build Wink?</a></li>
<li><a href="#maven-sources">Where can I read about Maven?</a></li>
<li><a href="#build-oom">I am getting an OutOfMemoryException when performing a full build</a></li>
<li><a href="#build-offline">Can I build the sources if I am not connected to the network?</a></li>
<li><a href="#build-tests">Some tests fail during the build. Where can I see what happened?</a></li>
</ol>
</div>
<div class="section"><h2>Wink 0.1</h2>
<dl><dt><a name="sdk-examples">Where can I find examples for using Wink?</a></dt>
<dd>
<p>
Wink distributions comes bundled with several examples ilustarting how to use the server and client. <br></br>
All the examples are located in the <code>Wink/examples</code> directory of the distribution zip.
</p>
<hr />
</dd>
<dt><a name="sdk-spring">Does Wink have an integration with spring? Can I expose my REST services using Spring Remoting?</a></dt>
<dd>
<p>
Yes, it provides an extension module with the Spring integration.
However, Wink doesn't use Spring Remoting.
</p>
<hr />
</dd>
<dt><a name="sdk-struts">Is there an integration with Struts?</a></dt>
<dd>
<p>
Wink does not have an integration with struts.
</p>
<hr />
</dd>
<dt><a name="sdk-struts-usage">Can Wink be used in the same WAR with Struts?</a></dt>
<dd>
<p>
Yes, Wink and the code you develop over it can be used inside any WAR.
</p>
<hr />
</dd>
<dt><a name="sdk-tested-with-other-clients">Have you tested consuming REST resources developed using Wink from a REST client developed using other tools?</a></dt>
<dd>
<p>
Sure. We have tested it from variety of clients including IE, Firefox, Outlook, Apache Abdera, Sun Rome, etc.
</p>
<hr />
</dd>
<dt><a name="sdk-query-parameters">Does Wink query parameters?</a></dt>
<dd>
<p>
Absolutely.
</p>
<hr />
</dd>
<dt><a name="sdk-ide-plugin">Are there any plans for developing an IDE plugin wrapper for Wink?</a></dt>
<dd>
<p>
We are considering this option for the Eclipse IDE.
</p>
</dd>
</dl>
</div>
<div class="section"><h2>Building the Apache Wink</h2>
<dl><dt><a name="maven-version">What version of Maven is used to build Wink?</a></dt>
<dd>
<p>
Wink is built using Maven 2, version 2.0.9.
</p>
<hr />
</dd>
<dt><a name="maven-sources">Where can I read about Maven?</a></dt>
<dd>
<p>
Maven site: <a href="http://maven.apache.org">http://maven.apache.org</a><br></br>
Maven FAQ: <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1">http://docs.codehaus.org/display/MAVENUSER/FAQs-1</a>
</p>
<hr />
</dd>
<dt><a name="build-oom">I am getting an OutOfMemoryException when performing a full build</a></dt>
<dd>
<p>
If you are getting OutOfMemoryException when attempting a full
build, you may try increasing the max heap and the PermGen space sizes.
Either export a MAVEN_OPTS variable in your shell or add it to the original mvn script.
<br></br>
<pre>MAVEN_OPTS=-Xmx512m -XX:MaxPermSize=256m</pre>
</p>
<hr />
</dd>
<dt><a name="build-offline">Can I build the sources if I am not connected to the network?</a></dt>
<dd>
<p>
If you know your downloads are up-to-date, you can use the offline option
which may speed up your build considerably depending on network latency:
<pre>mvn -o</pre>
</p>
<hr />
</dd>
<dt><a name="build-tests">Some tests fail during the build. Where can I see what happened?</a></dt>
<dd>
<p>
Surefire, which is the default Maven test runner, outputs all tests reports
as a set of xml and text files to the <code>target/surefire-reports</code> directory.
Any test failure details and stacktraces end up in those files, but not in the console.
The output can be temporarily redirected to the console by adding the following option:
<pre>mvn -Dsurefire.useFile=false</pre>
</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">&#169;
2009
The Apache Software Foundation
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>