service.tut.pori.contentstorage.reference

Class ClientService

java.lang.Object

service.tut.pori.contentstorage.reference.ClientService

@HTTPService(name="cosrc")
public class ClientService
extends java.lang.Object

Reference implementation for client API methods.

Implementation Service path cos

See Also:

ContentStorageService

Constructor Summary

Constructors

Constructor and Description
ClientService()

Method Summary

Modifier and Type	Method and Description
Response	addUrl(AuthenticationParameter authenticatedUser, IntegerParameter backendId, StringParameter url) This method can be used to add files denoted by arbitrary URL links to the service.
void	synchronize(AuthenticationParameter authenticatedUser, IntegerParameter backendId, IntegerParameter serviceId) This method allows the user to initialize external account synchronization.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientService

public ClientService()

Method Detail

synchronize

@HTTPServiceMethod(name="synchronize")
public void synchronize(@HTTPAuthenticationParameter(required=false)
                                                                AuthenticationParameter authenticatedUser,
                                                                @HTTPMethodParameter(name="backend_id",required=false)
                                                                IntegerParameter backendId,
                                                                @HTTPMethodParameter(name="service_id")
                                                                IntegerParameter serviceId)

This method allows the user to initialize external account synchronization. The synchronization process is always performed as a scheduled task, and thus, may not complete immediately. For new content discovered during the synchronization process, a new analysis task will be created, and the task will be automatically added for the appropriate analysis back-ends.

Parameters:

authenticatedUser - Note: this method requires authentication, but for the reference implementation, anonymous access is granted.

backendId - Back-ends used for the analysis of the generated tasks. If no back-end IDs are given, the default back-ends will be used. An attempt to give incompatible back-ends may result in failure of the entire task. When providing specific back-ends by Id one should make sure that the back-ends are capable of performing the requested tasks.

serviceId - Any combination of supported external providers designated by serviceIds. The supported id values are: 1 (Picasa), 2 (FSIO), 4 (Facebook), 6 (Twitter), 7 (Url Storage). See CAContentCore.ServiceType

addUrl

@HTTPServiceMethod(name="addUrl",
                   acceptedMethods="POST")
public Response addUrl(@HTTPAuthenticationParameter(required=false)
                                                                                                      AuthenticationParameter authenticatedUser,
                                                                                                      @HTTPMethodParameter(name="backend_id",required=false)
                                                                                                      IntegerParameter backendId,
                                                                                                      @HTTPMethodParameter(name="url")
                                                                                                      StringParameter url)

This method can be used to add files denoted by arbitrary URL links to the service. Photo and video analysis tasks will be scheduled for the added URLs and submitted for back-ends. The files must be publicly accessible and of one of file types supported by the validator MediaUrlValidator.

Parameters:

authenticatedUser - Note: this method requires authentication, but for the reference implementation, anonymous access is granted.

backendId - Back-ends used for the analysis of the generated tasks. If no back-end IDs are given, the default back-ends will be used. An attempt to give incompatible back-ends may result in failure of the entire task. When providing specific back-ends by Id one should make sure that the back-ends are capable of performing the requested tasks.

url - Any number of URL links.

Returns:

See MediaList