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/07 01:07:31 UTC
svn commit: r993172 - in
/shindig/trunk/extras/src/main/java/org/apache/shindig/extras: ./ as/
as/core/model/ as/opensocial/model/ as/opensocial/service/
as/opensocial/spi/ as/sample/
Author: lindner
Date: Mon Sep 6 23:07:31 2010
New Revision: 993172
URL: http://svn.apache.org/viewvc?rev=993172&view=rev
Log:
Improve the extras javadoc
Modified:
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/ShindigExtrasGuiceModule.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/ActivityStreamsGuiceModule.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActionLinkImpl.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityEntryImpl.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityObjectImpl.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityStreamImpl.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/MediaLinkImpl.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActionLink.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityEntry.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityObject.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityStream.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/MediaLink.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/service/ActivityStreamsHandler.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/spi/ActivityStreamService.java
shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/sample/ActivityStreamsJsonDbService.java
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/ShindigExtrasGuiceModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/ShindigExtrasGuiceModule.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/ShindigExtrasGuiceModule.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/ShindigExtrasGuiceModule.java Mon Sep 6 23:07:31 2010
@@ -24,14 +24,18 @@ import com.google.inject.multibindings.M
import com.google.inject.name.Names;
/**
- * Configures the Extra modules in shindig-extras.
+ * Configures the Extra modules in shindig-extras.
*/
public class ShindigExtrasGuiceModule extends AbstractModule {
+ /** {@inheritDoc} */
@Override
protected void configure() {
configureExtraFeatures();
}
+ /**
+ * Adds the features-extras directory to the search path
+ */
protected void configureExtraFeatures() {
// This is how you add search paths for features.
Multibinder<String> featureBinder = Multibinder.newSetBinder(binder(), String.class, Names.named("org.apache.shindig.features-extended"));
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/ActivityStreamsGuiceModule.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/ActivityStreamsGuiceModule.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/ActivityStreamsGuiceModule.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/ActivityStreamsGuiceModule.java Mon Sep 6 23:07:31 2010
@@ -30,6 +30,7 @@ import org.apache.shindig.extras.as.samp
* Configures the Extra modules in shindig-extras.
*/
public class ActivityStreamsGuiceModule extends AbstractModule {
+ /** {@inheritDoc} */
@Override
protected void configure() {
bind(ActivityStreamService.class).to(ActivityStreamsJsonDbService.class);
@@ -37,4 +38,4 @@ public class ActivityStreamsGuiceModule
Multibinder<Object> handlerBinder = Multibinder.newSetBinder(binder(), Object.class, Names.named("org.apache.shindig.handlers"));
handlerBinder.addBinding().toInstance(ActivityStreamsHandler.class);
}
-}
\ No newline at end of file
+}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActionLinkImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActionLinkImpl.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActionLinkImpl.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActionLinkImpl.java Mon Sep 6 23:07:31 2010
@@ -19,29 +19,39 @@ package org.apache.shindig.extras.as.cor
import org.apache.shindig.extras.as.opensocial.model.ActionLink;
+/**
+ * A simple implementation of an ActionLink used by ActivityStreams.
+ */
public class ActionLinkImpl implements ActionLink {
- private String target;
- private String caption;
-
- public ActionLinkImpl() {
- this.target = null;
- this.caption = null;
- }
-
- public String getTarget() {
- return target;
- }
-
- public void setTarget(String target) {
- this.target = target;
- }
-
- public String getCaption() {
- return caption;
- }
-
- public void setCaption(String caption) {
- this.caption = caption;
- }
+ private String target;
+ private String caption;
+
+ /**
+ * Construct an empty ActionLinkImpl
+ */
+ public ActionLinkImpl() {
+ this.target = null;
+ this.caption = null;
+ }
+
+ /** {@inheritDoc} */
+ public String getTarget() {
+ return target;
+ }
+
+ /** {@inheritDoc} */
+ public void setTarget(String target) {
+ this.target = target;
+ }
+
+ /** {@inheritDoc} */
+ public String getCaption() {
+ return caption;
+ }
+
+ /** {@inheritDoc} */
+ public void setCaption(String caption) {
+ this.caption = caption;
+ }
}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityEntryImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityEntryImpl.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityEntryImpl.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityEntryImpl.java Mon Sep 6 23:07:31 2010
@@ -23,119 +23,148 @@ import java.util.List;
import org.apache.shindig.extras.as.opensocial.model.ActivityEntry;
import org.apache.shindig.extras.as.opensocial.model.ActivityObject;
+/**
+ * A simple bean implementation of an ActivityStream Entry.
+ *
+ */
public class ActivityEntryImpl implements ActivityEntry {
- private String icon;
- private String time;
- private ActivityObject actor;
- private List<String> verb;
- private ActivityObject object;
- private ActivityObject target;
- private ActivityObject generator;
- private ActivityObject serviceProvider;
- private String title;
- private String body;
- private List<String> standardLink;
-
- public ActivityEntryImpl() {
- this.icon = null;
- this.time = null;
- this.actor = null;
- this.verb = null;
- this.object = null;
- this.target = null;
- this.generator = null;
- this.serviceProvider = null;
- this.title = null;
- this.body = null;
- this.standardLink = null;
- }
-
- public String getIcon() {
- return icon;
- }
-
- public void setIcon(String icon) {
- this.icon = icon;
- }
-
- public String getTime() {
- return time;
- }
-
- public void setTime(String time) {
- this.time = time;
- }
-
- public ActivityObject getActor() {
- return actor;
- }
-
- public void setActor(ActivityObject actor) {
- this.actor = actor;
- }
-
- public List<String> getVerb() {
- return verb;
- }
-
- public void setVerb(List<String> verb) {
- this.verb = verb;
- }
-
- public ActivityObject getObject() {
- return object;
- }
-
- public void setObject(ActivityObject object) {
- this.object = object;
- }
-
- public ActivityObject getTarget() {
- return target;
- }
-
- public void setTarget(ActivityObject target) {
- this.target = target;
- }
-
- public ActivityObject getGenerator() {
- return generator;
- }
-
- public void setGenerator(ActivityObject generator) {
- this.generator = generator;
- }
-
- public ActivityObject getServiceProvider() {
- return serviceProvider;
- }
-
- public void setServiceProvider(ActivityObject serviceProvider) {
- this.serviceProvider = serviceProvider;
- }
-
- public String getTitle() {
- return title;
- }
-
- public void setTitle(String title) {
- this.title = title;
- }
-
- public String getBody() {
- return body;
- }
-
- public void setBody(String body) {
- this.body = body;
- }
-
- public List<String> getStandardLink() {
- return standardLink;
- }
-
- public void setStandardLink(List<String> standardLink) {
- this.standardLink = standardLink;
- }
+ private String icon;
+ private String time;
+ private ActivityObject actor;
+ private List<String> verb;
+ private ActivityObject object;
+ private ActivityObject target;
+ private ActivityObject generator;
+ private ActivityObject serviceProvider;
+ private String title;
+ private String body;
+ private List<String> standardLink;
+
+ /**
+ * Create a new empty ActivityEntry
+ */
+ public ActivityEntryImpl() {
+ this.icon = null;
+ this.time = null;
+ this.actor = null;
+ this.verb = null;
+ this.object = null;
+ this.target = null;
+ this.generator = null;
+ this.serviceProvider = null;
+ this.title = null;
+ this.body = null;
+ this.standardLink = null;
+ }
+
+ /** {@inheritDoc} */
+ public String getIcon() {
+ return icon;
+ }
+
+ /** {@inheritDoc} */
+ public void setIcon(String icon) {
+ this.icon = icon;
+ }
+
+ /** {@inheritDoc} */
+ public String getTime() {
+ return time;
+ }
+
+ /** {@inheritDoc} */
+ public void setTime(String time) {
+ this.time = time;
+ }
+
+ /** {@inheritDoc} */
+ public ActivityObject getActor() {
+ return actor;
+ }
+
+ /** {@inheritDoc} */
+ public void setActor(ActivityObject actor) {
+ this.actor = actor;
+ }
+
+ /** {@inheritDoc} */
+ public List<String> getVerb() {
+ return verb;
+ }
+
+ /** {@inheritDoc} */
+ public void setVerb(List<String> verb) {
+ this.verb = verb;
+ }
+
+ /** {@inheritDoc} */
+ public ActivityObject getObject() {
+ return object;
+ }
+
+ /** {@inheritDoc} */
+ public void setObject(ActivityObject object) {
+ this.object = object;
+ }
+
+ /** {@inheritDoc} */
+ public ActivityObject getTarget() {
+ return target;
+ }
+
+ /** {@inheritDoc} */
+ public void setTarget(ActivityObject target) {
+ this.target = target;
+ }
+
+ /** {@inheritDoc} */
+ public ActivityObject getGenerator() {
+ return generator;
+ }
+
+ /** {@inheritDoc} */
+ public void setGenerator(ActivityObject generator) {
+ this.generator = generator;
+ }
+
+ /** {@inheritDoc} */
+ public ActivityObject getServiceProvider() {
+ return serviceProvider;
+ }
+
+ /** {@inheritDoc} */
+ public void setServiceProvider(ActivityObject serviceProvider) {
+ this.serviceProvider = serviceProvider;
+ }
+
+ /** {@inheritDoc} */
+ public String getTitle() {
+ return title;
+ }
+
+ /** {@inheritDoc} */
+ public void setTitle(String title) {
+ this.title = title;
+ }
+
+ /** {@inheritDoc} */
+ public String getBody() {
+ return body;
+ }
+
+ /** {@inheritDoc} */
+ public void setBody(String body) {
+ this.body = body;
+ }
+
+ /** {@inheritDoc} */
+ public List<String> getStandardLink() {
+ return standardLink;
+ }
+
+ /** {@inheritDoc} */
+ public void setStandardLink(List<String> standardLink) {
+ this.standardLink = standardLink;
+ }
}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityObjectImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityObjectImpl.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityObjectImpl.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityObjectImpl.java Mon Sep 6 23:07:31 2010
@@ -24,149 +24,184 @@ import org.apache.shindig.extras.as.open
import org.apache.shindig.extras.as.opensocial.model.ActivityObject;
import org.apache.shindig.extras.as.opensocial.model.MediaLink;
+/**
+ * <p>ActivityObjectImpl class.</p>
+ *
+ */
public class ActivityObjectImpl implements ActivityObject {
-
- private String id;
- private String name;
- private String summary;
- private MediaLink media;
- private String permalink;
- private List<String> type;
- private ActivityObject inReplyTo;
- private List<ActivityObject> attached;
- private List<ActivityObject> reply;
- private List<ActivityObject> reaction;
- private ActionLink action;
- private List<String> upstreamDuplicateId;
- private List<String> downstreamDuplicateId;
- private String standardLink;
-
- public ActivityObjectImpl() {
- this.id = null;
- this.name = null;
- this.summary = null;
- this.media = null;
- this.permalink = null;
- this.type = null;
- this.inReplyTo = null;
- this.attached = null;
- this.reply = null;
- this.reaction = null;
- this.action = null;
- this.upstreamDuplicateId = null;
- this.downstreamDuplicateId = null;
- this.standardLink = null;
- }
-
- public String getId() {
- return id;
- }
-
- public void setId(String id) {
- this.id = id;
- }
-
- public String getName() {
- return name;
- }
-
- public void setName(String name) {
- this.name = name;
- }
-
- public String getSummary() {
- return summary;
- }
-
- public void setSummary(String summary) {
- this.summary = summary;
- }
-
- public MediaLink getMedia() {
- return media;
- }
-
- public void setMedia(MediaLink media) {
- this.media = media;
- }
-
- public String getPermalink() {
- return permalink;
- }
-
- public void setPermalink(String permalink) {
- this.permalink = permalink;
- }
-
- public List<String> getType() {
- return type;
- }
-
- public void setType(List<String> type) {
- this.type = type;
- }
-
- public ActivityObject getInReplyTo() {
- return inReplyTo;
- }
-
- public void setInReplyTo(ActivityObject inReplyTo) {
- this.inReplyTo = inReplyTo;
- }
-
- public List<ActivityObject> getAttached() {
- return attached;
- }
-
- public void setAttached(List<ActivityObject> attached) {
- this.attached = attached;
- }
-
- public List<ActivityObject> getReply() {
- return reply;
- }
-
- public void setReply(List<ActivityObject> reply) {
- this.reply = reply;
- }
-
- public List<ActivityObject> getReaction() {
- return reaction;
- }
-
- public void setReaction(List<ActivityObject> reaction) {
- this.reaction = reaction;
- }
-
- public ActionLink getAction() {
- return action;
- }
-
- public void setAction(ActionLink action) {
- this.action = action;
- }
-
- public List<String> getUpstreamDuplicateId() {
- return upstreamDuplicateId;
- }
-
- public void setUpstreamDuplicateId(List<String> upstreamDuplicateId) {
- this.upstreamDuplicateId = upstreamDuplicateId;
- }
-
- public List<String> getDownstreamDuplicateId() {
- return downstreamDuplicateId;
- }
-
- public void setDownstreamDuplicateId(List<String> downstreamDuplicateId) {
- this.downstreamDuplicateId = downstreamDuplicateId;
- }
-
- public String getStandardLink() {
- return standardLink;
- }
-
- public void setStandardLink(String standardLink) {
- this.standardLink = standardLink;
- }
+
+ private String id;
+ private String name;
+ private String summary;
+ private MediaLink media;
+ private String permalink;
+ private List<String> type;
+ private ActivityObject inReplyTo;
+ private List<ActivityObject> attached;
+ private List<ActivityObject> reply;
+ private List<ActivityObject> reaction;
+ private ActionLink action;
+ private List<String> upstreamDuplicateId;
+ private List<String> downstreamDuplicateId;
+ private String standardLink;
+
+ /**
+ * A simple implementation of an ActivtyObject
+ */
+ public ActivityObjectImpl() {
+ this.id = null;
+ this.name = null;
+ this.summary = null;
+ this.media = null;
+ this.permalink = null;
+ this.type = null;
+ this.inReplyTo = null;
+ this.attached = null;
+ this.reply = null;
+ this.reaction = null;
+ this.action = null;
+ this.upstreamDuplicateId = null;
+ this.downstreamDuplicateId = null;
+ this.standardLink = null;
+ }
+
+ /** {@inheritDoc} */
+ public String getId() {
+ return id;
+ }
+
+ /** {@inheritDoc} */
+ public void setId(String id) {
+ this.id = id;
+ }
+
+ /** {@inheritDoc} */
+ public String getName() {
+ return name;
+ }
+
+ /** {@inheritDoc} */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /** {@inheritDoc} */
+ public String getSummary() {
+ return summary;
+ }
+
+ /** {@inheritDoc} */
+ public void setSummary(String summary) {
+ this.summary = summary;
+ }
+
+ /** {@inheritDoc} */
+ public MediaLink getMedia() {
+ return media;
+ }
+
+ /** {@inheritDoc} */
+ public void setMedia(MediaLink media) {
+ this.media = media;
+ }
+
+ /** {@inheritDoc} */
+ public String getPermalink() {
+ return permalink;
+ }
+
+ /** {@inheritDoc} */
+ public void setPermalink(String permalink) {
+ this.permalink = permalink;
+ }
+
+ /** {@inheritDoc} */
+ public List<String> getType() {
+ return type;
+ }
+
+ /** {@inheritDoc} */
+ public void setType(List<String> type) {
+ this.type = type;
+ }
+
+ /** {@inheritDoc} */
+ public ActivityObject getInReplyTo() {
+ return inReplyTo;
+ }
+
+ /** {@inheritDoc} */
+ public void setInReplyTo(ActivityObject inReplyTo) {
+ this.inReplyTo = inReplyTo;
+ }
+
+ /** {@inheritDoc} */
+ public List<ActivityObject> getAttached() {
+ return attached;
+ }
+
+ /** {@inheritDoc} */
+ public void setAttached(List<ActivityObject> attached) {
+ this.attached = attached;
+ }
+
+ /** {@inheritDoc} */
+ public List<ActivityObject> getReply() {
+ return reply;
+ }
+
+ /** {@inheritDoc} */
+ public void setReply(List<ActivityObject> reply) {
+ this.reply = reply;
+ }
+
+ /** {@inheritDoc} */
+ public List<ActivityObject> getReaction() {
+ return reaction;
+ }
+
+ /** {@inheritDoc} */
+ public void setReaction(List<ActivityObject> reaction) {
+ this.reaction = reaction;
+ }
+
+ /** {@inheritDoc} */
+ public ActionLink getAction() {
+ return action;
+ }
+
+ /** {@inheritDoc} */
+ public void setAction(ActionLink action) {
+ this.action = action;
+ }
+
+ /** {@inheritDoc} */
+ public List<String> getUpstreamDuplicateId() {
+ return upstreamDuplicateId;
+ }
+
+ /** {@inheritDoc} */
+ public void setUpstreamDuplicateId(List<String> upstreamDuplicateId) {
+ this.upstreamDuplicateId = upstreamDuplicateId;
+ }
+
+ /** {@inheritDoc} */
+ public List<String> getDownstreamDuplicateId() {
+ return downstreamDuplicateId;
+ }
+
+ /** {@inheritDoc} */
+ public void setDownstreamDuplicateId(List<String> downstreamDuplicateId) {
+ this.downstreamDuplicateId = downstreamDuplicateId;
+ }
+
+ /** {@inheritDoc} */
+ public String getStandardLink() {
+ return standardLink;
+ }
+
+ /** {@inheritDoc} */
+ public void setStandardLink(String standardLink) {
+ this.standardLink = standardLink;
+ }
}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityStreamImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityStreamImpl.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityStreamImpl.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/ActivityStreamImpl.java Mon Sep 6 23:07:31 2010
@@ -23,59 +23,75 @@ import java.util.List;
import org.apache.shindig.extras.as.opensocial.model.ActivityEntry;
import org.apache.shindig.extras.as.opensocial.model.ActivityStream;
+/**
+ * A simple, bean-based version of an ActivityStream
+ */
public class ActivityStreamImpl implements ActivityStream {
- private String displayName;
- private String language;
- private List<ActivityEntry> entries;
- private String id;
- private String subject;
-
- public ActivityStreamImpl() {
- this.displayName = null;
- this.language = null;
- this.entries = null;
- this.id = null;
- this.subject = null;
- }
-
- public String getDisplayName() {
- return displayName;
- }
-
- public List<ActivityEntry> getEntries() {
- return entries;
- }
-
- public String getId() {
- return id;
- }
-
- public String getLanguage() {
- return language;
- }
-
- public String getSubject() {
- return subject;
- }
-
- public void setDisplayName(String displayName) {
- this.displayName = displayName;
- }
-
- public void setEntries(List<ActivityEntry> entries) {
- this.entries = entries;
- }
-
- public void setId(String id) {
- this.id = id;
- }
-
- public void setLanguage(String language) {
- this.language = language;
- }
-
- public void setSubject(String subject) {
- this.subject = subject;
- }
+ private String displayName;
+ private String language;
+ private List<ActivityEntry> entries;
+ private String id;
+ private String subject;
+
+ /**
+ * Create a new empty ActivityStream
+ */
+ public ActivityStreamImpl() {
+ this.displayName = null;
+ this.language = null;
+ this.entries = null;
+ this.id = null;
+ this.subject = null;
+ }
+
+ /** {@inheritDoc} */
+ public String getDisplayName() {
+ return displayName;
+ }
+
+ /** {@inheritDoc} */
+ public List<ActivityEntry> getEntries() {
+ return entries;
+ }
+
+ /** {@inheritDoc} */
+ public String getId() {
+ return id;
+ }
+
+ /** {@inheritDoc} */
+ public String getLanguage() {
+ return language;
+ }
+
+ /** {@inheritDoc} */
+ public String getSubject() {
+ return subject;
+ }
+
+ /** {@inheritDoc} */
+ public void setDisplayName(String displayName) {
+ this.displayName = displayName;
+ }
+
+ /** {@inheritDoc} */
+ public void setEntries(List<ActivityEntry> entries) {
+ this.entries = entries;
+ }
+
+ /** {@inheritDoc} */
+ public void setId(String id) {
+ this.id = id;
+ }
+
+ /** {@inheritDoc} */
+ public void setLanguage(String language) {
+ this.language = language;
+ }
+
+ /** {@inheritDoc} */
+ public void setSubject(String subject) {
+ this.subject = subject;
+ }
}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/MediaLinkImpl.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/MediaLinkImpl.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/MediaLinkImpl.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/core/model/MediaLinkImpl.java Mon Sep 6 23:07:31 2010
@@ -19,59 +19,76 @@ package org.apache.shindig.extras.as.cor
import org.apache.shindig.extras.as.opensocial.model.MediaLink;
+/**
+ * <p>MediaLinkImpl class.</p>
+ *
+ */
public class MediaLinkImpl implements MediaLink {
-
- private String target;
- private String type;
- private String width;
- private String height;
- private String duration;
-
- public MediaLinkImpl() {
- this.target = null;
- this.type = null;
- this.width = null;
- this.height = null;
- this.duration = null;
- }
-
- public String getTarget() {
- return target;
- }
-
- public void setTarget(String target) {
- this.target = target;
- }
-
- public String getType() {
- return type;
- }
-
- public void setType(String type) {
- this.type = type;
- }
-
- public String getWidth() {
- return width;
- }
-
- public void setWidth(String width) {
- this.width = width;
- }
-
- public String getHeight() {
- return height;
- }
-
- public void setHeight(String height) {
- this.height = height;
- }
-
- public String getDuration() {
- return duration;
- }
-
- public void setDuration(String duration) {
- this.duration = duration;
- }
+
+ private String target;
+ private String type;
+ private String width;
+ private String height;
+ private String duration;
+
+ /**
+ * Create a new MediaLink
+ */
+ public MediaLinkImpl() {
+ this.target = null;
+ this.type = null;
+ this.width = null;
+ this.height = null;
+ this.duration = null;
+ }
+
+ /** {@inheritDoc} */
+ public String getTarget() {
+ return target;
+ }
+
+ /** {@inheritDoc} */
+ public void setTarget(String target) {
+ this.target = target;
+ }
+
+ /** {@inheritDoc} */
+ public String getType() {
+ return type;
+ }
+
+ /** {@inheritDoc} */
+ public void setType(String type) {
+ this.type = type;
+ }
+
+ /** {@inheritDoc} */
+ public String getWidth() {
+ return width;
+ }
+
+ /** {@inheritDoc} */
+ public void setWidth(String width) {
+ this.width = width;
+ }
+
+ /** {@inheritDoc} */
+ public String getHeight() {
+ return height;
+ }
+
+ /** {@inheritDoc} */
+ public void setHeight(String height) {
+ this.height = height;
+ }
+
+ /** {@inheritDoc} */
+ public String getDuration() {
+ return duration;
+ }
+
+ /** {@inheritDoc} */
+ public void setDuration(String duration) {
+ this.duration = duration;
+ }
}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActionLink.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActionLink.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActionLink.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActionLink.java Mon Sep 6 23:07:31 2010
@@ -25,46 +25,70 @@ import com.google.inject.ImplementedBy;
/*
* TODO: comment this class.
*/
+/**
+ * <p>ActionLink interface.</p>
+ *
+ */
@ImplementedBy(ActionLinkImpl.class)
@Exportablebean
public interface ActionLink {
-
- /*
- * Fields that represent JSON elements for an activity entry.
- */
- public static enum Field {
- TARGET("target"),
- CAPTION("caption");
-
- /*
- * The name of the JSON element.
- */
- private final String jsonString;
-
- /*
- * Constructs the field base for the JSON element.
- *
- * @param jsonString the name of the element
- */
- private Field(String jsonString) {
- this.jsonString = jsonString;
- }
-
- /*
- * Returns the name of the JSON element.
- *
- * @return String the name of the JSON element
- */
- public String toString() {
- return jsonString;
- }
- }
-
- String getTarget();
+
+ /**
+ * Fields that represent JSON elements for an activity entry.
+ */
+ public static enum Field {
+ TARGET("target"),
+ CAPTION("caption");
+
+ /*
+ * The name of the JSON element.
+ */
+ private final String jsonString;
+
+ /*
+ * Constructs the field base for the JSON element.
+ *
+ * @param jsonString the name of the element
+ */
+ private Field(String jsonString) {
+ this.jsonString = jsonString;
+ }
+
+ /*
+ * Returns the name of the JSON element.
+ *
+ * @return String the name of the JSON element
+ */
+ public String toString() {
+ return jsonString;
+ }
+ }
+
+ /**
+ * Get the target of this action link
+ *
+ * @return a target
+ */
+ String getTarget();
- void setTarget(String target);
+ /**
+ * Set the target of this action link
+ *
+ * @param target a target
+ */
+ void setTarget(String target);
- String getCaption();
+ /**
+ * Get the caption for this action link.
+ *
+ * @return a caption
+ */
+ String getCaption();
- void setCaption(String caption);
+ /**
+ * Set the caption for this action link.
+ *
+ * @param caption a caption
+ */
+ void setCaption(String caption);
}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityEntry.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityEntry.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityEntry.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityEntry.java Mon Sep 6 23:07:31 2010
@@ -25,136 +25,248 @@ import org.apache.shindig.extras.as.core
import com.google.inject.ImplementedBy;
-/*
+/**
+ * <p>ActivityEntry interface.</p>
* TODO: comment a description for this class
* TODO: ensure verbs are up to date
* TODO: comment all classes
*/
+
@ImplementedBy(ActivityEntryImpl.class)
@Exportablebean
public interface ActivityEntry {
-
- /*
- * Fields that represent JSON elements for an activity entry.
- */
- public static enum Field {
- ICON("icon"),
- TIME("time"),
- ACTOR("actor"),
- VERB("verb"),
- OBJECT("object"),
- TARGET("target"),
- GENERATOR("generator"),
- SERVICE_PROVIDER("serviceProvider"),
- TITLE("title"),
- BODY("body"),
- STANDARD_LINK("standardLink");
-
- /*
- * The name of the JSON element.
- */
- private final String jsonString;
-
- /*
- * Constructs the field base for the JSON element.
- *
- * @param jsonString the name of the element
- */
- private Field(String jsonString) {
- this.jsonString = jsonString;
- }
-
- /*
- * Returns the name of the JSON element.
- *
- * @return String the name of the JSON element
- */
- public String toString() {
- return jsonString;
- }
- }
-
- /*
- * Possible verbs for an activity stream entry.
- */
- public static enum Verb {
- MARK_AS_FAVORITE("markAsFavorite"),
- START_FOLLOWING("startFollowing"),
- MARK_AS_LIKED("markAsLiked"),
- MAKE_FRIEND("makeFriend"),
- JOIN("join"),
- PLAY("play"),
- POST("post"),
- SAVE("save"),
- SHARE("share"),
- TAG("tag"),
- UPDATE("update");
-
- /*
- * The name of the JSON element.
- */
- private final String jsonString;
-
- /*
- * Constructs the field base for the JSON element.
- *
- * @param jsonString the name of the element
- */
- private Verb(String jsonString) {
- this.jsonString = jsonString;
- }
-
- /*
- * Returns the name of the JSON element.
- *
- * @return String the name of the JSON element
- */
- public String toString() {
- return jsonString;
- }
- }
-
- String getIcon();
-
- void setIcon(String icon);
-
- String getTime();
-
- void setTime(String time);
-
- ActivityObject getActor();
-
- void setActor(ActivityObject actor);
-
- List<String> getVerb();
-
- void setVerb(List<String> verb);
-
- ActivityObject getObject();
-
- void setObject(ActivityObject object);
-
- ActivityObject getTarget();
-
- void setTarget(ActivityObject target);
-
- ActivityObject getGenerator();
-
- void setGenerator(ActivityObject generator);
-
- ActivityObject getServiceProvider();
-
- void setServiceProvider(ActivityObject serviceProvider);
-
- String getTitle();
-
- void setTitle(String title);
-
- String getBody();
-
- void setBody(String body);
-
- List<String> getStandardLink();
-
- void setStandardLink(List<String> standardLink);
-}
\ No newline at end of file
+
+ /**
+ * Fields that represent JSON elements for an activity entry.
+ */
+ public static enum Field {
+ ICON("icon"),
+ TIME("time"),
+ ACTOR("actor"),
+ VERB("verb"),
+ OBJECT("object"),
+ TARGET("target"),
+ GENERATOR("generator"),
+ SERVICE_PROVIDER("serviceProvider"),
+ TITLE("title"),
+ BODY("body"),
+ STANDARD_LINK("standardLink");
+
+ /**
+ * The name of the JSON element.
+ */
+ private final String jsonString;
+
+ /**
+ * Constructs the field base for the JSON element.
+ *
+ * @param jsonString the name of the element
+ */
+ private Field(String jsonString) {
+ this.jsonString = jsonString;
+ }
+
+ /**
+ * Returns the name of the JSON element.
+ *
+ * @return String the name of the JSON element
+ */
+ public String toString() {
+ return jsonString;
+ }
+ }
+
+ /**
+ * Possible verbs for an activity stream entry.
+ */
+ public static enum Verb {
+ MARK_AS_FAVORITE("markAsFavorite"),
+ START_FOLLOWING("startFollowing"),
+ MARK_AS_LIKED("markAsLiked"),
+ MAKE_FRIEND("makeFriend"),
+ JOIN("join"),
+ PLAY("play"),
+ POST("post"),
+ SAVE("save"),
+ SHARE("share"),
+ TAG("tag"),
+ UPDATE("update");
+
+ /**
+ * The name of the JSON element.
+ */
+ private final String jsonString;
+
+ /**
+ * Constructs the field base for the JSON element.
+ *
+ * @param jsonString the name of the element
+ */
+ private Verb(String jsonString) {
+ this.jsonString = jsonString;
+ }
+
+ /**
+ * Returns the name of the JSON element.
+ *
+ * @return String the name of the JSON element
+ */
+ public String toString() {
+ return jsonString;
+ }
+ }
+
+ /**
+ * <p>getIcon</p>
+ *
+ * @return a {@link java.lang.String} object.
+ */
+ String getIcon();
+
+ /**
+ * <p>setIcon</p>
+ *
+ * @param icon a {@link java.lang.String} object.
+ */
+ void setIcon(String icon);
+
+ /**
+ * <p>getTime</p>
+ *
+ * @return a {@link java.lang.String} object.
+ */
+ String getTime();
+
+ /**
+ * <p>setTime</p>
+ *
+ * @param time a {@link java.lang.String} object.
+ */
+ void setTime(String time);
+
+ /**
+ * <p>getActor</p>
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ ActivityObject getActor();
+
+ /**
+ * <p>setActor</p>
+ *
+ * @param actor a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ void setActor(ActivityObject actor);
+
+ /**
+ * <p>getVerb</p>
+ *
+ * @return a {@link java.util.List} object.
+ */
+ List<String> getVerb();
+
+ /**
+ * <p>setVerb</p>
+ *
+ * @param verb a {@link java.util.List} object.
+ */
+ void setVerb(List<String> verb);
+
+ /**
+ * <p>getObject</p>
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ ActivityObject getObject();
+
+ /**
+ * <p>setObject</p>
+ *
+ * @param object a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ void setObject(ActivityObject object);
+
+ /**
+ * <p>getTarget</p>
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ ActivityObject getTarget();
+
+ /**
+ * <p>setTarget</p>
+ *
+ * @param target a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ void setTarget(ActivityObject target);
+
+ /**
+ * <p>getGenerator</p>
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ ActivityObject getGenerator();
+
+ /**
+ * <p>setGenerator</p>
+ *
+ * @param generator a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ void setGenerator(ActivityObject generator);
+
+ /**
+ * <p>getServiceProvider</p>
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ ActivityObject getServiceProvider();
+
+ /**
+ * <p>setServiceProvider</p>
+ *
+ * @param serviceProvider a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ void setServiceProvider(ActivityObject serviceProvider);
+
+ /**
+ * <p>getTitle</p>
+ *
+ * @return a {@link java.lang.String} object.
+ */
+ String getTitle();
+
+ /**
+ * <p>setTitle</p>
+ *
+ * @param title a {@link java.lang.String} object.
+ */
+ void setTitle(String title);
+
+ /**
+ * <p>getBody</p>
+ *
+ * @return a {@link java.lang.String} object.
+ */
+ String getBody();
+
+ /**
+ * <p>setBody</p>
+ *
+ * @param body a {@link java.lang.String} object.
+ */
+ void setBody(String body);
+
+ /**
+ * <p>getStandardLink</p>
+ *
+ * @return a {@link java.util.List} object.
+ */
+ List<String> getStandardLink();
+
+ /**
+ * <p>setStandardLink</p>
+ *
+ * @param standardLink a {@link java.util.List} object.
+ */
+ void setStandardLink(List<String> standardLink);
+}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityObject.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityObject.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityObject.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityObject.java Mon Sep 6 23:07:31 2010
@@ -25,106 +25,245 @@ import org.apache.shindig.extras.as.core
import com.google.inject.ImplementedBy;
+/**
+ * A representation of an ActivityStream object, a thing which participates in an Activity.
+ */
@ImplementedBy(ActivityObjectImpl.class)
@Exportablebean
public interface ActivityObject {
-
- /*
- * Fields that represent JSON elements for an activity entry.
- */
- public static enum Field {
- ID("id"),
- NAME("name"),
- SUMMARY("summary"),
- MEDIA("media"),
- PERMALINK("permalink"),
- TYPE("type"),
- IN_REPLY_TO("inReplyTo"),
- ATTACHED("attached"),
- REPLY("reply"),
- REACTION("reaction"),
- ACTION("action"),
- UPSTREAM_DUPLICATE_ID("upstreamDuplicateId"),
- DOWNSTREAM_DUPLICATE_ID("downstreamDuplicateId"),
- STANDARD_LINK("standardLink");
-
- /*
- * The name of the JSON element.
- */
- private final String jsonString;
-
- /*
- * Constructs the field base for the JSON element.
- *
- * @param jsonString the name of the element
- */
- private Field(String jsonString) {
- this.jsonString = jsonString;
- }
-
- /*
- * Returns the name of the JSON element.
- *
- * @return String the name of the JSON element
- */
- public String toString() {
- return jsonString;
- }
- }
-
- String getId();
-
- void setId(String id);
-
- String getName();
-
- void setName(String name);
-
- String getSummary();
-
- void setSummary(String summary);
-
- MediaLink getMedia();
-
- void setMedia(MediaLink media);
-
- String getPermalink();
-
- void setPermalink(String permalink);
-
- List<String> getType();
-
- void setType(List<String> type);
-
- ActivityObject getInReplyTo();
-
- void setInReplyTo(ActivityObject inReplyTo);
-
- List<ActivityObject> getAttached();
-
- void setAttached(List<ActivityObject> attached);
-
- List<ActivityObject> getReply();
-
- void setReply(List<ActivityObject> reply);
-
- List<ActivityObject> getReaction();
-
- void setReaction(List<ActivityObject> reaction);
-
- ActionLink getAction();
-
- void setAction(ActionLink action);
-
- List<String> getUpstreamDuplicateId();
-
- void setUpstreamDuplicateId(List<String> upstreamDuplicateId);
-
- List<String> getDownstreamDuplicateId();
-
- void setDownstreamDuplicateId(List<String> downstreamDuplicateId);
-
- String getStandardLink();
-
- void setStandardLink(String standardLink);
-}
\ No newline at end of file
+
+ /*
+ * Fields that represent JSON elements for an activity entry.
+ */
+ public static enum Field {
+ ID("id"),
+ NAME("name"),
+ SUMMARY("summary"),
+ MEDIA("media"),
+ PERMALINK("permalink"),
+ TYPE("type"),
+ IN_REPLY_TO("inReplyTo"),
+ ATTACHED("attached"),
+ REPLY("reply"),
+ REACTION("reaction"),
+ ACTION("action"),
+ UPSTREAM_DUPLICATE_ID("upstreamDuplicateId"),
+ DOWNSTREAM_DUPLICATE_ID("downstreamDuplicateId"),
+ STANDARD_LINK("standardLink");
+
+ /*
+ * The name of the JSON element.
+ */
+ private final String jsonString;
+
+ /**
+ * Constructs the field base for the JSON element.
+ *
+ * @param jsonString the name of the element
+ */
+ private Field(String jsonString) {
+ this.jsonString = jsonString;
+ }
+
+ /**
+ * Returns the name of the JSON element.
+ *
+ * @return String the name of the JSON element
+ */
+ public String toString() {
+ return jsonString;
+ }
+ }
+
+ /**
+ * Gets the absolute URI that uniquely identifies the object
+ *
+ * @return a non-null string
+ */
+ String getId();
+
+ /**
+ * Set the absolute URI that uniquely identifies the object
+ *
+ * @param id a non-null string
+ */
+ void setId(String id);
+
+ /**
+ * @return the human-readable name fo the object
+ */
+ String getName();
+
+ /**
+ * Sets the name
+ * @param name a human-readable name
+ */
+ void setName(String name);
+
+ /**
+ * Gets the human-readable summary for this object.
+ * @return the summary
+ */
+ String getSummary();
+
+ /**
+ * Sets the human-readable summary for this object.
+ *
+ * @param summary a summary
+ */
+ void setSummary(String summary);
+
+ /**
+ * Get the link to a media item
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.MediaLink} object.
+ */
+ MediaLink getMedia();
+
+ /**
+ * Set the link to a media item
+ *
+ * @param media a {@link org.apache.shindig.extras.as.opensocial.model.MediaLink} object.
+ */
+ void setMedia(MediaLink media);
+
+ /**
+ * Get the permanent link
+ *
+ * @return a permalink string, possibly null
+ */
+ String getPermalink();
+
+ /**
+ * Set the permanent link
+ *
+ * @param permalink a permalink string, possibly null
+ */
+ void setPermalink(String permalink);
+
+ /**
+ * Returns a list of Type strings
+ *
+ * @return a list of Type strings
+ */
+ List<String> getType();
+
+ /**
+ * set the list of Type strings
+ *
+ * @param type a list of Type strings
+ */
+ void setType(List<String> type);
+
+ /**
+ * Get the Activity this item is a response to
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject}
+ */
+ ActivityObject getInReplyTo();
+
+ /**
+ * Set the Activity this item is a response to
+ *
+ * @param inReplyTo a {@link org.apache.shindig.extras.as.opensocial.model.ActivityObject} object.
+ */
+ void setInReplyTo(ActivityObject inReplyTo);
+
+ /**
+ * Gets the list of Attached Activities for this entry
+ *
+ * @return a list of ActivityObjects
+ */
+ List<ActivityObject> getAttached();
+
+ /**
+ * Sets the list of Attached Activities for this entry
+ *
+ * @param attached a list of ActivityObjects
+ */
+ void setAttached(List<ActivityObject> attached);
+
+ /**
+ * Gets the list of reply Activities for this entry
+ *
+ * @return a list of ActivityObjects
+ */
+ List<ActivityObject> getReply();
+
+ /**
+ * Sets the list of reply Activities for this entry
+ *
+ * @param reply a list of ActivityObjects
+ */
+ void setReply(List<ActivityObject> reply);
+
+ /**
+ * Gets the list of reaction Activities for this entry
+ *
+ * @return a list of ActivityObjects
+ */
+ List<ActivityObject> getReaction();
+
+ /**
+ * Sets the list of reaction Activities for this entry
+ *
+ * @param reaction a list of ActivityObjects
+ */
+ void setReaction(List<ActivityObject> reaction);
+
+ /**
+ * Returns an ActionLink for this object
+ *
+ * @return a {@link org.apache.shindig.extras.as.opensocial.model.ActionLink} object.
+ */
+ ActionLink getAction();
+
+ /**
+ * Sets the ActionLink for this object
+ *
+ * @param action a {@link org.apache.shindig.extras.as.opensocial.model.ActionLink} object.
+ */
+ void setAction(ActionLink action);
+
+ /**
+ * Get the list of upstream duplicate Ids
+ *
+ * @return a list of strings
+ */
+ List<String> getUpstreamDuplicateId();
+
+ /**
+ * Set the list of upstream duplicate Ids
+ *
+ * @param upstreamDuplicateId a list of strings containing duplicate Ids
+ */
+ void setUpstreamDuplicateId(List<String> upstreamDuplicateId);
+
+ /**
+ * Get the list of downstream duplicate Ids
+ *
+ * @return a list of strings
+ */
+ List<String> getDownstreamDuplicateId();
+
+ /**
+ * Set the list of downstream duplicate Ids
+ *
+ * @param downstreamDuplicateId a list of strings containing duplicate Ids
+ */
+ void setDownstreamDuplicateId(List<String> downstreamDuplicateId);
+
+ /**
+ * Return a standard link string
+ *
+ * @return the standard link
+ */
+ String getStandardLink();
+
+ /**
+ * Set the standard link string
+ *
+ * @param standardLink the standard link
+ */
+ void setStandardLink(String standardLink);
+}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityStream.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityStream.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityStream.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/ActivityStream.java Mon Sep 6 23:07:31 2010
@@ -25,7 +25,7 @@ import org.apache.shindig.protocol.model
import com.google.inject.ImplementedBy;
-/*
+/**
* Interface for an Activity Stream.
* <p>
* See the Activity Streams specification for more detail:
@@ -34,58 +34,106 @@ import com.google.inject.ImplementedBy;
@ImplementedBy(ActivityStreamImpl.class)
@Exportablebean
public interface ActivityStream {
-
- /*
- * Fields that represent JSON elements for an activity entry.
- */
- public static enum Field {
- DISPLAY_NAME("displayName"),
- LANGUAGE("language"),
- ENTRIES("entries"),
- ID("id"),
- SUBJECT("subject");
-
- /*
- * The name of the JSON element.
- */
- private final String jsonString;
-
- /*
- * Constructs the field base for the JSON element.
- *
- * @param jsonString the name of the element
- */
- private Field(String jsonString) {
- this.jsonString = jsonString;
- }
-
- /*
- * Returns the name of the JSON element.
- *
- * @return String the name of the JSON element
- */
- public String toString() {
- return jsonString;
- }
- }
-
- void setId(String id);
-
- String getId();
-
- void setEntries(List<ActivityEntry> entries);
-
- List<ActivityEntry> getEntries();
-
- void setLanguage(String language);
-
- String getLanguage();
-
- void setSubject(String subject);
-
- String getSubject();
-
- void setDisplayName(String displayName);
-
- String getDisplayName();
-}
\ No newline at end of file
+
+ /*
+ * Fields that represent JSON elements for an activity entry.
+ */
+ public static enum Field {
+ DISPLAY_NAME("displayName"),
+ LANGUAGE("language"),
+ ENTRIES("entries"),
+ ID("id"),
+ SUBJECT("subject");
+
+ /*
+ * The name of the JSON element.
+ */
+ private final String jsonString;
+
+ /*
+ * Constructs the field base for the JSON element.
+ *
+ * @param jsonString the name of the element
+ */
+ private Field(String jsonString) {
+ this.jsonString = jsonString;
+ }
+
+ /*
+ * Returns the name of the JSON element.
+ *
+ * @return String the name of the JSON element
+ */
+ public String toString() {
+ return jsonString;
+ }
+ }
+
+ /**
+ * Sets the Id for this stream
+ * @param id a string
+ */
+ void setId(String id);
+
+ /**
+ * Return the id string
+ *
+ * @return a string
+ */
+ String getId();
+
+ /**
+ * Set the list of ActivityEntry objects
+ * @param entries a list of ActivityEntry
+ */
+ void setEntries(List<ActivityEntry> entries);
+
+ /**
+ * Get the list of ActivityEntry objects
+ *
+ * @return a list of ActivityEntry
+ */
+ List<ActivityEntry> getEntries();
+
+ /**
+ * Set the language for this stream
+ *
+ * @param language a language string
+ */
+ void setLanguage(String language);
+
+ /**
+ * Get the language for this stream
+ *
+ * @return a language string
+ */
+ String getLanguage();
+
+ /**
+ * Set the subject for this stream
+ *
+ * @param subject a subject string
+ */
+ void setSubject(String subject);
+
+ /**
+ * Get the subject for this stream
+ *
+ * @return a subject string
+ */
+ String getSubject();
+
+ /**
+ * Get the display name for this stream
+ *
+ * @param displayName a display name
+ */
+ void setDisplayName(String displayName);
+
+ /**
+ * Get the human readable name for this stream
+ *
+ * @return a display name
+ */
+ String getDisplayName();
+}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/MediaLink.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/MediaLink.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/MediaLink.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/model/MediaLink.java Mon Sep 6 23:07:31 2010
@@ -24,61 +24,115 @@ import com.google.inject.ImplementedBy;
/*
* TODO: comment this class.
*/
+/**
+ * <p>MediaLink interface.</p>
+ *
+ */
@ImplementedBy(MediaLinkImpl.class)
@Exportablebean
public interface MediaLink {
- /*
- * Fields that represent the JSON elements.
- */
- public static enum Field {
- TARGET("target"),
- TYPE("type"),
- WIDTH("width"),
- HEIGHT("height"),
- DURATION("duration");
-
- /*
- * The name of the JSON element.
- */
- private final String jsonString;
-
- /*
- * Constructs the field base for the JSON element.
- *
- * @param jsonString the name of the element
- */
- private Field(String jsonString) {
- this.jsonString = jsonString;
- }
-
- /*
- * Returns the name of the JSON element.
- *
- * @return String the name of the JSON element
- */
- public String toString() {
- return jsonString;
- }
- }
-
- String getTarget();
-
- void setTarget(String target);
-
- String getType();
-
- void setType(String type);
-
- String getWidth();
-
- void setWidth(String width);
-
- String getHeight();
-
- void setHeight(String height);
-
- String getDuration();
-
- void setDuration(String duration);
+ /**
+ * Fields that represent the JSON elements.
+ */
+ public static enum Field {
+ TARGET("target"),
+ TYPE("type"),
+ WIDTH("width"),
+ HEIGHT("height"),
+ DURATION("duration");
+
+ /**
+ * The name of the JSON element.
+ */
+ private final String jsonString;
+
+ /**
+ * Constructs the field base for the JSON element.
+ *
+ * @param jsonString the name of the element
+ */
+ private Field(String jsonString) {
+ this.jsonString = jsonString;
+ }
+
+ /**
+ * Returns the name of the JSON element.
+ *
+ * @return String the name of the JSON element
+ */
+ public String toString() {
+ return jsonString;
+ }
+ }
+
+ /**
+ * Returns the target of this MediaLink
+ *
+ * @return a target
+ */
+ String getTarget();
+
+ /**
+ * Sets the target for this MediaLink
+ *
+ * @param target a target linke
+ */
+ void setTarget(String target);
+
+ /**
+ * Returns the type of the MediaLink
+ *
+ * @return a type
+ */
+ String getType();
+
+ /**
+ * Sets the type of the MediaLink
+ *
+ * @param type a type
+ */
+ void setType(String type);
+
+ /**
+ * <p>getWidth</p>
+ *
+ * @return a {@link java.lang.String} object.
+ */
+ String getWidth();
+
+ /**
+ * Sets the Width of this mediaLink
+ *
+ * @param width a width
+ */
+ void setWidth(String width);
+
+ /**
+ * Sets the Height of this mediaLink
+ *
+ * @return a height
+ */
+ String getHeight();
+
+ /**
+ * Sets the Height of this mediaLink
+ *
+ * @param height a height
+ */
+ void setHeight(String height);
+
+ /**
+ * Returns the duration of this mediaLink
+ *
+ * @return a duration
+ */
+ String getDuration();
+
+ /**
+ * Sets the duration of this mediaLink
+ *
+ * @param duration a duration
+ */
+ void setDuration(String duration);
}
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/service/ActivityStreamsHandler.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/service/ActivityStreamsHandler.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/service/ActivityStreamsHandler.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/service/ActivityStreamsHandler.java Mon Sep 6 23:07:31 2010
@@ -38,12 +38,22 @@ import com.google.common.collect.Immutab
import com.google.common.collect.Iterables;
import com.google.inject.Inject;
+/**
+ * <p>ActivityStreamsHandler class.</p>
+ *
+ */
@Service(name = "activitystreams", path="/{userId}+/{groupId}/{appId}/{activitystream}/{activityEntryId}+")
public class ActivityStreamsHandler {
private final ActivityStreamService service;
private final ContainerConfig config;
+ /**
+ * <p>Constructor for ActivityStreamsHandler.</p>
+ *
+ * @param service a {@link org.apache.shindig.extras.as.opensocial.spi.ActivityStreamService} object.
+ * @param config a {@link org.apache.shindig.config.ContainerConfig} object.
+ */
@Inject
public ActivityStreamsHandler(ActivityStreamService service, ContainerConfig config) {
this.service = service;
@@ -54,6 +64,10 @@ public class ActivityStreamsHandler {
* Allowed end-points /activities/{userId}/@self/{actvityId}+
*
* examples: /activities/john.doe/@self/1
+ *
+ * @param request a {@link org.apache.shindig.social.opensocial.service.SocialRequestItem} object.
+ * @return a {@link java.util.concurrent.Future} object.
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
@Operation(httpMethods="DELETE")
public Future<?> delete(SocialRequestItem request)
@@ -73,8 +87,12 @@ public class ActivityStreamsHandler {
* Allowed end-points /activities/{userId}/@self
*
* examples: /activities/john.doe/@self - postBody is an activity object
- *
+ *
* TODO: REST end-point
+ *
+ * @param request a {@link org.apache.shindig.social.opensocial.service.SocialRequestItem} object.
+ * @return a {@link java.util.concurrent.Future} object.
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
@Operation(httpMethods="PUT", bodyParam = "activityEntry")
public Future<?> update(SocialRequestItem request) throws ProtocolException {
@@ -85,8 +103,12 @@ public class ActivityStreamsHandler {
* Allowed end-points /activities/{userId}/@self
*
* examples: /activities/john.doe/@self - postBody is an activity object
- *
+ *
* TODO: REST end-point
+ *
+ * @param request a {@link org.apache.shindig.social.opensocial.service.SocialRequestItem} object.
+ * @return a {@link java.util.concurrent.Future} object.
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
@Operation(httpMethods="POST", bodyParam = "activityEntry")
public Future<?> create(SocialRequestItem request) throws ProtocolException {
@@ -110,6 +132,10 @@ public class ActivityStreamsHandler {
*
* examples: /activities/john.doe/@self/1 /activities/john.doe/@self
* /activities/john.doe,jane.doe/@friends
+ *
+ * @param request a {@link org.apache.shindig.social.opensocial.service.SocialRequestItem} object.
+ * @return a {@link java.util.concurrent.Future} object.
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
@Operation(httpMethods="GET")
public Future<?> get(SocialRequestItem request)
@@ -143,6 +169,12 @@ public class ActivityStreamsHandler {
request.getFields(), options, request.getToken());
}
+ /**
+ * Return a list of supported fields for the ActivityStreams endpoint
+ *
+ * @param request a {@link org.apache.shindig.protocol.RequestItem} object.
+ * @return a List of supported fields
+ */
@Operation(httpMethods = "GET", path="/@supportedFields")
public List<Object> supportedFields(RequestItem request) {
// TODO: Would be nice if name in config matched name of service.
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/spi/ActivityStreamService.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/spi/ActivityStreamService.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/spi/ActivityStreamService.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/opensocial/spi/ActivityStreamService.java Mon Sep 6 23:07:31 2010
@@ -44,6 +44,7 @@ public interface ActivityStreamService {
* @param options The sorting/filtering/pagination options
* @param token A valid SecurityToken
* @return a response item with the list of activities.
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
Future<RestfulCollection<ActivityEntry>> getActivityEntries(Set<UserId> userIds,
GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token)
@@ -57,10 +58,11 @@ public interface ActivityStreamService {
* @param groupId Indicates whether to fetch activities for a group.
* @param appId The app id.
* @param fields The fields to return. Empty set implies all
- * @param options The sorting/filtering/pagination options
+ * @param options The sorting/filtering/pagination options
* @param activityIds The set of activity ids to fetch.
* @param token A valid SecurityToken
* @return a response item with the list of activities.
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
Future<RestfulCollection<ActivityEntry>> getActivityEntries(UserId userId, GroupId groupId,
String appId, Set<String> fields, CollectionOptions options, Set<String> activityIds, SecurityToken token)
@@ -78,6 +80,7 @@ public interface ActivityStreamService {
* @param activityId The activity id to fetch.
* @param token A valid SecurityToken
* @return a response item with the list of activities.
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
Future<ActivityEntry> getActivityEntry(UserId userId, GroupId groupId, String appId,
Set<String> fields, String activityId, SecurityToken token)
@@ -92,6 +95,7 @@ public interface ActivityStreamService {
* @param activityIds A list of activity ids to delete.
* @param token A valid SecurityToken.
* @return a response item containing any errors
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
Future<Void> deleteActivityEntries(UserId userId, GroupId groupId, String appId,
Set<String> activityIds, SecurityToken token) throws ProtocolException;
@@ -107,6 +111,7 @@ public interface ActivityStreamService {
* @param activity The activity to create.
* @param token A valid SecurityToken
* @return a response item containing any errors
+ * @throws org.apache.shindig.protocol.ProtocolException if any.
*/
Future<Void> createActivityEntry(UserId userId, GroupId groupId, String appId,
Set<String> fields, ActivityEntry activity, SecurityToken token) throws ProtocolException;
Modified: shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/sample/ActivityStreamsJsonDbService.java
URL: http://svn.apache.org/viewvc/shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/sample/ActivityStreamsJsonDbService.java?rev=993172&r1=993171&r2=993172&view=diff
==============================================================================
--- shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/sample/ActivityStreamsJsonDbService.java (original)
+++ shindig/trunk/extras/src/main/java/org/apache/shindig/extras/as/sample/ActivityStreamsJsonDbService.java Mon Sep 6 23:07:31 2010
@@ -41,11 +41,22 @@ import java.util.List;
import java.util.Set;
import java.util.concurrent.Future;
+/**
+ * Sample Implementation of the ActivityStreams Service using a JSON
+ * database.
+ */
public class ActivityStreamsJsonDbService implements ActivityStreamService {
JsonDbOpensocialService jsonDb;
JSONObject db;
BeanConverter converter;
+ /**
+ * Create a new ActivityStreamsJsonDbService instance via Guice injection
+ *
+ * @param jsonDb a {@link org.apache.shindig.social.sample.spi.JsonDbOpensocialService} object.
+ * @param converter a {@link org.apache.shindig.protocol.conversion.BeanConverter} object
+ * annotated with "shindig.bean.converter.json".
+ */
@Inject
public ActivityStreamsJsonDbService(JsonDbOpensocialService jsonDb,
@Named("shindig.bean.converter.json")
@@ -63,69 +74,70 @@ public class ActivityStreamsJsonDbServic
// Are fields really needed here?
+ /** {@inheritDoc} */
public Future<Void> createActivityEntry(UserId userId, GroupId groupId, String appId,
- Set<String> fields, ActivityEntry activityEntry, SecurityToken token) throws ProtocolException {
- try {
- JSONObject jsonEntry = convertFromActivityEntry(activityEntry, fields);
- JSONObject jsonEntryObject = jsonEntry.getJSONObject(ActivityEntry.Field.OBJECT.toString());
- if (!jsonEntryObject.has(ActivityObject.Field.ID.toString())) {
- jsonEntryObject.put(ActivityObject.Field.ID.toString(), System.currentTimeMillis());
- jsonEntry.put(ActivityEntry.Field.OBJECT.toString(), jsonEntryObject);
- }
-
- // TODO: bug fixed: jsonArray will not be null; will throw exception!
- // Fix in createActivity()
- JSONArray jsonArray;
- if(db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(userId.getUserId(token))) {
- jsonArray = db.getJSONObject(ACTIVITYSTREAMS_TABLE)
- .getJSONArray(userId.getUserId(token));
- } else {
- jsonArray = new JSONArray();
- db.getJSONObject(ACTIVITYSTREAMS_TABLE).put(userId.getUserId(token), jsonArray);
- }
- jsonArray.put(jsonEntry);
- return ImmediateFuture.newInstance(null);
- } catch (JSONException je) {
- throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(),
- je);
- }
+ Set<String> fields, ActivityEntry activityEntry, SecurityToken token) throws ProtocolException {
+ try {
+ JSONObject jsonEntry = convertFromActivityEntry(activityEntry, fields);
+ JSONObject jsonEntryObject = jsonEntry.getJSONObject(ActivityEntry.Field.OBJECT.toString());
+ if (!jsonEntryObject.has(ActivityObject.Field.ID.toString())) {
+ jsonEntryObject.put(ActivityObject.Field.ID.toString(), System.currentTimeMillis());
+ jsonEntry.put(ActivityEntry.Field.OBJECT.toString(), jsonEntryObject);
+ }
+
+ // TODO: bug fixed: jsonArray will not be null; will throw exception!
+ // Fix in createActivity()
+ JSONArray jsonArray;
+ if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(userId.getUserId(token))) {
+ jsonArray = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(userId.getUserId(token));
+ } else {
+ jsonArray = new JSONArray();
+ db.getJSONObject(ACTIVITYSTREAMS_TABLE).put(userId.getUserId(token), jsonArray);
+ }
+ jsonArray.put(jsonEntry);
+ return ImmediateFuture.newInstance(null);
+ } catch (JSONException je) {
+ throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(), je);
+ }
}
+ /** {@inheritDoc} */
public Future<Void> deleteActivityEntries(UserId userId, GroupId groupId,
- String appId, Set<String> activityIds, SecurityToken token)
- throws ProtocolException {
- try {
- String user = userId.getUserId(token);
- if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(user)) {
- JSONArray activityEntries = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(user);
- if (activityEntries != null) {
- JSONArray newList = new JSONArray();
- for (int i = 0; i < activityEntries.length(); i++) {
- JSONObject activityEntry = activityEntries.getJSONObject(i);
- if (!activityIds.contains(activityEntry.getJSONObject(ActivityEntry.Field.OBJECT.toString()).getString(ActivityObject.Field.ID.toString()))) {
- newList.put(activityEntry);
- }
- }
- db.getJSONObject(ACTIVITYSTREAMS_TABLE).put(user, newList);
- // TODO: This seems very odd that we return no useful response in this
- // case
- // There is no way to represent not-found
- // if (found) { ??
- // }
+ String appId, Set<String> activityIds, SecurityToken token) throws ProtocolException {
+ try {
+ String user = userId.getUserId(token);
+
+ if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(user)) {
+ JSONArray activityEntries = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(user);
+
+ if (activityEntries != null) {
+ JSONArray newList = new JSONArray();
+ for (int i = 0; i < activityEntries.length(); i++) {
+ JSONObject activityEntry = activityEntries.getJSONObject(i);
+ if (!activityIds.contains(activityEntry.getJSONObject(ActivityEntry.Field.OBJECT.toString()).getString(ActivityObject.Field.ID.toString()))) {
+ newList.put(activityEntry);
+ }
+ }
+ db.getJSONObject(ACTIVITYSTREAMS_TABLE).put(user, newList);
+ // TODO: This seems very odd that we return no useful response in this
+ // case
+ // There is no way to represent not-found
+ // if (found) { ??
+ // }
}
- }
- // What is the appropriate response here??
- return ImmediateFuture.newInstance(null);
- } catch (JSONException je) {
- throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(),
- je);
- }
+ }
+ // What is the appropriate response here??
+ return ImmediateFuture.newInstance(null);
+ } catch (JSONException je) {
+ throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(), je);
+ }
}
+ /** {@inheritDoc} */
public Future<ActivityEntry> getActivityEntry(UserId userId, GroupId groupId,
- String appId, Set<String> fields, String activityId, SecurityToken token)
- throws ProtocolException {
- try {
+ String appId, Set<String> fields, String activityId, SecurityToken token)
+ throws ProtocolException {
+ try {
String user = userId.getUserId(token);
if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(user)) {
JSONArray activityEntries = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(user);
@@ -136,93 +148,70 @@ public class ActivityStreamsJsonDbServic
if (actorId.equals(user)
&& activityEntry.getJSONObject(ActivityEntry.Field.OBJECT.toString()).get(ActivityObject.Field.ID.toString()).toString().equals(activityId)) {
return ImmediateFuture.newInstance(jsonDb.filterFields(activityEntry, fields, ActivityEntry.class));
- }
+ }
}
}
throw new ProtocolException(HttpServletResponse.SC_BAD_REQUEST, "ActivityEntry not found");
} catch (JSONException je) {
- throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(),
- je);
+ throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(), je);
}
}
-
+
+ /** {@inheritDoc} */
public Future<RestfulCollection<ActivityEntry>> getActivityEntries(
- Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields,
- CollectionOptions options, SecurityToken token)
- throws ProtocolException {
+ Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields,
+ CollectionOptions options, SecurityToken token)
+ throws ProtocolException {
List<ActivityEntry> result = Lists.newArrayList();
-// // Retrieve activities from Lotus Connections
-// FeedParser parser;
-// try {
-// parser = new FeedParser();
-// ArrayList<JSONObject> activityEntries = parser.parseFeed("http://w3.ibm.com/connections/news/atom/stories/public");
-// for(JSONObject activityEntry : activityEntries) {
-// result.add(jsonDb.filterFields(activityEntry, fields, ActivityEntry.class));
-// }
-// } catch (ParserConfigurationException e) {
-// e.printStackTrace();
-// } catch (SAXException e) {
-// e.printStackTrace();
-// } catch (JSONException e) {
-// e.printStackTrace();
-// }
-
- try {
- Set<String> idSet = jsonDb.getIdSet(userIds, groupId, token);
- for (String id : idSet) {
- if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(id)) {
- JSONArray activityEntries = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(id);
- for (int i = 0; i < activityEntries.length(); i++) {
- JSONObject activityEntry = activityEntries.getJSONObject(i);
- result.add(jsonDb.filterFields(activityEntry, fields, ActivityEntry.class));
- // TODO: ActivityStreams don't have appIds
-// if (appId == null || !activitystream.has(ActivityStream.Field.APP_ID.toString())) {
-// result.add(jsonDb.filterFields(activitystream, fields, ActivityStream.class));
-// } else if (activitystream.get(ActivityStream.Field.APP_ID.toString()).equals(appId)) {
-// result.add(jsonDb.filterFields(activitystream, fields, ActivityStream.class));
-// }
- }
+ try {
+ Set<String> idSet = jsonDb.getIdSet(userIds, groupId, token);
+ for (String id : idSet) {
+ if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(id)) {
+ JSONArray activityEntries = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(id);
+ for (int i = 0; i < activityEntries.length(); i++) {
+ JSONObject activityEntry = activityEntries.getJSONObject(i);
+ result.add(jsonDb.filterFields(activityEntry, fields, ActivityEntry.class));
+ // TODO: ActivityStreams don't have appIds
}
}
- return ImmediateFuture.newInstance(new RestfulCollection<ActivityEntry>(result));
+ }
+ return ImmediateFuture.newInstance(new RestfulCollection<ActivityEntry>(result));
} catch (JSONException je) {
- throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(),
- je);
+ throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(), je);
}
}
-
+
+ /** {@inheritDoc} */
public Future<RestfulCollection<ActivityEntry>> getActivityEntries(
- UserId userId, GroupId groupId, String appId, Set<String> fields,
- CollectionOptions options, Set<String> activityIds, SecurityToken token)
- throws ProtocolException {
- List<ActivityEntry> result = Lists.newArrayList();
- try {
- String user = userId.getUserId(token);
- if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(user)) {
- JSONArray activityEntries = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(user);
- for (int i = 0; i < activityEntries.length(); i++) {
- JSONObject activityEntry = activityEntries.getJSONObject(i);
- JSONObject actor = new JSONObject(activityEntry.get(ActivityEntry.Field.ACTOR.toString()));
- String actorId = actor.get(ActivityObject.Field.ID.toString()).toString();
- if (actorId.equals(user)
- && activityIds.contains(activityEntry.getJSONObject(ActivityEntry.Field.OBJECT.toString()).getString(ActivityObject.Field.ID.toString()).toString())) {
+ UserId userId, GroupId groupId, String appId, Set<String> fields,
+ CollectionOptions options, Set<String> activityIds, SecurityToken token)
+ throws ProtocolException {
+ List<ActivityEntry> result = Lists.newArrayList();
+ try {
+ String user = userId.getUserId(token);
+ if (db.getJSONObject(ACTIVITYSTREAMS_TABLE).has(user)) {
+ JSONArray activityEntries = db.getJSONObject(ACTIVITYSTREAMS_TABLE).getJSONArray(user);
+ for (int i = 0; i < activityEntries.length(); i++) {
+ JSONObject activityEntry = activityEntries.getJSONObject(i);
+ JSONObject actor = new JSONObject(activityEntry.get(ActivityEntry.Field.ACTOR.toString()));
+ String actorId = actor.get(ActivityObject.Field.ID.toString()).toString();
+ if (actorId.equals(user)
+ && activityIds.contains(activityEntry.getJSONObject(ActivityEntry.Field.OBJECT.toString()).getString(ActivityObject.Field.ID.toString()).toString())) {
result.add(jsonDb.filterFields(activityEntry, fields, ActivityEntry.class));
}
}
}
return ImmediateFuture.newInstance(new RestfulCollection<ActivityEntry>(result));
} catch (JSONException je) {
- throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(),
- je);
+ throw new ProtocolException(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, je.getMessage(), je);
}
}
private JSONObject convertFromActivityEntry(ActivityEntry activityEntry, Set<String> fields)
- throws JSONException {
- // TODO Not using fields yet
- return new JSONObject(converter.convertToString(activityEntry));
+ throws JSONException {
+ // TODO Not using fields yet
+ return new JSONObject(converter.convertToString(activityEntry));
}
-
}