service.tut.pori.twitterjazz.reference

Class ClientService

java.lang.Object

service.tut.pori.twitterjazz.reference.ClientService

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

Reference implementation for client API methods. This class defines the APIs available for clients.

Implementation Service path tj

See Also:

TwitterJazzService

Constructor Summary

Constructors

Constructor and Description
ClientService()

Method Summary

Modifier and Type	Method and Description
Response	retrieveTagsForUser(AuthenticationParameter authenticatedUser, DataGroups dataGroups, Limits limits, SortOptions sortOptions) Clients can use this method for retrieving a list of tags extracted by the profile summarization.
void	setRank(AuthenticationParameter authenticatedUser, StringParameter ranks) Clients can use this method for ranking (rating) tags.
void	summarize(AuthenticationParameter authenticatedUser, StringParameter contentTypes, StringParameter screenNames, BooleanParameter synchronize) Clients can use this method to initialize account summarization, and optionally perform synchronization for photo content.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientService

public ClientService()

Method Detail

retrieveTagsForUser

@HTTPServiceMethod(name="getTags",
                   acceptedMethods="GET")
public Response retrieveTagsForUser(@HTTPAuthenticationParameter(required=false)
                                                                                                                   AuthenticationParameter authenticatedUser,
                                                                                                                   @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                   DataGroups dataGroups,
                                                                                                                   @HTTPMethodParameter(name="limits",required=false)
                                                                                                                   Limits limits,
                                                                                                                   @HTTPMethodParameter(name="sort",required=false)
                                                                                                                   SortOptions sortOptions)

Clients can use this method for retrieving a list of tags extracted by the profile summarization. This will always return the tags for the currently authenticated user.

Example Query:

GET /rest/tjrc/getTags

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="getTags" service="tjrc">
  <objectList>
    <object>
      <backendId>2115546381</backendId>
      <confidence>0.500456110839142</confidence>
      <mediaObjectId>3863005906970416638</mediaObjectId>
      <mediaType>PHOTO</mediaType>
      <objectId>iRqyrxaILfuKvsGVcGpiOyfYqPjmfcDegEbTYCZGQyJFrPCXMTvMISZYcZiYqHPY</objectId>
      <rank>1615346049</rank>
      <serviceId>5</serviceId>
      <status>NO_FRIENDLY_KEYWORD</status>
      <objectType>KEYWORD</objectType>
      <value>dwaiHoWjkTUxEteBbzwbPgkerYPMWVLRHYbgEFMdADAursWVqoWziimaNiPzYLiu</value>
      <visibility>PRIVATE</visibility>
      <userId>3396603758941181192</userId>
    </object>
  </objectList>
  <status>OK</status>
</response>

Parameters:

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

sortOptions - supported element names are confidence, rank and value. Default sorting order is the original addition order of the objects.

dataGroups - For supported data groups see ClientService.retrieveMediaObjects(AuthenticationParameter, DataGroups, Limits, core.tut.pori.http.parameters.IntegerParameter, StringParameter).

limits - paging limits

Returns:

See MediaObjectList

setRank

@HTTPServiceMethod(name="setRank",
                   acceptedMethods="POST")
public void setRank(@HTTPAuthenticationParameter(required=false)
                                                                                                    AuthenticationParameter authenticatedUser,
                                                                                                    @HTTPMethodParameter(name="rank")
                                                                                                    StringParameter ranks)

Clients can use this method for ranking (rating) tags.

Example Query:

GET /rest/tjrc/setRank?rank=1;100,2;-10

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="setRank" service="tjrc">
  <status>OK</status>
</response>

Parameters:

authenticatedUser - Note: this method requires authentication and the user must have authorized the use of his/her Twitter account, but for the reference implementation, anonymous access is granted.

ranks - with format rank=mediaObjectId;VALUE,mediaObjectId;VALUE, ...

summarize

@HTTPServiceMethod(name="summarize")
public void summarize(@HTTPAuthenticationParameter(required=false)
                                                            AuthenticationParameter authenticatedUser,
                                                            @HTTPMethodParameter(name="content_types",required=false)
                                                            StringParameter contentTypes,
                                                            @HTTPMethodParameter(name="screen_names",required=false)
                                                            StringParameter screenNames,
                                                            @HTTPMethodParameter(name="synchronize",required=false)
                                                            BooleanParameter synchronize)

Clients can use this method to initialize account summarization, and optionally perform synchronization for photo content.

Example Query:

GET /rest/tjrc/summarize

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="summarize" service="tjrc">
  <status>OK</status>
</response>

Parameters:

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

contentTypes - Any combination of content types. By default, all content types will be used. See TwitterExtractor.ContentType

screenNames - The screen names of the accounts to be summarized. The authenticated user must have permissions granted by Twitter to summarize the accounts for the operation to complete successfully. If no screen names are given, the summarization is performed for the user's own Twitter account.

synchronize - On true synchronizes the photo content of the user's account. Photo analysis tasks will be created and fully executed for new content using default analysis back-ends prior to starting the summarization task.