service.tut.pori.twitterjazz.reference

Class ServerService

java.lang.Object

service.tut.pori.twitterjazz.reference.ServerService

@HTTPService(name="tjrs")
public class ServerService
extends java.lang.Object

Reference implementation for Server APIs. This class defines the APIs offered by the Front-end to Analysis Back-ends.

Implementation Service path tj

See Also:

TwitterJazzService

Constructor Summary

Constructors

Constructor and Description
ServerService()

Method Summary

Modifier and Type	Method and Description
void	taskFinished(InputStreamParameter xml) The request is to be sent in the body of POST method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerService

public ServerService()

Method Detail

taskFinished

@HTTPServiceMethod(name="taskFinished",
                   acceptedMethods="POST")
public void taskFinished(@HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                              InputStreamParameter xml)

The request is to be sent in the body of POST method. The Content-Type header MUST be set to "text/xml". The character set MUST be UTF-8. For example, "Content-Type: text/xml; charset=UTF-8". The method can be called multiple times by the back-ends. Each call is assumed to be an incremental update on the previous one and can contain any amount of new information. It is also possible to update previously submitted data by using the same identifiers: photo GUID (for photos), and media object id or a combination of back-end id and object id (for media objects). Task results may contain photo specific back-end status information, though it is not required. Using an invalid back-end id (both for the task and the generated media objects) can result in an error, causing the entire task result to be rejected. It is not allowed for a one back-end to update/modify media objects previously submitted by another back-end, or by the user.

Example Query:

POST /rest/tjrs/taskFinished
Content-Type: text/xml; charset=UTF-8

[HTTP BODY STARTS]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskResults>
  <backendId>1092719603</backendId>
  <message>GFlpeYbaFnNaXtWbxxyARcTDmEiiFyldHLfOWENGYFOUeOzafgMzwdQQEZydxWLV</message>
  <status>COMPLETED</status>
  <taskId>3865631808994089266</taskId>
  <taskType>TWITTER_PROFILE_SUMMARIZATION</taskType>
  <mediaList>
    <media>
      <UID>c107d0f3-7f0c-4ff2-8eac-6c603aa6eeac</UID>
      <serviceId>4</serviceId>
      <objectList>
        <object>
          <backendId>1092719603</backendId>
          <confidence>0.5427210968308597</confidence>
          <mediaObjectId>7895382001893624411</mediaObjectId>
          <mediaType>PHOTO</mediaType>
          <objectId>oxBjvowAZlHmqOzJwmxGNlmdkCafmrvfScMpgtmFPGBssJEDeWPgxBUPhikNqwVk</objectId>
          <rank>163245872</rank>
          <serviceId>3</serviceId>
          <status>BACKEND_REMOVED</status>
          <objectType>KEYWORD</objectType>
          <value>XncWhyteFXpOdKTZEWcuGchLyIcbetLdKEuczzVphVJCrDLYuhSoOLdccfKWDMXB</value>
          <visibility>PUBLIC</visibility>
          <userId>7964074008204941002</userId>
        </object>
      </objectList>
      <mediaType>PHOTO</mediaType>
      <userId>7964074008204941002</userId>
      <url>http://fe.example.org/rest/carc/r?uid=c107d0f3-7f0c-4ff2-8eac-6c603aa6eeac&amp;service_id=1</url>
    </media>
  </mediaList>
  <objectList>
    <object>
      <backendId>1092719603</backendId>
      <confidence>0.837558865072154</confidence>
      <mediaObjectId>4113846974832924344</mediaObjectId>
      <mediaType>PHOTO</mediaType>
      <objectId>WJGHgneHerKTyxayiaKYyXhOGWTNiMhKDMinjLTyfkZgGaTqsDwnOiyTVhbGIpnJ</objectId>
      <rank>604063011</rank>
      <serviceId>3</serviceId>
      <status>NO_FRIENDLY_KEYWORD</status>
      <objectType>KEYWORD</objectType>
      <value>myLKpAoLjNCpVjOJdkHWuCUMhdEKRFUoAilZDwXqJsTUWdYlngjvgvezGZrngLnV</value>
      <visibility>PRIVATE</visibility>
      <userId>1265263543917157641</userId>
    </object>
  </objectList>
</taskResults>

[HTTP BODY ENDS]

Example Result:

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

Parameters:

xml - The HTTP body. Only the result data should be in the body. See TwitterTaskResponse