service.tut.pori.facebookjazz.reference

Class ClientService

java.lang.Object

service.tut.pori.facebookjazz.reference.ClientService

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

Reference implementation for client API methods.

Implementation Service path fbj

See Also:

FacebookJazzService

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.
Response	retrieveTagWeights(AuthenticationParameter authenticatedUser, LongParameter userIdFilter) Clients can use this method for retrieving tag weight modifiers.
void	setRank(AuthenticationParameter authenticatedUser, StringParameter ranks) Clients can use this method for ranking (rating) tags.
void	setTagWeights(AuthenticationParameter authenticatedUser, InputStreamParameter xml) Clients can use this method to set tag weights.
void	summarize(AuthenticationParameter authenticatedUser, StringParameter contentTypes, 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/fbjrc/getTags

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="getTags" service="fbjrc">
  <objectList>
    <object>
      <backendId>203928532</backendId>
      <confidence>0.3510008866926393</confidence>
      <mediaObjectId>4142749448097315215</mediaObjectId>
      <mediaType>PHOTO</mediaType>
      <objectId>tFbngFsmiSXNccLVtlXgRuSyOPvRnMtPTVjklmhfeWonImWXTYiWetNSesiJGrmx</objectId>
      <rank>2036417319</rank>
      <serviceId>3</serviceId>
      <status>NO_FRIENDLY_KEYWORD</status>
      <objectType>KEYWORD</objectType>
      <value>lbflYYkBzgPXsNnHqtxlJiNrDsSZzbPTortkQcuhHLvZuUiKaNXYBHpAoicKLyzJ</value>
      <visibility>PRIVATE</visibility>
      <userId>8817563211478532438</userId>
    </object>
  </objectList>
  <status>OK</status>
</response>

Parameters:

authenticatedUser - This method requires user authentication. The user must have authorized the use of his/her Facebook account. 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/fbjrc/setRank?rank=1;100,2;-10

Example Result:

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

Parameters:

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

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

retrieveTagWeights

@HTTPServiceMethod(name="getTagWeights",
                   acceptedMethods="GET")
public Response retrieveTagWeights(@HTTPAuthenticationParameter(required=false)
                                                                                                                        AuthenticationParameter authenticatedUser,
                                                                                                                        @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                        LongParameter userIdFilter)

Clients can use this method for retrieving tag weight modifiers.

Example Query:

GET /rest/fbjrc/getTagWeights

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="getTagWeights" service="fbjrc">
  <weightModifierList>
    <weightModifier>
      <value>3</value>
      <modifierType>VIDEO_DESCRIPTION__COMMENT_MESSAGE</modifierType>
    </weightModifier>
    <weightModifier>
      <value>1</value>
      <modifierType>STATUS_MESSAGE__MESSAGE</modifierType>
    </weightModifier>
    <weightModifier>
      <value>3</value>
      <modifierType>PHOTO_DESCRIPTION__COMMENT_MESSAGE</modifierType>
    </weightModifier>
    <weightModifier>
      <value>0</value>
      <modifierType>GROUP__DESCRIPTION</modifierType>
    </weightModifier>
    <weightModifier>
      <value>1</value>
      <modifierType>STATUS_MESSAGE__COMMENT_MESSAGE</modifierType>
    </weightModifier>
    <weightModifier>
      <value>3</value>
      <modifierType>EVENT__DESCRIPTION</modifierType>
    </weightModifier>
    <weightModifier>
      <value>4</value>
      <modifierType>VIDEO_DESCRIPTION__DESCRIPTION</modifierType>
    </weightModifier>
    <weightModifier>
      <value>3</value>
      <modifierType>EVENT__NAME</modifierType>
    </weightModifier>
    <weightModifier>
      <value>3</value>
      <modifierType>GROUP__NAME</modifierType>
    </weightModifier>
    <weightModifier>
      <value>2</value>
      <modifierType>PHOTO_DESCRIPTION__DESCRIPTION</modifierType>
    </weightModifier>
  </weightModifierList>
  <status>OK</status>
</response>

Parameters:

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

userIdFilter - User id filter, if not given the default tag weights will be returned.

Returns:

See WeightModifierList

setTagWeights

@HTTPServiceMethod(name="setTagWeights",
                   acceptedMethods="POST")
public void setTagWeights(@HTTPAuthenticationParameter(required=false)
                                                                                                                AuthenticationParameter authenticatedUser,
                                                                                                                @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                                InputStreamParameter xml)

Clients can use this method to set tag weights. POST /rest/fbjrc/setTagWeights
Content-Type: text/xml; charset=UTF-8

[HTTP BODY STARTS]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<weightModifierList>
  <weightModifier>
    <value>1</value>
    <modifierType>VIDEO_DESCRIPTION__COMMENT_MESSAGE</modifierType>
  </weightModifier>
  <weightModifier>
    <value>4</value>
    <modifierType>PHOTO_DESCRIPTION__COMMENT_MESSAGE</modifierType>
  </weightModifier>
  <weightModifier>
    <value>2</value>
    <modifierType>STATUS_MESSAGE__MESSAGE</modifierType>
  </weightModifier>
  <weightModifier>
    <value>0</value>
    <modifierType>GROUP__DESCRIPTION</modifierType>
  </weightModifier>
  <weightModifier>
    <value>0</value>
    <modifierType>GROUP__NAME</modifierType>
  </weightModifier>
  <weightModifier>
    <value>4</value>
    <modifierType>EVENT__DESCRIPTION</modifierType>
  </weightModifier>
  <weightModifier>
    <value>2</value>
    <modifierType>EVENT__NAME</modifierType>
  </weightModifier>
  <weightModifier>
    <value>0</value>
    <modifierType>STATUS_MESSAGE__COMMENT_MESSAGE</modifierType>
  </weightModifier>
  <weightModifier>
    <value>4</value>
    <modifierType>VIDEO_DESCRIPTION__DESCRIPTION</modifierType>
  </weightModifier>
  <weightModifier>
    <value>2</value>
    <modifierType>PHOTO_DESCRIPTION__DESCRIPTION</modifierType>
  </weightModifier>
</weightModifierList>

[HTTP BODY ENDS]

Example Result:

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

Parameters:

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

xml - The tag weight modifiers for the user. See WeightModifierList

summarize

@HTTPServiceMethod(name="summarize")
public void summarize(@HTTPAuthenticationParameter(required=false)
                                                            AuthenticationParameter authenticatedUser,
                                                            @HTTPMethodParameter(name="content_types",required=false)
                                                            StringParameter contentTypes,
                                                            @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/fbjrc/summarize

Example Result:

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

Parameters:

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

contentTypes - Any combination of content types. Valid types are: events, generated_tags, groups, likes, photo_descriptions, status_messages, video_descriptions. See FacebookExtractor.ContentType

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