You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shindig.apache.org by li...@apache.org on 2010/09/02 00:03:40 UTC
svn commit: r991727 [2/3] - in /shindig/trunk/java:
common/src/main/java/org/apache/shindig/auth/
common/src/main/java/org/apache/shindig/common/cache/
common/src/main/java/org/apache/shindig/common/cache/ehcache/
common/src/main/java/org/apache/shindi...
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceRewriter.java Wed Sep 1 22:03:35 2010
@@ -22,6 +22,8 @@ import com.google.inject.Inject;
/**
* Rewriter that converts all url's to absolute.
+ *
+ * @since 2.0.0
*/
public class AbsolutePathReferenceRewriter extends DomWalker.Rewriter {
@Inject
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AbsolutePathReferenceVisitor.java Wed Sep 1 22:03:35 2010
@@ -40,6 +40,8 @@ import java.util.Map;
/**
* Visitor that resolves relative paths relative to the
* base tag (only if present) / current page url and marks urls as absolute.
+ *
+ * @since 2.0.0
*/
public class AbsolutePathReferenceVisitor implements Visitor {
public enum Tags {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AccelResponseRewriterRegistry.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AccelResponseRewriterRegistry.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AccelResponseRewriterRegistry.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/AccelResponseRewriterRegistry.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,8 @@ import java.util.List;
/**
* Response rewriter registry for accel servlet. Encapsulates response rewriters
* that should be applied for Accel servlet.
+ *
+ * @since 2.0.0
*/
public class AccelResponseRewriterRegistry extends DefaultResponseRewriterRegistry {
@Inject
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/BaseTagRemoverRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/BaseTagRemoverRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/BaseTagRemoverRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/BaseTagRemoverRewriter.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,8 @@ import java.util.logging.Logger;
/**
* Simple rewriter that deletes the base tag from the html document.
+ *
+ * @since 2.0.0
*/
public class BaseTagRemoverRewriter implements GadgetRewriter, ResponseRewriter {
private static final Logger logger = Logger.getLogger(BaseTagRemoverRewriter.class.getName());
@@ -58,4 +60,4 @@ public class BaseTagRemoverRewriter impl
rewrite(context, response);
}
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CaptureRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CaptureRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CaptureRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CaptureRewriter.java Wed Sep 1 22:03:35 2010
@@ -44,4 +44,4 @@ public class CaptureRewriter implements
public boolean viewWasRewritten() {
return rewroteView;
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ConcatVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ConcatVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ConcatVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ConcatVisitor.java Wed Sep 1 22:03:35 2010
@@ -35,6 +35,10 @@ import java.util.LinkedList;
import java.util.List;
import java.util.Set;
+/**
+ * DOM mutator that concatenates resources using the concat servlet
+ * @since 2.0.0
+ */
public class ConcatVisitor implements DomWalker.Visitor {
public static class Js extends ConcatVisitor {
public Js(ContentRewriterFeature.Config config,
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverRewriter.java Wed Sep 1 22:03:35 2010
@@ -22,7 +22,9 @@ import com.google.common.collect.Immutab
import com.google.inject.Inject;
/**
- * Removes charset information from <meta http-equip="Content-Type">
+ * Removes charset information from <meta http-equip="Content-Type"%gt; tags
+ *
+ * @since 2.0.0
*/
public class ContentTypeCharsetRemoverRewriter extends DomWalker.Rewriter {
@Inject
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ContentTypeCharsetRemoverVisitor.java Wed Sep 1 22:03:35 2010
@@ -26,7 +26,9 @@ import org.w3c.dom.Node;
import java.util.List;
/**
- * Removes charset information from <meta http-equip="Content-Type">
+ * Removes charset information from <meta http-equip="Content-Type">
+ *
+ * @since 2.0.0
*/
public class ContentTypeCharsetRemoverVisitor implements DomWalker.Visitor {
public final static String CONTENT = "content";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CssResponseRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CssResponseRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CssResponseRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/CssResponseRewriter.java Wed Sep 1 22:03:35 2010
@@ -49,6 +49,8 @@ import com.google.inject.Inject;
/**
* Rewrite links to referenced content in a stylesheet
+ *
+ * @since 2.0.0
*/
public class CssResponseRewriter implements ResponseRewriter {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DefaultResponseRewriterRegistry.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DefaultResponseRewriterRegistry.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DefaultResponseRewriterRegistry.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DefaultResponseRewriterRegistry.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,8 @@ import com.google.inject.Inject;
/**
* Basic registry -- just iterates over rewriters and invokes them sequentially.
+ *
+ * @since 2.0.0
*/
public class DefaultResponseRewriterRegistry implements ResponseRewriterRegistry {
protected final List<ResponseRewriter> rewriters;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DomWalker.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DomWalker.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DomWalker.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/DomWalker.java Wed Sep 1 22:03:35 2010
@@ -41,8 +41,10 @@ import java.util.Map;
/**
* Framework-in-a-framework facilitating the common Visitor case
* in which a DOM tree is walked in order to manipulate it.
- *
+ *
* See subclass doc for additional detail.
+ *
+ * @since 2.0.0
*/
public final class DomWalker {
private DomWalker() {}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/OsTemplateXmlLoaderRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/OsTemplateXmlLoaderRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/OsTemplateXmlLoaderRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/OsTemplateXmlLoaderRewriter.java Wed Sep 1 22:03:35 2010
@@ -42,6 +42,10 @@ import org.w3c.dom.Text;
import java.util.List;
+/**
+ * Rewrites the gadget to include template and xml information
+ * @since 2.0.0
+ */
public class OsTemplateXmlLoaderRewriter extends DomWalker.Rewriter {
public static final String OS_TEMPLATE_MIME = "os/template";
public static final String OS_TEMPLATES_FEATURE_NAME = "opensocial-templates";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/PipelineDataGadgetRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/PipelineDataGadgetRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/PipelineDataGadgetRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/PipelineDataGadgetRewriter.java Wed Sep 1 22:03:35 2010
@@ -39,7 +39,7 @@ import java.util.logging.Logger;
/**
* ContentRewriter that resolves opensocial-data elements on the server.
- *
+ *
* This rewriter cannot be used currently without the SocialMarkupHtmlParser.
*/
public class PipelineDataGadgetRewriter implements GadgetRewriter {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingContentRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingContentRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingContentRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingContentRewriter.java Wed Sep 1 22:03:35 2010
@@ -28,6 +28,11 @@ import org.apache.shindig.gadgets.uri.Pr
import java.util.Arrays;
import java.util.List;
+/**
+ * Rewrites gadget content to force resources through the /proxy endpoint.
+ *
+ * @since 2.0.0
+ */
public class ProxyingContentRewriter extends DomWalker.Rewriter {
private final ContentRewriterFeature.Factory featureConfigFactory;
private final ProxyUriManager proxyUriManager;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ProxyingVisitor.java Wed Sep 1 22:03:35 2010
@@ -36,6 +36,8 @@ import java.util.logging.Logger;
/**
* Simple visitor that, when plugged into a DomWalker, rewrites
* resource links to proxied versions of the same.
+ *
+ * @since 2.0.0
*/
public class ProxyingVisitor extends ResourceMutateVisitor {
private static final Logger logger = Logger.getLogger(
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResourceMutateVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResourceMutateVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResourceMutateVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResourceMutateVisitor.java Wed Sep 1 22:03:35 2010
@@ -40,6 +40,8 @@ import java.util.Map;
* proxying resources, making url's absolute, prefetching images etc.
*
* TODO: Refactor AbsolutePathReferenceVisitor to extend ResourceMutateVisitor.
+ *
+ * @since 2.0.0
*/
public abstract class ResourceMutateVisitor implements DomWalker.Visitor {
/**
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriter.java Wed Sep 1 22:03:35 2010
@@ -20,6 +20,11 @@ package org.apache.shindig.gadgets.rewri
import org.apache.shindig.gadgets.http.HttpRequest;
import org.apache.shindig.gadgets.http.HttpResponseBuilder;
+/**
+ * Base interface used by response rewriter implementations.
+ *
+ * @since 2.0.0
+ */
public interface ResponseRewriter {
public void rewrite(HttpRequest request, HttpResponseBuilder response) throws RewritingException;
}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriterRegistry.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriterRegistry.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriterRegistry.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ResponseRewriterRegistry.java Wed Sep 1 22:03:35 2010
@@ -23,7 +23,9 @@ import org.apache.shindig.gadgets.http.H
import com.google.inject.ImplementedBy;
/**
- * Performs rewriting operations by invoking one or more {@link ResponseRewriter}s.
+ * Performs rewriting operations by invoking one or more {@link org.apache.shindig.gadgets.rewrite.ResponseRewriter}s.
+ *
+ * @since 2.0.0
*/
@ImplementedBy(DefaultResponseRewriterRegistry.class)
public interface ResponseRewriterRegistry {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ScriptConcatContentRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ScriptConcatContentRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ScriptConcatContentRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/ScriptConcatContentRewriter.java Wed Sep 1 22:03:35 2010
@@ -29,6 +29,11 @@ import org.apache.shindig.gadgets.uri.Co
import java.util.Arrays;
import java.util.List;
+/**
+ * REwrites scripts.
+ *
+ * @since 2.0.0
+ */
public class ScriptConcatContentRewriter extends DomWalker.Rewriter {
private final ContentRewriterFeature.Factory featureConfigFactory;
private final ConcatUriManager concatUriManager;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyContentRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyContentRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyContentRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyContentRewriter.java Wed Sep 1 22:03:35 2010
@@ -20,6 +20,11 @@ package org.apache.shindig.gadgets.rewri
import org.apache.shindig.gadgets.rewrite.DomWalker;
+/**
+ * Merges adjacent style tags.
+ *
+ * @since 2.0.0
+ */
public class StyleAdjacencyContentRewriter extends DomWalker.Rewriter {
public StyleAdjacencyContentRewriter() {
super(new StyleAdjacencyVisitor());
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleAdjacencyVisitor.java Wed Sep 1 22:03:35 2010
@@ -35,6 +35,8 @@ import java.util.List;
* in all but the most pathological (JS manipulating CSS through stylesheets
* in an order-dependent way) cases while reducing browser reflows and making
* CSS concatenated-proxying more likely.
+ *
+ * @since 2.0.0
*/
public class StyleAdjacencyVisitor implements Visitor {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleConcatContentRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleConcatContentRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleConcatContentRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleConcatContentRewriter.java Wed Sep 1 22:03:35 2010
@@ -29,6 +29,11 @@ import org.apache.shindig.gadgets.uri.Co
import java.util.Arrays;
import java.util.List;
+/**
+ * Merges adjacent styles
+ *
+ * @since 2.0.0
+ */
public class StyleConcatContentRewriter extends DomWalker.Rewriter {
private final ContentRewriterFeature.Factory featureConfigFactory;
private final ConcatUriManager concatUriManager;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorContentRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorContentRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorContentRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorContentRewriter.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,11 @@ import org.apache.shindig.gadgets.uri.Pr
import java.util.Arrays;
import java.util.List;
+/**
+ * Extracts style tags
+ *
+ * @since 2.0.0
+ */
public class StyleTagExtractorContentRewriter extends DomWalker.Rewriter {
private final ContentRewriterFeature.Factory featureConfigFactory;
private final ProxyUriManager proxyUriManager;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagExtractorVisitor.java Wed Sep 1 22:03:35 2010
@@ -29,6 +29,10 @@ import org.apache.shindig.gadgets.uri.Pr
import org.w3c.dom.Element;
import org.w3c.dom.Node;
+/**
+ * Visits nodes in the dom extracting style tags.
+ * @since 2.0.0
+ */
public class StyleTagExtractorVisitor implements Visitor {
private final ContentRewriterFeature.Config config;
private final CssResponseRewriter cssRewriter;
@@ -88,4 +92,4 @@ public class StyleTagExtractorVisitor im
return mutated;
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsRewriter.java Wed Sep 1 22:03:35 2010
@@ -29,6 +29,8 @@ import java.util.List;
/**
* Rewriter that replaces urls (@import + background) in
* <style> ... </style> with their proxied versions.
+ *
+ * @since 2.0.0
*/
public class StyleTagProxyEmbeddedUrlsRewriter extends DomWalker.Rewriter {
private final ContentRewriterFeature.Factory featureConfigFactory;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsVisitor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsVisitor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsVisitor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/rewrite/StyleTagProxyEmbeddedUrlsVisitor.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,8 @@ import java.util.List;
/**
* Visitor that replaces urls (@import + background) in
* <style> ... </style> with their proxied versions.
+ *
+ * @since 2.0.0
*/
public class StyleTagProxyEmbeddedUrlsVisitor implements DomWalker.Visitor {
protected final ContentRewriterFeature.Config config;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/AccelHandler.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/AccelHandler.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/AccelHandler.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/AccelHandler.java Wed Sep 1 22:03:35 2010
@@ -44,6 +44,8 @@ import java.io.IOException;
/**
* Handles requests for accel servlet.
* The objective is to accelerate web pages.
+ *
+ * @since 2.0.0
*/
@Singleton
public class AccelHandler {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/CajaContentRewriter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/CajaContentRewriter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/CajaContentRewriter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/CajaContentRewriter.java Wed Sep 1 22:03:35 2010
@@ -69,6 +69,9 @@ import java.net.URI;
import java.util.Map;
import java.util.logging.Logger;
+/**
+ * A GadgetRewriter based on caja technology
+ */
public class CajaContentRewriter implements GadgetRewriter {
public static final String CAJOLED_DOCUMENTS = "cajoledDocuments";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandler.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandler.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandler.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandler.java Wed Sep 1 22:03:35 2010
@@ -48,6 +48,11 @@ import java.util.concurrent.ExecutorServ
import javax.servlet.http.HttpServletResponse;
+/**
+ * Provides endpoints for gadget metadata lookup and more.
+ *
+ * @since 2.0.0
+ */
@Service(name = "gadgets")
public class GadgetsHandler {
@VisibleForTesting
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerApi.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerApi.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerApi.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerApi.java Wed Sep 1 22:03:35 2010
@@ -31,6 +31,8 @@ import java.util.Map;
* Classes in here specify the API data.
* Please do not reference run time classes, instead create new interface (keep imports clean!).
* Please avoid changes if possible, you might break external system that depend on the API.
+ *
+ * @since 2.0.0
*/
public class GadgetsHandlerApi {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerService.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerService.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerService.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/GadgetsHandlerService.java Wed Sep 1 22:03:35 2010
@@ -47,6 +47,11 @@ import java.util.Locale;
import java.util.Map;
import java.util.Set;
+/**
+ * Service that interfaces with the system to provide information about gadgets.
+ *
+ * @since 2.0.0
+ */
public class GadgetsHandlerService {
// Map shindig data class to API interfaces
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HtmlAccelServlet.java Wed Sep 1 22:03:35 2010
@@ -35,6 +35,8 @@ import java.util.logging.Logger;
/**
* Handles requests for accel servlet.
* The objective is to accelerate web pages.
+ *
+ * @since 2.0.0
*/
public class HtmlAccelServlet extends InjectedServlet {
private static final long serialVersionUID = -424353123863813052L;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HttpRequestHandler.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HttpRequestHandler.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HttpRequestHandler.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/HttpRequestHandler.java Wed Sep 1 22:03:35 2010
@@ -84,7 +84,7 @@ import com.google.inject.Inject;
* It's important to note that requests which generate HTTP error responses such as 500 are returned
* in the above format. The RPC itself succeeded in these cases. If an RPC error occurred the client
* should introspect the error message for information as to the cause.
- *
+ *
* TODO: send errors using "result", not plain content
*
* @see MakeRequestHandler
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/OAuthCallbackServlet.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/OAuthCallbackServlet.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/OAuthCallbackServlet.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/OAuthCallbackServlet.java Wed Sep 1 22:03:35 2010
@@ -40,7 +40,7 @@ import javax.servlet.http.HttpServletRes
/**
* Servlet to act as our OAuth callback URL. When gadget authors register a consumer key with an
* OAuth service provider, they can provide a URL pointing to this servlet as their callback URL.
- *
+ *
* Protocol flow:
* - gadget discovers it needs approval to access data at OAuth SP.
* - gadget opens popup window to approval URL, passing URL to this servlet as the oauth_callback
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/ServletUtil.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/ServletUtil.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/ServletUtil.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/servlet/ServletUtil.java Wed Sep 1 22:03:35 2010
@@ -40,6 +40,11 @@ import java.io.PrintWriter;
import java.util.Enumeration;
import java.util.Map;
+/**
+ * Jtility routines for dealing with servlets.
+ *
+ * @since 2.0.0
+ */
public final class ServletUtil {
public static final String REMOTE_ADDR_KEY = "RemoteAddress";
public static final String DATA_URI_KEY = "dataUri";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/GadgetSpec.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/GadgetSpec.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/GadgetSpec.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/GadgetSpec.java Wed Sep 1 22:03:35 2010
@@ -38,6 +38,7 @@ import java.util.Map;
/**
* Represents a gadget specification root element (Module).
+ *
* @see <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v08/gadget-spec">gadgets spec</a>
*/
public class GadgetSpec {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/Icon.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/Icon.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/Icon.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/spec/Icon.java Wed Sep 1 22:03:35 2010
@@ -105,4 +105,4 @@ public class Icon {
mode = icon.mode;
type = icon.type;
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/TemplateProcessor.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/TemplateProcessor.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/TemplateProcessor.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/TemplateProcessor.java Wed Sep 1 22:03:35 2010
@@ -68,4 +68,4 @@ public interface TemplateProcessor {
* @param defaultValue Default value to return
*/
<T> T evaluate(String expression, Class<T> type, T defaultValue);
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/AbstractTagRegistry.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/AbstractTagRegistry.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/AbstractTagRegistry.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/AbstractTagRegistry.java Wed Sep 1 22:03:35 2010
@@ -21,6 +21,9 @@ package org.apache.shindig.gadgets.templ
import org.apache.shindig.gadgets.templates.TagRegistry;
import org.w3c.dom.Element;
+/**
+ * Base class for handling tags
+ */
public abstract class AbstractTagRegistry implements TagRegistry {
public final TagHandler getHandlerFor(Element element) {
@@ -29,5 +32,4 @@ public abstract class AbstractTagRegistr
}
return getHandlerFor(new NSName(element.getNamespaceURI(), element.getLocalName()));
}
-
}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/DefaultTagRegistry.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/DefaultTagRegistry.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/DefaultTagRegistry.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/DefaultTagRegistry.java Wed Sep 1 22:03:35 2010
@@ -42,4 +42,4 @@ public class DefaultTagRegistry extends
public TagHandler getHandlerFor(NSName name) {
return handlers.get(name);
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/IfTagHandler.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/IfTagHandler.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/IfTagHandler.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/templates/tags/IfTagHandler.java Wed Sep 1 22:03:35 2010
@@ -24,6 +24,9 @@ import org.w3c.dom.Node;
import com.google.inject.Inject;
+/**
+ * Handles the os:If tag for osml.
+ */
public class IfTagHandler extends AbstractTagHandler {
static final String TAG_IF = "If";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AccelUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AccelUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AccelUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AccelUriManager.java Wed Sep 1 22:03:35 2010
@@ -25,6 +25,8 @@ import org.apache.shindig.gadgets.http.H
/**
* UriManager for Accel servlet.
+ *
+ * @since 2.0.0
*/
@ImplementedBy(DefaultAccelUriManager.class)
public interface AccelUriManager {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AllJsIframeVersioner.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AllJsIframeVersioner.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AllJsIframeVersioner.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/AllJsIframeVersioner.java Wed Sep 1 22:03:35 2010
@@ -30,12 +30,12 @@ import com.google.inject.Inject;
* Simple, but naive, implementation of an IFRAME version generator that
* returns the same version value for all renders: the hash of all JS in the
* feature system. This serves as an implicit version of the whole build.
- *
+ *
* While often a reasonable heuristic, use of this versioner completely
* ignores code changes. For instance, a rewriter may be deployed, yet
* if no JS changed, it would never run since a generated/versioned URL
* would cache the previously-generated render.
- *
+ *
* More sophisticated Versioner implementations may take these sorts of
* scenarios into consideration, and even go further, retrieving the
* referenced gadget from the GadgetSpecFactory. Such an implementation's
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ConcatUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ConcatUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ConcatUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ConcatUriManager.java Wed Sep 1 22:03:35 2010
@@ -27,6 +27,11 @@ import org.apache.shindig.gadgets.Gadget
import java.util.List;
import java.util.Map;
+/**
+ * Generates concat servlet specific uris.
+ *
+ * @since 2.0.0
+ */
public interface ConcatUriManager {
public enum Type {
JS("text/javascript", "src", "js", "script"), // JavaScript
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultAccelUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultAccelUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultAccelUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultAccelUriManager.java Wed Sep 1 22:03:35 2010
@@ -31,6 +31,8 @@ import org.apache.shindig.gadgets.rewrit
/**
* Default UriManager for Accel servlet.
* TODO: Add support for multiple accel hosts.
+ *
+ * @since 2.0.0
*/
public class DefaultAccelUriManager implements AccelUriManager {
final String accelHost;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultConcatUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultConcatUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultConcatUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultConcatUriManager.java Wed Sep 1 22:03:35 2010
@@ -34,6 +34,11 @@ import java.util.Iterator;
import java.util.List;
import java.util.Map;
+/**
+ * Default implementation of a ConcatUriManager
+ *
+ * @since 2.0.0
+ */
public class DefaultConcatUriManager implements ConcatUriManager {
public static final String CONCAT_HOST_PARAM = "gadgets.uri.concat.host";
public static final String CONCAT_PATH_PARAM = "gadgets.uri.concat.path";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultIframeUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultIframeUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultIframeUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultIframeUriManager.java Wed Sep 1 22:03:35 2010
@@ -40,6 +40,9 @@ import java.util.Collection;
import java.util.Collections;
import java.util.List;
+/**
+ * Default implementetion of an IframeUriManager which references the /ifr endpoint.
+ */
public class DefaultIframeUriManager implements IframeUriManager {
// By default, fills in values that could otherwise be templated for client population.
private static final boolean DEFAULT_USE_TEMPLATES = false;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultProxyUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultProxyUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultProxyUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/DefaultProxyUriManager.java Wed Sep 1 22:03:35 2010
@@ -59,6 +59,8 @@ import java.util.Map;
* This implementation supports batched versioning as well. The old-style "fp"
* (fingerprint) parameter is not supported any longer; its functionality is assumed
* to be subsumed into the version param.
+ *
+ * @since 2.0.0
*/
public class DefaultProxyUriManager implements ProxyUriManager {
public static final String PROXY_HOST_PARAM = "gadgets.uri.proxy.host";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/HashShaLockedDomainPrefixGenerator.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/HashShaLockedDomainPrefixGenerator.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/HashShaLockedDomainPrefixGenerator.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/HashShaLockedDomainPrefixGenerator.java Wed Sep 1 22:03:35 2010
@@ -22,9 +22,12 @@ import org.apache.commons.codec.digest.D
import org.apache.shindig.common.util.Base32;
import org.apache.shindig.common.uri.Uri;
+/**
+ * A simple implementation of locked domain that hashes the gadgeturi as the prefix.
+ */
public class HashShaLockedDomainPrefixGenerator implements LockedDomainPrefixGenerator {
public String getLockedDomainPrefix(Uri gadgetUri) {
byte[] sha1 = DigestUtils.sha(gadgetUri.toString());
return new String(Base32.encodeBase32(sha1)); // a hash
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/IframeUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/IframeUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/IframeUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/IframeUriManager.java Wed Sep 1 22:03:35 2010
@@ -21,6 +21,9 @@ package org.apache.shindig.gadgets.uri;
import org.apache.shindig.common.uri.Uri;
import org.apache.shindig.gadgets.Gadget;
+/**
+ * Interface defining methods needed to generate iframe URL for the /ifr servlet.
+ */
public interface IframeUriManager {
/**
* Generates iframe urls for meta data service.
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/JsUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/JsUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/JsUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/JsUriManager.java Wed Sep 1 22:03:35 2010
@@ -27,6 +27,9 @@ import org.apache.shindig.gadgets.Gadget
import com.google.inject.ImplementedBy;
+/**
+ * Interface defining methods used to generate Uris for the /js servlet.
+ */
public interface JsUriManager {
/**
* @param gadget The gadget in which the requested JS will be externed.
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/LockedDomainPrefixGenerator.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/LockedDomainPrefixGenerator.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/LockedDomainPrefixGenerator.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/LockedDomainPrefixGenerator.java Wed Sep 1 22:03:35 2010
@@ -22,6 +22,9 @@ import org.apache.shindig.common.uri.Uri
import com.google.inject.ImplementedBy;
+/**
+ * Interface that defines how to lookup a prefix from a gadget uri.
+ */
@ImplementedBy(HashShaLockedDomainPrefixGenerator.class)
public interface LockedDomainPrefixGenerator {
String getLockedDomainPrefix(Uri gadgetUri);
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/OAuthUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/OAuthUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/OAuthUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/OAuthUriManager.java Wed Sep 1 22:03:35 2010
@@ -20,6 +20,9 @@ package org.apache.shindig.gadgets.uri;
import org.apache.shindig.common.uri.Uri;
+/**
+ * Methods used by the oauth proxy, currently only used for an OAuth callback.
+ */
public interface OAuthUriManager {
/**
* @return the OAuth Callback Uri on the provided host.
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriBase.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriBase.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriBase.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriBase.java Wed Sep 1 22:03:35 2010
@@ -30,6 +30,11 @@ import org.apache.shindig.gadgets.http.H
import org.apache.shindig.gadgets.http.HttpResponse;
import org.apache.shindig.gadgets.uri.UriCommon.Param;
+/**
+ * Represents state/config information for the proxy.
+ *
+ * @since 2.0.0
+ */
public class ProxyUriBase {
private UriStatus status = null;
private Integer refresh = null;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriManager.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriManager.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriManager.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/ProxyUriManager.java Wed Sep 1 22:03:35 2010
@@ -32,6 +32,10 @@ import org.apache.shindig.gadgets.uri.Ur
import java.util.List;
+/**
+ * Generates Uris used by the /proxy servlet
+ * @since 2.0.0
+ */
public interface ProxyUriManager {
/**
* Generate a Uri that proxies the given resource Uri.
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriCommon.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriCommon.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriCommon.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriCommon.java Wed Sep 1 22:03:35 2010
@@ -18,6 +18,10 @@
*/
package org.apache.shindig.gadgets.uri;
+/**
+ * Common class used for all Uri params. Makes it very easy to find classes that
+ * use an affected parameter and to insure against duplicates.
+ */
public interface UriCommon {
public static final String USER_PREF_PREFIX = "up_";
public enum Param {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriModule.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriModule.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriModule.java Wed Sep 1 22:03:35 2010
@@ -23,6 +23,8 @@ import com.google.inject.util.Providers;
/**
* Provides default configuration and bindings for Uri classes.
+ *
+ * @since 2.0.0
*/
public class UriModule extends AbstractModule {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriStatus.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriStatus.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriStatus.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriStatus.java Wed Sep 1 22:03:35 2010
@@ -18,6 +18,9 @@
*/
package org.apache.shindig.gadgets.uri;
+/**
+ * Contains all states of a Uri - versioned/unversioned, etc.
+ */
public enum UriStatus {
VALID_VERSIONED,
VALID_UNVERSIONED,
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriUtils.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriUtils.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriUtils.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/uri/UriUtils.java Wed Sep 1 22:03:35 2010
@@ -34,6 +34,8 @@ import java.util.logging.Logger;
/**
* Utility functions related to URI and Http servlet response management.
+ *
+ * @since 2.0.0
*/
public final class UriUtils {
public static final String CHARSET = "charset";
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/MessageSubstituter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/MessageSubstituter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/MessageSubstituter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/MessageSubstituter.java Wed Sep 1 22:03:35 2010
@@ -27,6 +27,8 @@ import org.apache.shindig.gadgets.spec.M
/**
* Provides static hangman substitutions for message bundles.
+ *
+ * @since 2.0.0
*/
public class MessageSubstituter implements Substituter {
private final MessageBundleFactory messageBundleFactory;
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/ModuleSubstituter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/ModuleSubstituter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/ModuleSubstituter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/ModuleSubstituter.java Wed Sep 1 22:03:35 2010
@@ -23,6 +23,8 @@ import org.apache.shindig.gadgets.spec.G
/**
* Provides hangman substitution variables related to the Module (i.e. __MODULE_ID__)
+ *
+ * @since 2.0.0
*/
public class ModuleSubstituter implements Substituter {
public void addSubstitutions(Substitutions substituter, GadgetContext context, GadgetSpec spec)
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/Substituter.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/Substituter.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/Substituter.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/Substituter.java Wed Sep 1 22:03:35 2010
@@ -24,6 +24,8 @@ import org.apache.shindig.gadgets.spec.G
/**
* Substituter that provides variables to {@link VariableSubstituter}.
+ *
+ * @since 2.0.0
*/
public interface Substituter {
Modified: shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/SubstituterModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/SubstituterModule.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/SubstituterModule.java (original)
+++ shindig/trunk/java/gadgets/src/main/java/org/apache/shindig/gadgets/variables/SubstituterModule.java Wed Sep 1 22:03:35 2010
@@ -29,6 +29,8 @@ import com.google.inject.name.Names;
/**
* Guice bindings for the variables package.
+ *
+ * @since 2.0.0
*/
public class SubstituterModule extends AbstractModule {
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AccountImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AccountImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AccountImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AccountImpl.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@ package org.apache.shindig.social.core.m
import org.apache.shindig.social.opensocial.model.Account;
+/**
+ * Default Implementation of an {@link org.apache.shindig.social.opensocial.model.Account}
+ */
public class AccountImpl implements Account {
private String domain;
private String userId;
@@ -36,6 +39,7 @@ public class AccountImpl implements Acco
return domain;
}
+ /** {@inheritDoc} */
public void setDomain(String domain) {
this.domain = domain;
}
@@ -44,6 +48,7 @@ public class AccountImpl implements Acco
return userId;
}
+ /** {@inheritDoc} */
public void setUserId(String userId) {
this.userId = userId;
}
@@ -52,6 +57,7 @@ public class AccountImpl implements Acco
return username;
}
+ /** {@inheritDoc} */
public void setUsername(String username) {
this.username = username;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ActivityImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ActivityImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ActivityImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ActivityImpl.java Wed Sep 1 22:03:35 2010
@@ -24,6 +24,9 @@ import java.util.Date;
import java.util.List;
import java.util.Map;
+/**
+ * Default implementation of an {@link org.apache.shindig.social.opensocial.model.Activity}
+ */
public class ActivityImpl implements Activity {
private String appId;
@@ -100,6 +103,7 @@ public class ActivityImpl implements Act
return new Date(updated.getTime());
}
+ /** {@inheritDoc} */
public void setUpdated(Date updated) {
if (updated == null) {
this.updated = null;
@@ -112,6 +116,7 @@ public class ActivityImpl implements Act
return mediaItems;
}
+ /** {@inheritDoc} */
public void setMediaItems(List<MediaItem> mediaItems) {
this.mediaItems = mediaItems;
}
@@ -120,6 +125,7 @@ public class ActivityImpl implements Act
return postedTime;
}
+ /** {@inheritDoc} */
public void setPostedTime(Long postedTime) {
this.postedTime = postedTime;
}
@@ -128,6 +134,7 @@ public class ActivityImpl implements Act
return priority;
}
+ /** {@inheritDoc} */
public void setPriority(Float priority) {
this.priority = priority;
}
@@ -136,6 +143,7 @@ public class ActivityImpl implements Act
return streamFaviconUrl;
}
+ /** {@inheritDoc} */
public void setStreamFaviconUrl(String streamFaviconUrl) {
this.streamFaviconUrl = streamFaviconUrl;
}
@@ -144,6 +152,7 @@ public class ActivityImpl implements Act
return streamSourceUrl;
}
+ /** {@inheritDoc} */
public void setStreamSourceUrl(String streamSourceUrl) {
this.streamSourceUrl = streamSourceUrl;
}
@@ -152,6 +161,7 @@ public class ActivityImpl implements Act
return streamTitle;
}
+ /** {@inheritDoc} */
public void setStreamTitle(String streamTitle) {
this.streamTitle = streamTitle;
}
@@ -160,6 +170,7 @@ public class ActivityImpl implements Act
return streamUrl;
}
+ /** {@inheritDoc} */
public void setStreamUrl(String streamUrl) {
this.streamUrl = streamUrl;
}
@@ -168,6 +179,7 @@ public class ActivityImpl implements Act
return templateParams;
}
+ /** {@inheritDoc} */
public void setTemplateParams(Map<String, String> templateParams) {
this.templateParams = templateParams;
}
@@ -176,6 +188,7 @@ public class ActivityImpl implements Act
return title;
}
+ /** {@inheritDoc} */
public void setTitle(String title) {
this.title = title;
}
@@ -184,6 +197,7 @@ public class ActivityImpl implements Act
return titleId;
}
+ /** {@inheritDoc} */
public void setTitleId(String titleId) {
this.titleId = titleId;
}
@@ -192,6 +206,7 @@ public class ActivityImpl implements Act
return url;
}
+ /** {@inheritDoc} */
public void setUrl(String url) {
this.url = url;
}
@@ -200,6 +215,7 @@ public class ActivityImpl implements Act
return userId;
}
+ /** {@inheritDoc} */
public void setUserId(String userId) {
this.userId = userId;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AddressImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AddressImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AddressImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AddressImpl.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@ package org.apache.shindig.social.core.m
import org.apache.shindig.social.opensocial.model.Address;
+/**
+ * Default representation of an {@link org.apache.shindig.social.opensocial.model.Address}
+ */
public class AddressImpl implements Address {
private String country;
private Float latitude;
@@ -41,6 +44,7 @@ public class AddressImpl implements Addr
return country;
}
+ /** {@inheritDoc} */
public void setCountry(String country) {
this.country = country;
}
@@ -49,6 +53,7 @@ public class AddressImpl implements Addr
return latitude;
}
+ /** {@inheritDoc} */
public void setLatitude(Float latitude) {
this.latitude = latitude;
}
@@ -57,6 +62,7 @@ public class AddressImpl implements Addr
return locality;
}
+ /** {@inheritDoc} */
public void setLocality(String locality) {
this.locality = locality;
}
@@ -65,6 +71,7 @@ public class AddressImpl implements Addr
return longitude;
}
+ /** {@inheritDoc} */
public void setLongitude(Float longitude) {
this.longitude = longitude;
}
@@ -73,6 +80,7 @@ public class AddressImpl implements Addr
return postalCode;
}
+ /** {@inheritDoc} */
public void setPostalCode(String postalCode) {
this.postalCode = postalCode;
}
@@ -81,6 +89,7 @@ public class AddressImpl implements Addr
return region;
}
+ /** {@inheritDoc} */
public void setRegion(String region) {
this.region = region;
}
@@ -89,6 +98,7 @@ public class AddressImpl implements Addr
return streetAddress;
}
+ /** {@inheritDoc} */
public void setStreetAddress(String streetAddress) {
this.streetAddress = streetAddress;
}
@@ -97,6 +107,7 @@ public class AddressImpl implements Addr
return type;
}
+ /** {@inheritDoc} */
public void setType(String type) {
this.type = type;
}
@@ -105,6 +116,7 @@ public class AddressImpl implements Addr
return formatted;
}
+ /** {@inheritDoc} */
public void setFormatted(String formatted) {
this.formatted = formatted;
}
@@ -113,6 +125,7 @@ public class AddressImpl implements Addr
return primary;
}
+ /** {@inheritDoc} */
public void setPrimary(Boolean primary) {
this.primary = primary;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AlbumImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AlbumImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AlbumImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/AlbumImpl.java Wed Sep 1 22:03:35 2010
@@ -24,7 +24,9 @@ import org.apache.shindig.social.opensoc
import java.util.List;
/**
- * Default Implementation of the Album object in the model.
+ * Default Implementation of the {@link org.apache.shindig.social.opensocial.model.Album} object in the model.
+ *
+ * @since 2.0.0
*/
public class AlbumImpl implements Album {
private String description;
@@ -44,6 +46,7 @@ public class AlbumImpl implements Album
return description;
}
+ /** {@inheritDoc} */
public void setDescription(String description) {
this.description = description;
}
@@ -52,6 +55,7 @@ public class AlbumImpl implements Album
return id;
}
+ /** {@inheritDoc} */
public void setId(String id) {
this.id = id;
}
@@ -60,6 +64,7 @@ public class AlbumImpl implements Album
return location;
}
+ /** {@inheritDoc} */
public void setLocation(Address location) {
this.location = location;
}
@@ -68,6 +73,7 @@ public class AlbumImpl implements Album
return mediaItemCount;
}
+ /** {@inheritDoc} */
public void setMediaItemCount(Integer mediaItemCount) {
this.mediaItemCount = mediaItemCount;
}
@@ -76,6 +82,7 @@ public class AlbumImpl implements Album
return mediaMimeType;
}
+ /** {@inheritDoc} */
public void setMediaMimeType(List<String> mediaMimeType) {
this.mediaMimeType = mediaMimeType;
}
@@ -84,6 +91,7 @@ public class AlbumImpl implements Album
return mediaType;
}
+ /** {@inheritDoc} */
public void setMediaType(List<MediaItem.Type> mediaType) {
this.mediaType = mediaType;
}
@@ -92,6 +100,7 @@ public class AlbumImpl implements Album
return ownerId;
}
+ /** {@inheritDoc} */
public void setOwnerId(String ownerId) {
this.ownerId = ownerId;
}
@@ -100,6 +109,7 @@ public class AlbumImpl implements Album
return thumbnailUrl;
}
+ /** {@inheritDoc} */
public void setThumbnailUrl(String thumbnailUrl) {
this.thumbnailUrl = thumbnailUrl;
}
@@ -108,6 +118,7 @@ public class AlbumImpl implements Album
return title;
}
+ /** {@inheritDoc} */
public void setTitle(String title) {
this.title = title;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/BodyTypeImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/BodyTypeImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/BodyTypeImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/BodyTypeImpl.java Wed Sep 1 22:03:35 2010
@@ -23,7 +23,6 @@ import org.apache.shindig.social.opensoc
* see
* <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.BodyType">
* http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.BodyType</a>.
- *
*/
public class BodyTypeImpl implements BodyType {
@@ -37,6 +36,7 @@ public class BodyTypeImpl implements Bod
return build;
}
+ /** {@inheritDoc} */
public void setBuild(String build) {
this.build = build;
}
@@ -45,6 +45,7 @@ public class BodyTypeImpl implements Bod
return eyeColor;
}
+ /** {@inheritDoc} */
public void setEyeColor(String eyeColor) {
this.eyeColor = eyeColor;
}
@@ -53,6 +54,7 @@ public class BodyTypeImpl implements Bod
return hairColor;
}
+ /** {@inheritDoc} */
public void setHairColor(String hairColor) {
this.hairColor = hairColor;
}
@@ -61,6 +63,7 @@ public class BodyTypeImpl implements Bod
return height;
}
+ /** {@inheritDoc} */
public void setHeight(Float height) {
this.height = height;
}
@@ -69,6 +72,7 @@ public class BodyTypeImpl implements Bod
return weight;
}
+ /** {@inheritDoc} */
public void setWeight(Float weight) {
this.weight = weight;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/GroupImpl.java Wed Sep 1 22:03:35 2010
@@ -21,6 +21,11 @@ package org.apache.shindig.social.core.m
import org.apache.shindig.social.opensocial.model.Group;
import org.apache.shindig.social.opensocial.spi.GroupId;
+/**
+ * Default Implementation of the {@link org.apache.shindig.social.opensocial.model.Group} model.
+ *
+ * @since 2.0.0
+ */
public class GroupImpl implements Group {
private GroupId groupId;
@@ -31,6 +36,7 @@ public class GroupImpl implements Group
return title;
}
+ /** {@inheritDoc} */
public void setTitle(String title) {
this.title = title;
}
@@ -39,10 +45,12 @@ public class GroupImpl implements Group
return description;
}
+ /** {@inheritDoc} */
public void setDescription(String description) {
this.description = description;
}
+ /** {@inheritDoc} */
public void setId(GroupId groupId) {
this.groupId = groupId;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ListFieldImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ListFieldImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ListFieldImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/ListFieldImpl.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@ package org.apache.shindig.social.core.m
import org.apache.shindig.social.opensocial.model.ListField;
+/**
+ * ListField data structure
+ */
public class ListFieldImpl implements ListField {
private String type;
private String value;
@@ -35,6 +38,7 @@ public class ListFieldImpl implements Li
return type;
}
+ /** {@inheritDoc} */
public void setType(String type) {
this.type = type;
}
@@ -43,6 +47,7 @@ public class ListFieldImpl implements Li
return value;
}
+ /** {@inheritDoc} */
public void setValue(String value) {
this.value = value;
}
@@ -51,6 +56,7 @@ public class ListFieldImpl implements Li
return primary;
}
+ /** {@inheritDoc} */
public void setPrimary(Boolean primary) {
this.primary = primary;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MediaItemImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MediaItemImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MediaItemImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MediaItemImpl.java Wed Sep 1 22:03:35 2010
@@ -24,7 +24,6 @@ import org.apache.shindig.social.opensoc
* see
* <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/OpenSocial-Specification.html#opensocial.MediaItem.Field">
* opensocial.MediaItem.Field</a>
- *
*/
public class MediaItemImpl implements MediaItem {
private String albumId;
@@ -62,6 +61,7 @@ public class MediaItemImpl implements Me
return mimeType;
}
+ /** {@inheritDoc} */
public void setMimeType(String mimeType) {
this.mimeType = mimeType;
}
@@ -78,6 +78,7 @@ public class MediaItemImpl implements Me
return url;
}
+ /** {@inheritDoc} */
public void setUrl(String url) {
this.url = url;
}
@@ -86,6 +87,7 @@ public class MediaItemImpl implements Me
return this.thumbnailUrl;
}
+ /** {@inheritDoc} */
public void setThumbnailUrl(String url) {
this.thumbnailUrl = url;
}
@@ -94,6 +96,7 @@ public class MediaItemImpl implements Me
return albumId;
}
+ /** {@inheritDoc} */
public void setAlbumId(String albumId) {
this.albumId = albumId;
}
@@ -102,6 +105,7 @@ public class MediaItemImpl implements Me
return created;
}
+ /** {@inheritDoc} */
public void setCreated(String created) {
this.created = created;
}
@@ -110,6 +114,7 @@ public class MediaItemImpl implements Me
return description;
}
+ /** {@inheritDoc} */
public void setDescription(String description) {
this.description = description;
}
@@ -118,6 +123,7 @@ public class MediaItemImpl implements Me
return duration;
}
+ /** {@inheritDoc} */
public void setDuration(String duration) {
this.duration = duration;
}
@@ -126,6 +132,7 @@ public class MediaItemImpl implements Me
return fileSize;
}
+ /** {@inheritDoc} */
public void setFileSize(String fileSize) {
this.fileSize = fileSize;
}
@@ -134,6 +141,7 @@ public class MediaItemImpl implements Me
return id;
}
+ /** {@inheritDoc} */
public void setId(String id) {
this.id = id;
}
@@ -142,6 +150,7 @@ public class MediaItemImpl implements Me
return language;
}
+ /** {@inheritDoc} */
public void setLanguage(String language) {
this.language = language;
}
@@ -150,6 +159,7 @@ public class MediaItemImpl implements Me
return lastUpdated;
}
+ /** {@inheritDoc} */
public void setLastUpdated(String lastUpdated) {
this.lastUpdated = lastUpdated;
}
@@ -158,6 +168,7 @@ public class MediaItemImpl implements Me
return location;
}
+ /** {@inheritDoc} */
public void setLocation(Address location) {
this.location = location;
}
@@ -166,6 +177,7 @@ public class MediaItemImpl implements Me
return numComments;
}
+ /** {@inheritDoc} */
public void setNumComments(String numComments) {
this.numComments = numComments;
}
@@ -174,6 +186,7 @@ public class MediaItemImpl implements Me
return numViews;
}
+ /** {@inheritDoc} */
public void setNumViews(String numViews) {
this.numViews = numViews;
}
@@ -182,6 +195,7 @@ public class MediaItemImpl implements Me
return numVotes;
}
+ /** {@inheritDoc} */
public void setNumVotes(String numVotes) {
this.numVotes = numVotes;
}
@@ -190,6 +204,7 @@ public class MediaItemImpl implements Me
return rating;
}
+ /** {@inheritDoc} */
public void setRating(String rating) {
this.rating = rating;
}
@@ -198,6 +213,7 @@ public class MediaItemImpl implements Me
return startTime;
}
+ /** {@inheritDoc} */
public void setStartTime(String startTime) {
this.startTime = startTime;
}
@@ -206,6 +222,7 @@ public class MediaItemImpl implements Me
return taggedPeople;
}
+ /** {@inheritDoc} */
public void setTaggedPeople(String taggedPeople) {
this.taggedPeople = taggedPeople;
}
@@ -214,6 +231,7 @@ public class MediaItemImpl implements Me
return tags;
}
+ /** {@inheritDoc} */
public void setTags(String tags) {
this.tags = tags;
}
@@ -221,6 +239,7 @@ public class MediaItemImpl implements Me
public String getTitle() {
return title;
}
+ /** {@inheritDoc} */
public void setTitle(String title) {
this.title = title;
}
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageCollectionImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageCollectionImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageCollectionImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageCollectionImpl.java Wed Sep 1 22:03:35 2010
@@ -23,6 +23,9 @@ import org.apache.shindig.social.opensoc
import java.util.Date;
import java.util.List;
+/**
+ * Default representation of a MessageCollection
+ */
public class MessageCollectionImpl implements MessageCollection {
private String id;
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/MessageImpl.java Wed Sep 1 22:03:35 2010
@@ -23,6 +23,9 @@ import java.util.Date;
import org.apache.shindig.social.opensocial.model.Message;
import org.apache.shindig.social.opensocial.model.Url;
+/**
+ * Default implementation for a {@link org.apache.shindig.social.opensocial.model.Message}
+ */
public final class MessageImpl implements Message {
private String appUrl;
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/NameImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/NameImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/NameImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/NameImpl.java Wed Sep 1 22:03:35 2010
@@ -19,6 +19,9 @@ package org.apache.shindig.social.core.m
import org.apache.shindig.social.opensocial.model.Name;
+/**
+ * Default implementation of the {@link org.apache.shindig.social.opensocial.model.Name} model.
+ */
public class NameImpl implements Name {
private String additionalName;
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/OrganizationImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/OrganizationImpl.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/OrganizationImpl.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/OrganizationImpl.java Wed Sep 1 22:03:35 2010
@@ -22,6 +22,9 @@ import org.apache.shindig.social.opensoc
import java.util.Date;
+/**
+ * Default implementation of an Organization
+ */
public class OrganizationImpl implements Organization {
private Address address;
private String description;
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/AuthenticationHandlerProvider.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/AuthenticationHandlerProvider.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/AuthenticationHandlerProvider.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/AuthenticationHandlerProvider.java Wed Sep 1 22:03:35 2010
@@ -27,6 +27,9 @@ import org.apache.shindig.auth.UrlParame
import java.util.List;
+/**
+ * Guice provider of an ordered list of Auntentication Providers
+ */
public class AuthenticationHandlerProvider implements Provider<List<AuthenticationHandler>> {
protected List<AuthenticationHandler> handlers;
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/OAuthSecurityToken.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/OAuthSecurityToken.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/OAuthSecurityToken.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/OAuthSecurityToken.java Wed Sep 1 22:03:35 2010
@@ -21,6 +21,9 @@ import org.apache.shindig.auth.AbstractS
import org.apache.shindig.auth.AuthenticationMode;
import org.apache.shindig.auth.SecurityToken;
+/**
+ * A SecurityToken that represents two/three legged OAuth requests
+ */
public class OAuthSecurityToken extends AbstractSecurityToken implements SecurityToken {
private final String userId;
private final String appUrl;
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Activity.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Activity.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Activity.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Activity.java Wed Sep 1 22:03:35 2010
@@ -74,7 +74,6 @@ import java.util.Map;
* </msg>
* </messagebundle>
* </pre></code>
- *
*/
@ImplementedBy(ActivityImpl.class)
@Exportablebean
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Address.java Wed Sep 1 22:03:35 2010
@@ -31,7 +31,6 @@ import com.google.inject.ImplementedBy;
* Base interface for all address objects
* see <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Address">
* http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Address</a>.
- *
*/
@ImplementedBy(AddressImpl.class)
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Album.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Album.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Album.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Album.java Wed Sep 1 22:03:35 2010
@@ -27,12 +27,14 @@ import java.util.List;
/**
* <p>
* The Album API describes the collection of MediaItems of images, movies, and audio.
- * </p>
+ * </p>
* <p>
* Please see <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/OpenSocial-Specification.html#opensocial.Album.Field">
* http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/OpenSocial-Specification.html#opensocial.Album.Field</a>
* for details about the supported fields.
* </p>
+ *
+ * @since 2.0.0
*/
@ImplementedBy(AlbumImpl.class)
@Exportablebean
@@ -107,7 +109,7 @@ public interface Album {
/**
* Get address location of this album.
- *
+ *
* @return an Address specifying the location of this album.
*/
Address getLocation();
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/BodyType.java
URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/BodyType.java?rev=991727&r1=991726&r2=991727&view=diff
==============================================================================
--- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/BodyType.java (original)
+++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/BodyType.java Wed Sep 1 22:03:35 2010
@@ -26,7 +26,6 @@ import com.google.inject.ImplementedBy;
* Base interface for all body type objects. see
* <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Person.Field.BODY_TYPE">
* http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Person.Field.BODY_TYPE</a>
- *
*/
@ImplementedBy(BodyTypeImpl.class)
@Exportablebean