Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Drinker.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Drinker.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Drinker.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Drinker.java Wed Sep 1 22:03:35 2010 @@ -18,7 +18,7 @@ package org.apache.shindig.social.opensocial.model; /** - * public java.lang.Enum for opensocial.Enum.Drinker. + * public java.lang.Enum for opensocial.Enum.Drinker. */ public enum Drinker implements org.apache.shindig.protocol.model.Enum.EnumKey { /** Heavy drinker. */
Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Group.java Wed Sep 1 22:03:35 2010 @@ -33,6 +33,8 @@ import com.google.inject.ImplementedBy; * <p> * From http://opensocial-resources.googlecode.com/svn/spec/1.0/Social-Data.xml#Group * </p> + * + * @since 2.0.0 */ @ImplementedBy(GroupImpl.class) @Exportablebean Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/LookingFor.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/LookingFor.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/LookingFor.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/LookingFor.java Wed Sep 1 22:03:35 2010 @@ -18,7 +18,7 @@ package org.apache.shindig.social.opensocial.model; /** - * public java.lang.Enum for opensocial.Enum.LookingFor. + * public java.lang.Enum for opensocial.Enum.LookingFor. */ public enum LookingFor implements org.apache.shindig.protocol.model.Enum.EnumKey { /** Interested in dating. */ Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MessageCollection.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MessageCollection.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MessageCollection.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/MessageCollection.java Wed Sep 1 22:03:35 2010 @@ -25,12 +25,10 @@ import java.util.Set; import java.util.Date; /** - * * Base interface for all message collection objects. * * see * http://code.google.com/apis/opensocial/docs/0.7/reference/opensocial.MessageCollection.html - * */ @ImplementedBy(MessageCollectionImpl.class) Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Name.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Name.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Name.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Name.java Wed Sep 1 22:03:35 2010 @@ -27,7 +27,6 @@ import com.google.inject.ImplementedBy; * see * <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Name";> * http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Name</a> - * */ @ImplementedBy(NameImpl.class) Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/NetworkPresence.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/NetworkPresence.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/NetworkPresence.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/NetworkPresence.java Wed Sep 1 22:03:35 2010 @@ -18,7 +18,7 @@ package org.apache.shindig.social.opensocial.model; /** - * public java.lang.Enum for opensocial.Enum.NetworkPresence. + * public java.lang.Enum for opensocial.Enum.NetworkPresence. */ public enum NetworkPresence implements org.apache.shindig.protocol.model.Enum.EnumKey { /** Currently Online. */ Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Organization.java Wed Sep 1 22:03:35 2010 @@ -31,7 +31,6 @@ import java.util.Date; * * see <a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Organization";> * http://www.opensocial.org/Technical-Resources/opensocial-spec-v081/opensocial-reference#opensocial.Organization</a> - * */ @ImplementedBy(OrganizationImpl.class) Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/Url.java Wed Sep 1 22:03:35 2010 @@ -64,12 +64,14 @@ public interface Url extends ListField { /** * Get the text associated with the link. + * * @return the link text */ String getLinkText(); /** * Set the Link text associated with the link. + * * @param linkText the link text */ void setLinkText(String linkText); Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/OAuthDataStore.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/OAuthDataStore.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/OAuthDataStore.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/OAuthDataStore.java Wed Sep 1 22:03:35 2010 @@ -28,7 +28,6 @@ import org.apache.shindig.auth.SecurityT * access tokens, and providing a way to upgrade tokens to * authorized values. */ - public interface OAuthDataStore { /** * Get the OAuthEntry that corresponds to the oauthToken. Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/ActivityHandler.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/ActivityHandler.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/ActivityHandler.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/ActivityHandler.java Wed Sep 1 22:03:35 2010 @@ -37,6 +37,9 @@ import java.util.List; import java.util.Set; import java.util.concurrent.Future; +/** + * Rest/RPC handler for all activites related requests + */ @Service(name = "activities", path="/{userId}+/{groupId}/{appId}/{activityId}+") public class ActivityHandler { Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AlbumHandler.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AlbumHandler.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AlbumHandler.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AlbumHandler.java Wed Sep 1 22:03:35 2010 @@ -37,8 +37,10 @@ import com.google.common.collect.Immutab import com.google.common.collect.Iterables; import com.google.inject.Inject; -/* +/** * Receives and delegates requests to the OpenSocial Album service. + * + * @since 2.0.0 */ @Service(name = "albums", path = "/{userId}+/{groupId}/{albumId}+") public class AlbumHandler { @@ -176,4 +178,4 @@ public class AlbumHandler { return config.getList(container, "${Cur['gadgets.features'].opensocial.supportedFields.album}"); } -} \ No newline at end of file +} Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AppDataHandler.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AppDataHandler.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AppDataHandler.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/AppDataHandler.java Wed Sep 1 22:03:35 2010 @@ -32,6 +32,9 @@ import javax.servlet.http.HttpServletRes import com.google.inject.Inject; +/** + * Handles REST/RPC requests for AppData + */ @Service(name = "appdata", path = "/{userId}+/{groupId}/{appId}") public class AppDataHandler { Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/GroupHandler.java Wed Sep 1 22:03:35 2010 @@ -32,6 +32,10 @@ import org.apache.shindig.social.opensoc import com.google.inject.Inject; +/** + * RPC/REST handler for groups requests + * @since 2.0.0 + */ @Service(name = "groups", path = "/{userId}") public class GroupHandler { Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MediaItemHandler.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MediaItemHandler.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MediaItemHandler.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MediaItemHandler.java Wed Sep 1 22:03:35 2010 @@ -20,10 +20,10 @@ import com.google.common.collect.Immutab import com.google.common.collect.Iterables; import com.google.inject.Inject; -/* +/** * Receives and delegates requests to the OpenSocial MediaItems service. - * - * TODO: test cases + * + * @since 2.0.0 */ @Service(name = "mediaItems", path = "/{userId}+/{groupId}/{albumId}/{mediaItemId}+") public class MediaItemHandler { Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MessageHandler.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MessageHandler.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MessageHandler.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/MessageHandler.java Wed Sep 1 22:03:35 2010 @@ -35,6 +35,9 @@ import javax.servlet.http.HttpServletRes import com.google.inject.Inject; +/** + * RPC/REST handler for all Messages requests + */ @Service(name = "messages", path="/{userId}+/{msgCollId}/{messageIds}+") public class MessageHandler { Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/PersonHandler.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/PersonHandler.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/PersonHandler.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/PersonHandler.java Wed Sep 1 22:03:35 2010 @@ -39,6 +39,9 @@ import com.google.common.base.Objects; import com.google.common.collect.ImmutableSet; import com.google.inject.Inject; +/** + * RPC/REST handler for all /people requests + */ @Service(name = "people", path = "/{userId}+/{groupId}/{personId}+") public class PersonHandler { private final PersonService personService; Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/AlbumService.java Wed Sep 1 22:03:35 2010 @@ -28,9 +28,11 @@ import org.apache.shindig.social.opensoc import javax.servlet.http.HttpServletResponse; -/* +/** * The AlbumService interface defines the service provider interface for * creating, retrieving, updating, and deleting OpenSocial albums. + * + * @since 2.0.0 */ @ImplementedBy(AlbumService.NotImplementedAlbumService.class) public interface AlbumService { @@ -148,4 +150,4 @@ public interface AlbumService { throw new ProtocolException(HttpServletResponse.SC_BAD_REQUEST, "Not Implemented"); } } -} \ No newline at end of file +} Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/CollectionOptions.java Wed Sep 1 22:03:35 2010 @@ -25,6 +25,9 @@ import com.google.common.base.Objects; import java.util.Date; +/** + * Data structure representing many of the RPC/REST requests we receive. + */ public class CollectionOptions { private String sortBy; private SortOrder sortOrder; Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupId.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupId.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupId.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupId.java Wed Sep 1 22:03:35 2010 @@ -22,6 +22,9 @@ import com.google.common.base.Objects; import java.util.Map; +/** + * A group id used for grouping of people resources (as opposed to groups used by the GroupsHandler) + */ public class GroupId { public enum Type { all, friends, self, deleted, groupId; Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/GroupService.java Wed Sep 1 22:03:35 2010 @@ -25,6 +25,11 @@ import org.apache.shindig.auth.SecurityT import org.apache.shindig.protocol.RestfulCollection; import org.apache.shindig.social.opensocial.model.Group; +/** + * A service for gathering group information for specific users. + * + * @since 2.0.0 + */ public interface GroupService { /** * @param userId a userId object Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/MediaItemService.java Wed Sep 1 22:03:35 2010 @@ -10,9 +10,11 @@ import org.apache.shindig.social.opensoc import javax.servlet.http.HttpServletResponse; -/* +/** * The MediaItemService interface defines the service provider interface for * creating, retrieving, updating, and deleting OpenSocial MediaItems. + * + * @since 2.0.0 */ public interface MediaItemService { Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/PersonService.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/PersonService.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/PersonService.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/PersonService.java Wed Sep 1 22:03:35 2010 @@ -25,6 +25,9 @@ import org.apache.shindig.social.opensoc import java.util.Set; import java.util.concurrent.Future; +/** + * Interface that defines how shindig gathers people information. + */ public interface PersonService { /** Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/UserId.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/UserId.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/UserId.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/UserId.java Wed Sep 1 22:03:35 2010 @@ -24,6 +24,9 @@ import com.google.common.base.Objects; import java.util.Map; +/** + * Data structure representing a userid + */ public class UserId { public enum Type { me, viewer, owner, userId; Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/oauth/SampleOAuthDataStore.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/oauth/SampleOAuthDataStore.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/oauth/SampleOAuthDataStore.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/oauth/SampleOAuthDataStore.java Wed Sep 1 22:03:35 2010 @@ -40,7 +40,9 @@ import java.util.concurrent.ConcurrentMa import net.oauth.OAuthConsumer; import net.oauth.OAuthServiceProvider; -// Sample implementation for OAuth data store +/** + * Sample implementation for OAuth data store + */ public class SampleOAuthDataStore implements OAuthDataStore { // This needs to be long enough that an attacker can't guess it. If the attacker can guess this // value before they exceed the maximum number of attempts, they can complete a session fixation Modified: shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/spi/JsonDbOpensocialService.java URL: http://svn.apache.org/viewvc/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/spi/JsonDbOpensocialService.java?rev=991727&r1=991726&r2=991727&view=diff ============================================================================== --- shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/spi/JsonDbOpensocialService.java (original) +++ shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/spi/JsonDbOpensocialService.java Wed Sep 1 22:03:35 2010 @@ -129,6 +129,13 @@ public class JsonDbOpensocialService imp */ private static final String PASSWORDS_TABLE = "passwords"; + /** + * Initializes the JsonDbOpensocialService using Guice + * + * @param jsonLocation location of the json data provided by the shindig.canonical.json.db parameter + * @param converter an injected BeanConverter + * @throws java.lang.Exception if any + */ @Inject public JsonDbOpensocialService(@Named("shindig.canonical.json.db") String jsonLocation, @Named("shindig.bean.converter.json") @@ -138,14 +145,24 @@ public class JsonDbOpensocialService imp this.converter = converter; } + /** + * Allows access to the underlying json db. + * + * @return a reference to the json db + */ public JSONObject getDb() { return db; } + /** + * override the json database + * @param db a {...@link org.json.JSONObject}. + */ public void setDb(JSONObject db) { this.db = db; } + /** {...@inheritdoc} */ public Future<RestfulCollection<Activity>> getActivities(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token) throws ProtocolException { @@ -172,6 +189,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<RestfulCollection<Activity>> getActivities(UserId userId, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, Set<String> activityIds, SecurityToken token) throws ProtocolException { @@ -195,6 +213,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<Activity> getActivity(UserId userId, GroupId groupId, String appId, Set<String> fields, String activityId, SecurityToken token) throws ProtocolException { try { @@ -217,6 +236,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<Void> deleteActivities(UserId userId, GroupId groupId, String appId, Set<String> activityIds, SecurityToken token) throws ProtocolException { try { @@ -247,6 +267,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<Void> createActivity(UserId userId, GroupId groupId, String appId, Set<String> fields, Activity activity, SecurityToken token) throws ProtocolException { // Are fields really needed here? @@ -270,6 +291,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<RestfulCollection<Person>> getPeople(Set<UserId> userIds, GroupId groupId, CollectionOptions options, Set<String> fields, SecurityToken token) throws ProtocolException { List<Person> result = Lists.newArrayList(); @@ -320,6 +342,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<Person> getPerson(UserId id, Set<String> fields, SecurityToken token) throws ProtocolException { try { @@ -380,6 +403,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<DataCollection> getPersonData(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, SecurityToken token) throws ProtocolException { try { @@ -417,6 +441,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<Void> deletePersonData(UserId userId, GroupId groupId, String appId, Set<String> fields, SecurityToken token) throws ProtocolException { try { @@ -444,6 +469,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<Void> updatePersonData(UserId userId, GroupId groupId, String appId, Set<String> fields, Map<String, String> values, SecurityToken token) throws ProtocolException { @@ -471,15 +497,9 @@ public class JsonDbOpensocialService imp } /** + * {...@inheritdoc} + * * Post a message for a set of users. - * - * @param userId - * The user sending the message. - * @param appId - * The application sending the message. - * @param msgCollId - * @param message - * The message to post. */ public Future<Void> createMessage(UserId userId, String appId, String msgCollId, Message message, SecurityToken token) throws ProtocolException { @@ -501,6 +521,7 @@ public class JsonDbOpensocialService imp return ImmediateFuture.newInstance(null); } + /** {...@inheritdoc} */ public Future<RestfulCollection<MessageCollection>> getMessageCollections(UserId userId, Set<String> fields, CollectionOptions options, SecurityToken token) throws ProtocolException { try { @@ -524,6 +545,7 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<Void> deleteMessages(UserId userId, String msgCollId, List<String> ids, SecurityToken token) throws ProtocolException { throw new ProtocolException(HttpServletResponse.SC_NOT_IMPLEMENTED, @@ -531,6 +553,8 @@ public class JsonDbOpensocialService imp } /** + * {...@inheritdoc} + * * Gets the messsages in an user's queue. */ public Future<RestfulCollection<Message>> getMessages(UserId userId, String msgCollId, @@ -562,24 +586,28 @@ public class JsonDbOpensocialService imp } } + /** {...@inheritdoc} */ public Future<MessageCollection> createMessageCollection(UserId userId, MessageCollection msgCollection, SecurityToken token) throws ProtocolException { throw new ProtocolException(HttpServletResponse.SC_NOT_IMPLEMENTED, "this functionality is not yet available"); } + /** {...@inheritdoc} */ public Future<Void> modifyMessage(UserId userId, String msgCollId, String messageId, Message message, SecurityToken token) throws ProtocolException { throw new ProtocolException(HttpServletResponse.SC_NOT_IMPLEMENTED, "this functionality is not yet available"); } + /** {...@inheritdoc} */ public Future<Void> modifyMessageCollection(UserId userId, MessageCollection msgCollection, SecurityToken token) throws ProtocolException { throw new ProtocolException(HttpServletResponse.SC_NOT_IMPLEMENTED, "this functionality is not yet available"); } + /** {...@inheritdoc} */ public Future<Void> deleteMessageCollection(UserId userId, String msgCollId, SecurityToken token) throws ProtocolException { throw new ProtocolException(HttpServletResponse.SC_NOT_IMPLEMENTED, @@ -588,6 +616,9 @@ public class JsonDbOpensocialService imp /** * Public methods for use with Authentication Classes + * + * @param username a {...@link java.lang.String} object. + * @return a {...@link java.lang.String} object. */ public String getPassword(String username) { try { @@ -597,10 +628,7 @@ public class JsonDbOpensocialService imp } } - /** - * Get the set of user id's from a user and group - */ - public Set<String> getIdSet(UserId user, GroupId group, SecurityToken token) + private Set<String> getIdSet(UserId user, GroupId group, SecurityToken token) throws JSONException { String userId = user.getUserId(token); @@ -629,6 +657,12 @@ public class JsonDbOpensocialService imp /** * Get the set of user id's for a set of users and a group + * + * @param users set of UserIds + * @param group the group + * @param token a token + * @return set of Id strings + * @throws org.json.JSONException if errors in Json */ public Set<String> getIdSet(Set<UserId> users, GroupId group, SecurityToken token) throws JSONException { @@ -641,6 +675,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<Album> getAlbum(UserId userId, String appId, Set<String> fields, String albumId, SecurityToken token) throws ProtocolException { try { @@ -672,6 +707,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<RestfulCollection<Album>> getAlbums(UserId userId, String appId, Set<String> fields, CollectionOptions options, Set<String> albumIds, SecurityToken token) throws ProtocolException { @@ -722,6 +758,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<RestfulCollection<Album>> getAlbums(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token) @@ -752,6 +789,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<Void> deleteAlbum(UserId userId, String appId, String albumId, SecurityToken token) throws ProtocolException { try { @@ -793,6 +831,7 @@ public class JsonDbOpensocialService imp // TODO: userId and album's ownerId don't have to match - potential problem // TODO: not using appId + /** {...@inheritdoc} */ public Future<Void> createAlbum(UserId userId, String appId, Album album, SecurityToken token) throws ProtocolException { try { @@ -825,6 +864,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<Void> updateAlbum(UserId userId, String appId, Album album, String albumId, SecurityToken token) throws ProtocolException { try { @@ -860,6 +900,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<MediaItem> getMediaItem(UserId userId, String appId, String albumId, String mediaItemId, Set<String> fields, SecurityToken token) throws ProtocolException { @@ -892,6 +933,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId, String appId, String albumId, Set<String> mediaItemIds, Set<String> fields, CollectionOptions options, SecurityToken token) @@ -943,6 +985,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId, String appId, String albumId, Set<String> fields, CollectionOptions options, SecurityToken token) @@ -981,6 +1024,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<RestfulCollection<MediaItem>> getMediaItems( Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token) @@ -1008,6 +1052,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<Void> deleteMediaItem(UserId userId, String appId, String albumId, String mediaItemId, SecurityToken token) throws ProtocolException { @@ -1050,6 +1095,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<Void> createMediaItem(UserId userId, String appId, String albumId, MediaItem mediaItem, SecurityToken token) throws ProtocolException { @@ -1080,6 +1126,7 @@ public class JsonDbOpensocialService imp // TODO: not using appId + /** {...@inheritdoc} */ public Future<Void> updateMediaItem(UserId userId, String appId, String albumId, String mediaItemId, MediaItem mediaItem, SecurityToken token) throws ProtocolException {
