service.tut.pori.contentanalysis.reference

Class ServerService

java.lang.Object

service.tut.pori.contentanalysis.reference.ServerService

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

Reference implementation for Server APIs.

Implementation Service path ca

See Also:

ContentAnalysisService

Constructor Summary

Constructors

Constructor and Description
ServerService()

Method Summary

Modifier and Type	Method and Description
Response	queryTaskDetails(IntegerParameter backendId, LongParameter taskId, DataGroups dataGroups, Limits limits) This method can be used to retrieve the up-to-date details and progress of a previously scheduled task.
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/cars/taskFinished
Content-Type: text/xml; charset=UTF-8

[HTTP BODY STARTS]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskResults>
  <backendId>1451330169</backendId>
  <message>uiqIFeKrpkPEhPVuvbDLXCaBkYNCmwFHQbkFUWUcmdckUimaPDZmFbrqCtudMiRn</message>
  <status>NOT_STARTED</status>
  <taskId>6454670730162539352</taskId>
  <taskType>ANALYSIS</taskType>
  <mediaList>
    <media>
      <UID>858900cc-6a02-4e2c-baba-8799d50e603b</UID>
      <serviceId>6</serviceId>
      <objectList>
        <object>
          <backendId>1451330169</backendId>
          <confidence>0.43121354314658733</confidence>
          <mediaObjectId>776062905985165415</mediaObjectId>
          <mediaType>PHOTO</mediaType>
          <objectId>IXvjFAKuDPJOnOmhXmzYowrzFhHDNyHJGaOOptIZbCoSKnbUhvLkpEjHaKrvSGYt</objectId>
          <rank>234424966</rank>
          <serviceId>6</serviceId>
          <status>USER_REJECTED</status>
          <objectType>KEYWORD</objectType>
          <value>mwdZxaptGtYKPHQZjxYlOHvEDbTboDxdEHDVzEUZxkZFLBzsIFoBdIzEOaJdxwfI</value>
          <visibility>PUBLIC</visibility>
          <userId>1020157765518368186</userId>
        </object>
      </objectList>
      <mediaType>PHOTO</mediaType>
      <userId>1020157765518368186</userId>
      <url>http://fe.example.org/rest/carc/r?uid=858900cc-6a02-4e2c-baba-8799d50e603b&amp;service_id=6</url>
    </media>
  </mediaList>
</taskResults>

[HTTP BODY ENDS]

Example Result:

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

Parameters:

xml - Only the result data should be in the body. See PhotoTaskResponse

queryTaskDetails

@HTTPServiceMethod(name="queryTaskDetails",
                   acceptedMethods="GET")
public Response queryTaskDetails(@HTTPMethodParameter(name="backend_id")
                                                                                                                         IntegerParameter backendId,
                                                                                                                         @HTTPMethodParameter(name="task_id")
                                                                                                                         LongParameter taskId,
                                                                                                                         @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                         DataGroups dataGroups,
                                                                                                                         @HTTPMethodParameter(name="limits",required=false)
                                                                                                                         Limits limits)

This method can be used to retrieve the up-to-date details and progress of a previously scheduled task.

Example Query:

GET /rest/cars/queryTaskDetails?task_id=1&backend_id=1

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="queryTaskDetails" service="cars">
  <taskDetails>
    <backendId>1</backendId>
    <taskId>1</taskId>
    <taskType>ANALYSIS</taskType>
    <callbackUri>http://fe.example.org/rest/ca/taskFinished</callbackUri>
    <userId>5384471730116722558</userId>
    <mediaList>
      <media>
        <UID>1edbafd8-1bd5-4c14-864b-e2c78ff3334b</UID>
        <serviceId>4</serviceId>
        <objectList>
          <object>
            <backendId>197727339</backendId>
            <confidence>0.6537614795019214</confidence>
            <mediaObjectId>7007962261296526147</mediaObjectId>
            <mediaType>PHOTO</mediaType>
            <objectId>MiDtmROmGsQKfHISHHrBLOntYyRGYHfmpyCOaFelwePBsMTSRcLjbHFmZnanBJAs</objectId>
            <rank>24706023</rank>
            <serviceId>6</serviceId>
            <status>USER_REJECTED</status>
            <objectType>KEYWORD</objectType>
            <value>yAUYvurUgmEoZeZwEwFlLpnwKqbtEggsHWYyzEIzNfEjWRaxMZTqCDRzxGovyQEF</value>
            <visibility>GROUP</visibility>
            <userId>5384471730116722558</userId>
          </object>
        </objectList>
        <mediaType>PHOTO</mediaType>
        <userId>5384471730116722558</userId>
        <url>http://fe.example.org/rest/carc/r?uid=1edbafd8-1bd5-4c14-864b-e2c78ff3334b&amp;service_id=4</url>
      </media>
    </mediaList>
    <userConfidence>0.9546867449051889</userConfidence>
  </taskDetails>
  <status>OK</status>
</response>

Parameters:

taskId -

backendId - used to provide custom task details for specific back-ends

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

limits - paging limits

Returns:

response