org.apache.shindig.social.opensocial.spi

Class MediaItemService.NotImplementedMediaItemService

java.lang.Object

org.apache.shindig.social.opensocial.spi.MediaItemService.NotImplementedMediaItemService

All Implemented Interfaces:

MediaItemService

Enclosing interface:

MediaItemService

public static class MediaItemService.NotImplementedMediaItemService
extends Object
implements MediaItemService

Nested Class Summary

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

MediaItemService.NotImplementedMediaItemService

Constructor Summary

Constructors

Constructor and Description
MediaItemService.NotImplementedMediaItemService()

Method Summary

Methods

Modifier and Type	Method and Description
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>	deleteMediaItem(UserId userId, String appId, String albumId, String mediaItemId, SecurityToken token) Deletes a MediaItem by ID.
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<Void>	updateMediaItem(UserId userId, String appId, String albumId, String mediaItemId, MediaItem mediaItem, SecurityToken token) Updates a MediaItem for the given user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MediaItemService.NotImplementedMediaItemService

public MediaItemService.NotImplementedMediaItemService()

Method Detail

getMediaItem

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

Description copied from interface: MediaItemService

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

Description copied from interface: MediaItemService

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

Description copied from interface: MediaItemService

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

Description copied from interface: MediaItemService

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

Description copied from interface: MediaItemService

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

Description copied from interface: MediaItemService

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

Description copied from interface: MediaItemService

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