JsonDbOpensocialService (Apache Shindig Social API 2.5.2 API)

java.lang.Object
- org.apache.shindig.social.sample.spi.JsonDbOpensocialService

All Implemented Interfaces:

ActivityService, ActivityStreamService, AlbumService, AppDataService, GroupService, MediaItemService, MessageService, PersonService
```
public class JsonDbOpensocialService
extends Object
implements ActivityService, PersonService, AppDataService, MessageService, AlbumService, MediaItemService, ActivityStreamService, GroupService
```
Implementation of supported services backed by a JSON DB.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.shindig.social.opensocial.spi.MessageService
  MessageService.NotImplementedMessageService
- Nested classes/interfaces inherited from interface org.apache.shindig.social.opensocial.spi.AlbumService
  AlbumService.NotImplementedAlbumService
- Nested classes/interfaces inherited from interface org.apache.shindig.social.opensocial.spi.MediaItemService
  MediaItemService.NotImplementedMediaItemService

Field Summary
- Fields inherited from interface org.apache.shindig.social.opensocial.spi.PersonService
  ALL_FILTER, HAS_APP_FILTER, IS_WITH_FRIENDS_FILTER, TOP_FRIENDS_FILTER, TOP_FRIENDS_SORT

Constructor Summary

Constructors
Constructor and Description
`JsonDbOpensocialService(String jsonLocation, BeanConverter converter, String contextroot)` Initializes the JsonDbOpensocialService using Guice

Method Summary

Methods
Modifier and Type	Method and Description
`Future<Void>`	`createActivity(UserId userId, GroupId groupId, String appId, Set<String> fields, Activity activity, SecurityToken token)` Creates the passed in activity for the passed in user and group.
`Future<ActivityEntry>`	`createActivityEntry(UserId userId, GroupId groupId, String appId, Set<String> fields, ActivityEntry activityEntry, SecurityToken token)` Creates the passed in activity for the passed in user and group.
`Future<Void>`	`createAlbum(UserId userId, String appId, Album album, SecurityToken token)` Creates an album for the given user.
`Future<Void>`	`createMediaItem(UserId userId, String appId, String albumId, MediaItem mediaItem, SecurityToken token)` Create a MediaItem in the given album for the given user.
`Future<Void>`	`createMessage(UserId userId, String appId, String msgCollId, Message message, SecurityToken token)` Posts a message to the user's specified message collection, to be sent to the set of recipients specified in the message.
`Future<MessageCollection>`	`createMessageCollection(UserId userId, MessageCollection msgCollection, SecurityToken token)` Creates a new message collection for the given arguments
`Future<Void>`	`deleteActivities(UserId userId, GroupId groupId, String appId, Set<String> activityIds, SecurityToken token)` Deletes the activity for the passed in user and group that corresponds to the activityId.
`Future<Void>`	`deleteActivityEntries(UserId userId, GroupId groupId, String appId, Set<String> activityIds, SecurityToken token)` Deletes the activity for the passed in user and group that corresponds to the activityId.
`Future<Void>`	`deleteAlbum(UserId userId, String appId, String albumId, SecurityToken token)` Deletes a single album for the given user with the given album ID.
`Future<Void>`	`deleteMediaItem(UserId userId, String appId, String albumId, String mediaItemId, SecurityToken token)` Deletes a MediaItem by ID.
`Future<Void>`	`deleteMessageCollection(UserId userId, String msgCollId, SecurityToken token)` Deletes a message collection for the given arguments
`Future<Void>`	`deleteMessages(UserId userId, String msgCollId, List<String> ids, SecurityToken token)` Deletes a set of messages for a given user/message collection
`Future<Void>`	`deletePersonData(UserId userId, GroupId groupId, String appId, Set<String> fields, SecurityToken token)` Deletes data for the specified user and group.
`<T> T`	`filterFields(JSONObject object, Set<String> fields, Class<T> clz)`
`Future<RestfulCollection<Activity>>`	`getActivities(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token)` Returns a list of activities that correspond to the passed in users and group.
`Future<RestfulCollection<Activity>>`	`getActivities(UserId userId, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, Set<String> activityIds, SecurityToken token)` Returns a set of activities for the passed in user and group that corresponds to a list of activityIds.
`Future<Activity>`	`getActivity(UserId userId, GroupId groupId, String appId, Set<String> fields, String activityId, SecurityToken token)` Returns an activity for the passed in user and group that corresponds to a single activityId.
`Future<RestfulCollection<ActivityEntry>>`	`getActivityEntries(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token)` Returns a list of activities that correspond to the passed in users and group.
`Future<RestfulCollection<ActivityEntry>>`	`getActivityEntries(UserId userId, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, Set<String> activityIds, SecurityToken token)` Returns a set of activities for the passed in user and group that corresponds to a list of activityIds.
`Future<ActivityEntry>`	`getActivityEntry(UserId userId, GroupId groupId, String appId, Set<String> fields, String activityId, SecurityToken token)` Returns an activity for the passed in user and group that corresponds to a single activityId.
`Future<Album>`	`getAlbum(UserId userId, String appId, Set<String> fields, String albumId, SecurityToken token)` Retrieves a single album for the given user with the given album ID.
`Future<RestfulCollection<Album>>`	`getAlbums(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token)` Retrieves albums for the given user and group.
`Future<RestfulCollection<Album>>`	`getAlbums(UserId userId, String appId, Set<String> fields, CollectionOptions options, Set<String> albumIds, SecurityToken token)` Retrieves albums for the given user with the given album IDs.
`JSONObject`	`getDb()` Allows access to the underlying json db.
`Future<RestfulCollection<Group>>`	`getGroups(UserId userId, CollectionOptions options, Set<String> fields, SecurityToken token)`
`Set<String>`	`getIdSet(Set<UserId> users, GroupId group, SecurityToken token)` Get the set of user id's for a set of users and a group
`Future<MediaItem>`	`getMediaItem(UserId userId, String appId, String albumId, String mediaItemId, Set<String> fields, SecurityToken token)` Retrieves a MediaItem by ID.
`Future<RestfulCollection<MediaItem>>`	`getMediaItems(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, CollectionOptions options, SecurityToken token)` Retrieves MediaItems by users and groups.
`Future<RestfulCollection<MediaItem>>`	`getMediaItems(UserId userId, String appId, String albumId, Set<String> fields, CollectionOptions options, SecurityToken token)` Retrieves MediaItems by Album.
`Future<RestfulCollection<MediaItem>>`	`getMediaItems(UserId userId, String appId, String albumId, Set<String> mediaItemIds, Set<String> fields, CollectionOptions options, SecurityToken token)` Retrieves MediaItems by IDs.
`Future<RestfulCollection<MessageCollection>>`	`getMessageCollections(UserId userId, Set<String> fields, CollectionOptions options, SecurityToken token)` Returns a list of message collections corresponding to the given user
`Future<RestfulCollection<Message>>`	`getMessages(UserId userId, String msgCollId, Set<String> fields, List<String> msgIds, CollectionOptions options, SecurityToken token)` Returns a list of messages that correspond to the passed in data
`String`	`getPassword(String username)` Public methods for use with Authentication Classes
`Future<RestfulCollection<Person>>`	`getPeople(Set<UserId> userIds, GroupId groupId, CollectionOptions options, Set<String> fields, SecurityToken token)` Returns a list of people that correspond to the passed in person ids.
`Future<Person>`	`getPerson(UserId id, Set<String> fields, SecurityToken token)` Returns a person that corresponds to the passed in person id.
`Future<DataCollection>`	`getPersonData(Set<UserId> userIds, GroupId groupId, String appId, Set<String> fields, SecurityToken token)` Retrives app data for the specified user list and group.
`Future<Void>`	`modifyMessage(UserId userId, String msgCollId, String messageId, Message message, SecurityToken token)` Modifies/Updates a specific message with new data
`Future<Void>`	`modifyMessageCollection(UserId userId, MessageCollection msgCollection, SecurityToken token)` Modifies/Updates a message collection for the given arguments
`void`	`setAuthority(Authority authority)`
`void`	`setDb(JSONObject db)` override the json database
`Future<ActivityEntry>`	`updateActivityEntry(UserId userId, GroupId groupId, String appId, Set<String> fields, ActivityEntry activityEntry, String activityId, SecurityToken token)` Updates the specified Activity.
`Future<Void>`	`updateAlbum(UserId userId, String appId, Album album, String albumId, SecurityToken token)` Updates an album for the given user.
`Future<Void>`	`updateMediaItem(UserId userId, String appId, String albumId, String mediaItemId, MediaItem mediaItem, SecurityToken token)` Updates a MediaItem for the given user.
`Future<Person>`	`updatePerson(UserId id, Person person, SecurityToken token)` Updates person that corresponds to the passed in person id and updates him
`Future<Void>`	`updatePersonData(UserId userId, GroupId groupId, String appId, Set<String> fields, Map<String,Object> values, SecurityToken token)` Updates app data for the specified user and group with the new values.
`protected boolean`	`viewerCanUpdatePerson(String viewer, String person)` Check if a viewer is allowed to update the given person record.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonDbOpensocialService

@Inject
public JsonDbOpensocialService(String jsonLocation,
                              BeanConverter converter,
                              String contextroot)
                        throws Exception

Initializes the JsonDbOpensocialService using Guice

Parameters:: jsonLocation - location of the json data provided by the shindig.canonical.json.db parameter; converter - an injected BeanConverter
Throws:: Exception - if any

Method Detail

getDb
```
public JSONObject getDb()
```
Allows access to the underlying json db.

Returns:
a reference to the json db

setDb
```
public void setDb(JSONObject db)
```
override the json database

Parameters:
db - a JSONObject.

setAuthority

@Inject(optional=true)
public void setAuthority(Authority authority)

getActivities

public Future<RestfulCollection<Activity>> getActivities(Set<UserId> userIds,
                                                GroupId groupId,
                                                String appId,
                                                Set<String> fields,
                                                CollectionOptions options,
                                                SecurityToken token)
                                                  throws ProtocolException

Returns a list of activities that correspond to the passed in users and group.

Specified by:: getActivities in interface ActivityService
Parameters:: userIds - The set of ids of the people to fetch activities for.; groupId - Indicates whether to fetch activities for a group.; appId - The app id.; fields - The fields to return. Empty set implies all; options - The sorting/filtering/pagination options; token - A valid SecurityToken
Returns:: a response item with the list of activities.
Throws:: ProtocolException

getActivities

public Future<RestfulCollection<Activity>> getActivities(UserId userId,
                                                GroupId groupId,
                                                String appId,
                                                Set<String> fields,
                                                CollectionOptions options,
                                                Set<String> activityIds,
                                                SecurityToken token)
                                                  throws ProtocolException

Returns a set of activities for the passed in user and group that corresponds to a list of activityIds.

Specified by:: getActivities in interface ActivityService
Parameters:: userId - The set of ids of the people to fetch activities for.; groupId - Indicates whether to fetch activities for a group.; appId - The app id.; fields - The fields to return. Empty set implies all; options - The sorting/filtering/pagination options; activityIds - The set of activity ids to fetch.; token - A valid SecurityToken
Returns:: a response item with the list of activities.
Throws:: ProtocolException

getActivity
```
public Future<Activity> getActivity(UserId userId,
                           GroupId groupId,
                           String appId,
                           Set<String> fields,
                           String activityId,
                           SecurityToken token)
                             throws ProtocolException
```
Returns an activity for the passed in user and group that corresponds to a single activityId.

Specified by:

getActivity in interface ActivityService

Parameters:
userId - The set of ids of the people to fetch activities for.
groupId - Indicates whether to fetch activities for a group.
appId - The app id.
fields - The fields to return. Empty set implies all
activityId - The activity id to fetch.
token - A valid SecurityToken

Returns:
a response item with the list of activities.

Throws:

ProtocolException

deleteActivities

public Future<Void> deleteActivities(UserId userId,
                            GroupId groupId,
                            String appId,
                            Set<String> activityIds,
                            SecurityToken token)
                              throws ProtocolException

Deletes the activity for the passed in user and group that corresponds to the activityId.

Specified by:: deleteActivities in interface ActivityService
Parameters:: userId - The user.; groupId - The group.; appId - The app id.; activityIds - A list of activity ids to delete.; token - A valid SecurityToken.
Returns:: a response item containing any errors
Throws:: ProtocolException

createActivity

public Future<Void> createActivity(UserId userId,
                          GroupId groupId,
                          String appId,
                          Set<String> fields,
                          Activity activity,
                          SecurityToken token)
                            throws ProtocolException

Creates the passed in activity for the passed in user and group. Once createActivity is called, getActivities will be able to return the Activity.

Specified by:: createActivity in interface ActivityService
Parameters:: userId - The id of the person to create the activity for.; groupId - The group.; appId - The app id.; fields - The fields to return.; activity - The activity to create.; token - A valid SecurityToken
Returns:: a response item containing any errors
Throws:: ProtocolException

getPeople

public Future<RestfulCollection<Person>> getPeople(Set<UserId> userIds,
                                          GroupId groupId,
                                          CollectionOptions options,
                                          Set<String> fields,
                                          SecurityToken token)
                                            throws ProtocolException

Returns a list of people that correspond to the passed in person ids.

Specified by:: getPeople in interface PersonService
Parameters:: userIds - A set of users; groupId - The group; options - How to filter, sort and paginate the collection being fetched; fields - The profile details to fetch. Empty set implies all; token - The gadget token @return a list of people.
Returns:: Future that returns a RestfulCollection of Person
Throws:: ProtocolException

getPerson
```
public Future<Person> getPerson(UserId id,
                       Set<String> fields,
                       SecurityToken token)
                         throws ProtocolException
```
Returns a person that corresponds to the passed in person id.

Specified by:

getPerson in interface PersonService

Parameters:
id - The id of the person to fetch.
fields - The fields to fetch.
token - The gadget token

Returns:
a list of people.

Throws:

ProtocolException

updatePerson

public Future<Person> updatePerson(UserId id,
                          Person person,
                          SecurityToken token)
                            throws ProtocolException

Updates person that corresponds to the passed in person id and updates him

Specified by:: updatePerson in interface PersonService
Parameters:: id - The id of the person to fetch.; token - The gadget token
Returns:: a list of people.
Throws:: ProtocolException

viewerCanUpdatePerson

protected boolean viewerCanUpdatePerson(String viewer,
                            String person)

Check if a viewer is allowed to update the given person record.

getPersonData

public Future<DataCollection> getPersonData(Set<UserId> userIds,
                                   GroupId groupId,
                                   String appId,
                                   Set<String> fields,
                                   SecurityToken token)
                                     throws ProtocolException

Retrives app data for the specified user list and group.

Specified by:: getPersonData in interface AppDataService
Parameters:: userIds - A set of UserIds.; groupId - The group; appId - The app; fields - The fields to filter the data by. Empty set implies all; token - The security token
Returns:: The data fetched
Throws:: ProtocolException

deletePersonData

public Future<Void> deletePersonData(UserId userId,
                            GroupId groupId,
                            String appId,
                            Set<String> fields,
                            SecurityToken token)
                              throws ProtocolException

Deletes data for the specified user and group.

Specified by:: deletePersonData in interface AppDataService
Parameters:: userId - The user; groupId - The group; appId - The app; fields - The fields to delete. Empty set implies all; token - The security token
Returns:: an error if one occurs
Throws:: ProtocolException

updatePersonData

public Future<Void> updatePersonData(UserId userId,
                            GroupId groupId,
                            String appId,
                            Set<String> fields,
                            Map<String,Object> values,
                            SecurityToken token)
                              throws ProtocolException

Updates app data for the specified user and group with the new values.

Specified by:: updatePersonData in interface AppDataService
Parameters:: userId - The user; groupId - The group; appId - The app; fields - The fields to filter the data by. Empty set implies all; values - The values to set; token - The security token
Returns:: an error if one occurs
Throws:: ProtocolException

getGroups

public Future<RestfulCollection<Group>> getGroups(UserId userId,
                                         CollectionOptions options,
                                         Set<String> fields,
                                         SecurityToken token)
                                           throws ProtocolException

Specified by:: getGroups in interface GroupService
Parameters:: userId - a userId object; options - search/sort/filtering options; fields - Field search/sort; token - a valid security token
Returns:: a collection of groups for a specific userId
Throws:: ProtocolException

createMessage
```
public Future<Void> createMessage(UserId userId,
                         String appId,
                         String msgCollId,
                         Message message,
                         SecurityToken token)
                           throws ProtocolException
```
Posts a message to the user's specified message collection, to be sent to the set of recipients specified in the message. Post a message for a set of users.

Specified by:

createMessage in interface MessageService

Parameters:
userId - The user posting the message.
appId - The app id
msgCollId - The message collection Id to post to, default @outbox
message - The message to post
token - A valid security token @return a response item containing any errors/

Returns:
Void Future

Throws:

ProtocolException - when invalid parameters are given

getMessageCollections

public Future<RestfulCollection<MessageCollection>> getMessageCollections(UserId userId,
                                                                 Set<String> fields,
                                                                 CollectionOptions options,
                                                                 SecurityToken token)
                                                                   throws ProtocolException

Returns a list of message collections corresponding to the given user

Specified by:: getMessageCollections in interface MessageService
Parameters:: userId - The User to fetch for; fields - The fields to fetch for the message collections; options - Pagination, etal; token - Given security token for this request
Returns:: a collection of message collections.
Throws:: ProtocolException - when invalid parameters are given

deleteMessages
```
public Future<Void> deleteMessages(UserId userId,
                          String msgCollId,
                          List<String> ids,
                          SecurityToken token)
                            throws ProtocolException
```
Deletes a set of messages for a given user/message collection

Specified by:

deleteMessages in interface MessageService

Parameters:
userId - The User to delete for
msgCollId - The Message Collection ID to delete from, default @all
ids - List of IDs to delete
token - Given Security Token for this request

Returns:
Future

Throws:

ProtocolException

getMessages

public Future<RestfulCollection<Message>> getMessages(UserId userId,
                                             String msgCollId,
                                             Set<String> fields,
                                             List<String> msgIds,
                                             CollectionOptions options,
                                             SecurityToken token)
                                               throws ProtocolException

Returns a list of messages that correspond to the passed in data Gets the messsages in an user's queue.

Specified by:: getMessages in interface MessageService
Parameters:: userId - The User to fetch for; msgCollId - The message Collection ID to fetch from, default @all; fields - The fields to fetch for the messages; msgIds - An explicit set of message ids to fetch; options - Options to control the fetch; token - Given security token for this request
Returns:: a collection of messages
Throws:: ProtocolException - when invalid parameters are given

createMessageCollection
```
public Future<MessageCollection> createMessageCollection(UserId userId,
                                                MessageCollection msgCollection,
                                                SecurityToken token)
                                                  throws ProtocolException
```
Creates a new message collection for the given arguments

Specified by:

createMessageCollection in interface MessageService

Parameters:
userId - The userId to create the message collection for
msgCollection - A message collection that is to be created
token - A security token for this request

Returns:
Data for the message collection that is created

Throws:

ProtocolException - when invalid parameters are given or not implemented

modifyMessage
```
public Future<Void> modifyMessage(UserId userId,
                         String msgCollId,
                         String messageId,
                         Message message,
                         SecurityToken token)
                           throws ProtocolException
```
Modifies/Updates a specific message with new data

Specified by:

modifyMessage in interface MessageService

Parameters:
userId - The User to modify for
msgCollId - The Message Collection ID to modify from, default @all
messageId - The messageId to modify
message - The message details to modify
token - Given Security Token for this request

Returns:
Future

Throws:

ProtocolException - for invalid parameters or missing messages or users

modifyMessageCollection
```
public Future<Void> modifyMessageCollection(UserId userId,
                                   MessageCollection msgCollection,
                                   SecurityToken token)
                                     throws ProtocolException
```
Modifies/Updates a message collection for the given arguments

Specified by:

modifyMessageCollection in interface MessageService

Parameters:
userId - The userId to modify the message collection for
msgCollection - Data for the message collection to be modified
token - A security token for this request

Throws:

ProtocolException - when invalid parameters are given or not implemented

deleteMessageCollection
```
public Future<Void> deleteMessageCollection(UserId userId,
                                   String msgCollId,
                                   SecurityToken token)
                                     throws ProtocolException
```
Deletes a message collection for the given arguments

Specified by:

deleteMessageCollection in interface MessageService

Parameters:
userId - The userId to create the message collection for
msgCollId - Data for the message collection to be modified
token - A security token for this request

Returns:
Future

Throws:

ProtocolException - when invalid parameters are given, the message collection does not exist or not implemented

getPassword
```
public String getPassword(String username)
```
Public methods for use with Authentication Classes

Parameters:
username - a String object.

Returns:
a String object.

getIdSet

public Set<String> getIdSet(Set<UserId> users,
                   GroupId group,
                   SecurityToken token)
                     throws JSONException

Get the set of user id's for a set of users and a group

Parameters:: users - set of UserIds; group - the group; token - a token
Returns:: set of Id strings
Throws:: JSONException - if errors in Json

getAlbum
```
public Future<Album> getAlbum(UserId userId,
                     String appId,
                     Set<String> fields,
                     String albumId,
                     SecurityToken token)
                       throws ProtocolException
```
Retrieves a single album for the given user with the given album ID.

Specified by:

getAlbum in interface AlbumService

Parameters:
userId - Identifies the person to retrieve the album from
appId - Identifies the application to retrieve the album from
fields - Indicates the fields to return. Empty set implies all
albumId - Identifies the album to retrieve
token - A valid SecurityToken

Returns:
a response item with the requested album

Throws:

ProtocolException

getAlbums

public Future<RestfulCollection<Album>> getAlbums(UserId userId,
                                         String appId,
                                         Set<String> fields,
                                         CollectionOptions options,
                                         Set<String> albumIds,
                                         SecurityToken token)
                                           throws ProtocolException

Retrieves albums for the given user with the given album IDs.

Specified by:: getAlbums in interface AlbumService
Parameters:: userId - Identifies the person to retrieve albums for; appId - Identifies the application to retrieve albums from; fields - The fields to return; empty set implies all; options - The sorting/filtering/pagination options; albumIds - The set of album ids to fetch; token - A valid SecurityToken
Returns:: a response item with requested albums
Throws:: ProtocolException

getAlbums

public Future<RestfulCollection<Album>> getAlbums(Set<UserId> userIds,
                                         GroupId groupId,
                                         String appId,
                                         Set<String> fields,
                                         CollectionOptions options,
                                         SecurityToken token)
                                           throws ProtocolException

Retrieves albums for the given user and group.

Specified by:: getAlbums in interface AlbumService
Parameters:: userIds - Identifies the users to retrieve albums from; groupId - Identifies the group to retrieve albums from; appId - Identifies the application to retrieve albums from; fields - The fields to return. Empty set implies all; options - The sorting/filtering/pagination options; token - A valid SecurityToken
Returns:: a response item with the requested albums
Throws:: ProtocolException

deleteAlbum
```
public Future<Void> deleteAlbum(UserId userId,
                       String appId,
                       String albumId,
                       SecurityToken token)
                         throws ProtocolException
```
Deletes a single album for the given user with the given album ID.

Specified by:

deleteAlbum in interface AlbumService

Parameters:
userId - Identifies the user to delete the album from
appId - Identifies the application to delete the album from
albumId - Identifies the album to delete
token - A valid SecurityToken

Returns:
a response item containing any errors

Throws:

ProtocolException

createAlbum
```
public Future<Void> createAlbum(UserId userId,
                       String appId,
                       Album album,
                       SecurityToken token)
                         throws ProtocolException
```
Creates an album for the given user.

Specified by:

createAlbum in interface AlbumService

Parameters:
userId - Identifies the user to create the album for
appId - Identifies the application to create the album in
album - The album to create
token - A valid SecurityToken

Returns:
a response containing any errors

Throws:

ProtocolException

updateAlbum
```
public Future<Void> updateAlbum(UserId userId,
                       String appId,
                       Album album,
                       String albumId,
                       SecurityToken token)
                         throws ProtocolException
```
Updates an album for the given user. The album ID specified in the REST end-point is used, even if the album also defines an ID.

Specified by:

updateAlbum in interface AlbumService

Parameters:
userId - Identifies the user to update the album for
appId - Identifies the application to update the album in
album - Defines the updated album
albumId - Identifies the ID of the album to update
token - A valid SecurityToken

Returns:
a response containing any errors

Throws:

ProtocolException

getMediaItem

public Future<MediaItem> getMediaItem(UserId userId,
                             String appId,
                             String albumId,
                             String mediaItemId,
                             Set<String> fields,
                             SecurityToken token)
                               throws ProtocolException

Retrieves a MediaItem by ID.

Specified by:: getMediaItem in interface MediaItemService
Parameters:: userId - Identifies the owner of the MediaItem to retrieve; appId - Identifies the application of the MeiaItem to retrieve; albumId - Identifies the album containing the MediaItem; mediaItemId - Identifies the MediaItem to retrieve; fields - Indicates fields to be returned; empty set implies all; token - A valid SecurityToken
Returns:: a response item with the requested MediaItem
Throws:: ProtocolException

getMediaItems

public Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId,
                                                 String appId,
                                                 String albumId,
                                                 Set<String> mediaItemIds,
                                                 Set<String> fields,
                                                 CollectionOptions options,
                                                 SecurityToken token)
                                                   throws ProtocolException

Retrieves MediaItems by IDs.

Specified by:: getMediaItems in interface MediaItemService
Parameters:: userId - Identifies the owner of the MediaItems; appId - Identifies the application of the MediaItems; albumId - Identifies the album containing the MediaItems; mediaItemIds - Identifies the MediaItems to retrieve; fields - Specifies the fields to return; empty set implies all; options - Sorting/filtering/pagination options; token - A valid SecurityToken
Returns:: a response item with the requested MediaItems
Throws:: ProtocolException

getMediaItems

public Future<RestfulCollection<MediaItem>> getMediaItems(UserId userId,
                                                 String appId,
                                                 String albumId,
                                                 Set<String> fields,
                                                 CollectionOptions options,
                                                 SecurityToken token)
                                                   throws ProtocolException

Retrieves MediaItems by Album.

Specified by:: getMediaItems in interface MediaItemService
Parameters:: userId - Identifies the owner of the MediaItems; appId - Identifies the application of the MediaItems; albumId - Identifies the Album containing the MediaItems; fields - Specifies the fields to return; empty set implies all; options - Sorting/filtering/pagination options; token - A valid SecurityToken
Returns:: a response item with the requested MediaItems
Throws:: ProtocolException

getMediaItems

public Future<RestfulCollection<MediaItem>> getMediaItems(Set<UserId> userIds,
                                                 GroupId groupId,
                                                 String appId,
                                                 Set<String> fields,
                                                 CollectionOptions options,
                                                 SecurityToken token)
                                                   throws ProtocolException

Retrieves MediaItems by users and groups.

Specified by:: getMediaItems in interface MediaItemService
Parameters:: userIds - Identifies the users that this request is relative to; groupId - Identifies the users' groups to retrieve MediaItems from; appId - Identifies the application to retrieve MediaItems from; fields - The fields to return; empty set implies all; options - Sorting/filtering/pagination options; token - A valid SecurityToken
Returns:: a response item with the requested MediaItems
Throws:: ProtocolException

deleteMediaItem

public Future<Void> deleteMediaItem(UserId userId,
                           String appId,
                           String albumId,
                           String mediaItemId,
                           SecurityToken token)
                             throws ProtocolException

Deletes a MediaItem by ID.

Specified by:: deleteMediaItem in interface MediaItemService
Parameters:: userId - Identifies the owner of the MediaItem to delete; appId - Identifies the application hosting the MediaItem; albumId - Identifies the parent album of the MediaItem; mediaItemId - Identifies the MediaItem to delete; token - A valid SecurityToken
Returns:: a response item containing any errors
Throws:: ProtocolException

createMediaItem
```
public Future<Void> createMediaItem(UserId userId,
                           String appId,
                           String albumId,
                           MediaItem mediaItem,
                           SecurityToken token)
                             throws ProtocolException
```
Create a MediaItem in the given album for the given user.

Specified by:

createMediaItem in interface MediaItemService

Parameters:
userId - Identifies the owner of the MediaItem to create
appId - Identifies the application hosting the MediaItem
albumId - Identifies the album to contain the MediaItem
mediaItem - The MediaItem to create
token - A valid SecurityToken

Returns:
a response containing any errors

Throws:

ProtocolException

updateMediaItem
```
public Future<Void> updateMediaItem(UserId userId,
                           String appId,
                           String albumId,
                           String mediaItemId,
                           MediaItem mediaItem,
                           SecurityToken token)
                             throws ProtocolException
```
Updates a MediaItem for the given user. The MediaItem ID specified in the REST end-point is used, even if the MediaItem also defines an ID.

Specified by:

updateMediaItem in interface MediaItemService

Parameters:
userId - Identifies the owner of the MediaItem to update
appId - Identifies the application hosting the MediaItem
albumId - Identifies the album containing the MediaItem
mediaItemId - Identifies the MediaItem to update
mediaItem - The updated MediaItem to persist
token - A valid SecurityToken

Returns:
a response containing any errors

Throws:

ProtocolException

updateActivityEntry

public Future<ActivityEntry> updateActivityEntry(UserId userId,
                                        GroupId groupId,
                                        String appId,
                                        Set<String> fields,
                                        ActivityEntry activityEntry,
                                        String activityId,
                                        SecurityToken token)
                                          throws ProtocolException

Updates the specified Activity.

Specified by:: updateActivityEntry in interface ActivityStreamService
Parameters:: userId - The id of the person to update the activity for; groupId - The group; appId - The app id; fields - The fields to return; activityEntry - The updated activity; activityId - The id of the existing activity to update; token - A valid SecurityToken
Returns:: a response item containing any errors
Throws:: ProtocolException - if any

createActivityEntry

public Future<ActivityEntry> createActivityEntry(UserId userId,
                                        GroupId groupId,
                                        String appId,
                                        Set<String> fields,
                                        ActivityEntry activityEntry,
                                        SecurityToken token)
                                          throws ProtocolException

Creates the passed in activity for the passed in user and group. Once createActivity is called, getActivities will be able to return the Activity.

Specified by:: createActivityEntry in interface ActivityStreamService
Parameters:: userId - The id of the person to create the activity for.; groupId - The group.; appId - The app id.; fields - The fields to return.; activityEntry - The activity to create.; token - A valid SecurityToken
Returns:: a response item containing any errors
Throws:: ProtocolException - if any.

deleteActivityEntries

public Future<Void> deleteActivityEntries(UserId userId,
                                 GroupId groupId,
                                 String appId,
                                 Set<String> activityIds,
                                 SecurityToken token)
                                   throws ProtocolException

Deletes the activity for the passed in user and group that corresponds to the activityId.

Specified by:: deleteActivityEntries in interface ActivityStreamService
Parameters:: userId - The user.; groupId - The group.; appId - The app id.; activityIds - A list of activity ids to delete.; token - A valid SecurityToken.
Returns:: a response item containing any errors
Throws:: ProtocolException - if any.

getActivityEntry

public Future<ActivityEntry> getActivityEntry(UserId userId,
                                     GroupId groupId,
                                     String appId,
                                     Set<String> fields,
                                     String activityId,
                                     SecurityToken token)
                                       throws ProtocolException

Returns an activity for the passed in user and group that corresponds to a single activityId.

Specified by:: getActivityEntry in interface ActivityStreamService
Parameters:: userId - The set of ids of the people to fetch activities for.; groupId - Indicates whether to fetch activities for a group.; appId - The app id.; fields - The fields to return. Empty set implies all; activityId - The activity id to fetch.; token - A valid SecurityToken
Returns:: a response item with the list of activities.
Throws:: ProtocolException - if any.

getActivityEntries

public Future<RestfulCollection<ActivityEntry>> getActivityEntries(Set<UserId> userIds,
                                                          GroupId groupId,
                                                          String appId,
                                                          Set<String> fields,
                                                          CollectionOptions options,
                                                          SecurityToken token)
                                                            throws ProtocolException

Returns a list of activities that correspond to the passed in users and group.

Specified by:: getActivityEntries in interface ActivityStreamService
Parameters:: userIds - The set of ids of the people to fetch activities for.; groupId - Indicates whether to fetch activities for a group.; appId - The app id.; fields - The fields to return. Empty set implies all; options - The sorting/filtering/pagination options; token - A valid SecurityToken
Returns:: a response item with the list of activities.
Throws:: ProtocolException - if any.

getActivityEntries

public Future<RestfulCollection<ActivityEntry>> getActivityEntries(UserId userId,
                                                          GroupId groupId,
                                                          String appId,
                                                          Set<String> fields,
                                                          CollectionOptions options,
                                                          Set<String> activityIds,
                                                          SecurityToken token)
                                                            throws ProtocolException

Returns a set of activities for the passed in user and group that corresponds to a list of activityIds.

Specified by:: getActivityEntries in interface ActivityStreamService
Parameters:: userId - The set of ids of the people to fetch activities for.; groupId - Indicates whether to fetch activities for a group.; appId - The app id.; fields - The fields to return. Empty set implies all; options - The sorting/filtering/pagination options; activityIds - The set of activity ids to fetch.; token - A valid SecurityToken
Returns:: a response item with the list of activities.
Throws:: ProtocolException - if any.

filterFields

public <T> T filterFields(JSONObject object,
                 Set<String> fields,
                 Class<T> clz)
               throws JSONException

Throws:: JSONException

Class JsonDbOpensocialService

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.shindig.social.opensocial.spi.MessageService

Nested classes/interfaces inherited from interface org.apache.shindig.social.opensocial.spi.AlbumService

Nested classes/interfaces inherited from interface org.apache.shindig.social.opensocial.spi.MediaItemService

Field Summary

Fields inherited from interface org.apache.shindig.social.opensocial.spi.PersonService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JsonDbOpensocialService

Method Detail

getDb

setDb

setAuthority

getActivities

getActivities

getActivity

deleteActivities

createActivity

getPeople

getPerson

updatePerson

viewerCanUpdatePerson

getPersonData

deletePersonData

updatePersonData

getGroups

createMessage

getMessageCollections

deleteMessages

getMessages

createMessageCollection

modifyMessage

modifyMessageCollection

deleteMessageCollection

getPassword

getIdSet

getAlbum

getAlbums

getAlbums

deleteAlbum

createAlbum

updateAlbum

getMediaItem

getMediaItems

getMediaItems

getMediaItems

deleteMediaItem

createMediaItem

updateMediaItem

updateActivityEntry

createActivityEntry

deleteActivityEntries

getActivityEntry

getActivityEntries

getActivityEntries

filterFields