service.tut.pori.contentanalysis.video.reference

Class ClientService

java.lang.Object

service.tut.pori.contentanalysis.video.reference.ClientService

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

Reference implementation for client API methods.

Implementation Service path vca

See Also:

VideoAnalysisService

Constructor Summary

Constructors

Constructor and Description
ClientService()

Method Summary

Modifier and Type	Method and Description
Response	getVideos(AuthenticationParameter authenticatedUser, StringParameter guid, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIds) This method can be used to retrieve the metadata of one or multiple videos.
RedirectResponse	r(AuthenticationParameter authenticatedUser, IntegerParameter serviceId, StringParameter guid) Redirects the client to the actual video location (i.e.
Response	searchSimilarById(AuthenticationParameter authenticatedUser, StringParameter guid, StringParameter analysisType, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIdFilters) Search for videos which are similar to the video designated by the given GUID parameter.
Response	similarVideosByObject(AuthenticationParameter authenticatedUser, DataGroups dataGroups, Limits limits, IntegerParameter serviceIds, LongParameter userIdFilters, InputStreamParameter xml) Search similar videos by giving a list of reference objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientService

public ClientService()

Method Detail

r

@HTTPServiceMethod(name="r",
                   acceptedMethods="GET")
public RedirectResponse r(@HTTPAuthenticationParameter(required=false)
                                                                                                   AuthenticationParameter authenticatedUser,
                                                                                                   @HTTPMethodParameter(name="service_id")
                                                                                                   IntegerParameter serviceId,
                                                                                                   @HTTPMethodParameter(name="uid")
                                                                                                   StringParameter guid)

Redirects the client to the actual video location (i.e. redirects calls targeted to static front-end URLs to dynamic service specific URLs). The redirection method takes GUID and service id as a parameter. The redirection URLs are automatically generated for analysis tasks and user's search results by the front-end.

Example Query:

GET /rest/vcarc/r?uid=1&service_id=1

Example Result:

REDIRECT / VIDEO CONTENT

Parameters:

authenticatedUser -

serviceId - One of the supported service types, see CAContentCore.ServiceType.

guid - video GUID

Returns:

redirection

similarVideosByObject

@HTTPServiceMethod(name="similarVideosByObject",
                   acceptedMethods="POST")
public Response similarVideosByObject(@HTTPAuthenticationParameter(required=false)
                                                                                                                                    AuthenticationParameter authenticatedUser,
                                                                                                                                    @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                                    DataGroups dataGroups,
                                                                                                                                    @HTTPMethodParameter(name="limits",required=false)
                                                                                                                                    Limits limits,
                                                                                                                                    @HTTPMethodParameter(name="service_id",required=false)
                                                                                                                                    IntegerParameter serviceIds,
                                                                                                                                    @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                                    LongParameter userIdFilters,
                                                                                                                                    @HTTPMethodParameter(name="body",bodyParameter=true)
                                                                                                                                    InputStreamParameter xml)

Search similar videos by giving a list of reference objects. All elements applicable to media objects are accepted as restrictive search terms. Note that missing elements (and element values) are assumed not to be included in the search, except "status" field, which is automatically assumed to be "USER_CONFIRMED" when no value is specified. The Media Object list 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".

Example Query:

POST /rest/vcarc/similarVideosByObject
Content-Type: text/xml; charset=UTF-8

[HTTP BODY STARTS]

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<objectList>
  <object>
    <backendId>875907924</backendId>
    <confidence>0.10630531506439622</confidence>
    <mediaObjectId>8161256170257216820</mediaObjectId>
    <mediaType>PHOTO</mediaType>
    <objectId>xNuTcBYmBwHLFicIkDFEzdlDHRWhxUsdvcBqnvvJKmvxPmgKMbJCxVhrYHVynCTO</objectId>
    <rank>355758344</rank>
    <serviceId>4</serviceId>
    <status>BACKEND_REMOVED</status>
    <objectType>KEYWORD</objectType>
    <value>hGPrGGXMlxBeQcHrhEpSempcDrRvQoFPsLmEbuMXkrOVqwGUyAydzfVuRlBZbvzg</value>
    <visibility>PRIVATE</visibility>
    <userId>9159395943230668015</userId>
  </object>
</objectList>

[HTTP BODY ENDS]

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="similarVideosByObject" service="vcarc">
  <mediaList>
    <media>
      <UID>e7e916c5-3886-4780-8f9d-68c53ccd9098</UID>
      <serviceId>1</serviceId>
      <visibility>PUBLIC</visibility>
      <objectList>
        <object>
          <backendId>1280435513</backendId>
          <confidence>0.4031488564183554</confidence>
          <mediaObjectId>1005384839542859177</mediaObjectId>
          <mediaType>PHOTO</mediaType>
          <objectId>cSpiPFRhrXFgsZpQgIRnzqKehLOwqCPPUqMbUsJOGXeADEbmppXmHhhqRvxIhrwD</objectId>
          <rank>1039658475</rank>
          <serviceId>4</serviceId>
          <status>BACKEND_REMOVED</status>
          <objectType>KEYWORD</objectType>
          <value>kUjdmdPaVUXVnwNDFkjKisAAqkhthvMHzkuRWOrCQwVydsoNpYxxvSLhzbkagRSA</value>
          <visibility>GROUP</visibility>
          <userId>7588960627943186419</userId>
        </object>
      </objectList>
      <mediaType>VIDEO</mediaType>
      <userId>202848066213146809</userId>
      <url>http://fe.example.org/rest/vcarc/r?uid=e7e916c5-3886-4780-8f9d-68c53ccd9098&amp;service_id=1</url>
    </media>
  </mediaList>
  <status>OK</status>
</response>

Parameters:

authenticatedUser -

dataGroups - For supported data groups, see ClientService.retrieveMediaObjects(AuthenticationParameter, DataGroups, Limits, IntegerParameter, StringParameter).

limits - paging limits

serviceIds - serviceIds If given, search is targeted only to the services with the listed ids. For supported service types, see CAContentCore.ServiceType.

userIdFilters - If given, the search will return videos owned by the given user (provided that the currently logged in user has the required permissions).

xml - See MediaObjectList

Returns:

See VideoList

getVideos

@HTTPServiceMethod(name="getVideos",
                   acceptedMethods="GET")
public Response getVideos(@HTTPAuthenticationParameter(required=false)
                                                                                                           AuthenticationParameter authenticatedUser,
                                                                                                           @HTTPMethodParameter(name="uid",required=false)
                                                                                                           StringParameter guid,
                                                                                                           @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                           DataGroups dataGroups,
                                                                                                           @HTTPMethodParameter(name="limits",required=false)
                                                                                                           Limits limits,
                                                                                                           @HTTPMethodParameter(name="service_id",required=false)
                                                                                                           IntegerParameter serviceIds,
                                                                                                           @HTTPMethodParameter(name="user_id",required=false)
                                                                                                           LongParameter userIds)

This method can be used to retrieve the metadata of one or multiple videos. Any combination of parameters may be given for retrieving only the desired content (filtering the results). If you only want a list of media objects, this can be done with the method ClientService.retrieveMediaObjects(AuthenticationParameter, DataGroups, Limits, IntegerParameter, StringParameter). If the user is not authenticated, access is only permitted to publicly available content.

Example Query:

GET /rest/vcarc/getVideos

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="getVideos" service="vcarc">
  <mediaList>
    <media>
      <UID>d3e9f1a7-c3be-448b-8a1f-7c4baa6b5985</UID>
      <serviceId>1</serviceId>
      <objectList>
        <object>
          <backendId>94983579</backendId>
          <confidence>0.0631204073927577</confidence>
          <mediaObjectId>8937132830949458722</mediaObjectId>
          <mediaType>PHOTO</mediaType>
          <objectId>takvukNRfdlrrjSTYJIbCKEegYcEdLAwUnHiDlOTcXKkkTooTsRpAqCdPTKqUiCD</objectId>
          <rank>2058068980</rank>
          <serviceId>6</serviceId>
          <status>USER_CONFIRMED</status>
          <objectType>KEYWORD</objectType>
          <value>UETyWQEBxTITYMYIrCZyQUqqTRjkLUgmBtFgypkYtoPPSpiZdgxBrqRgBqNxxfmD</value>
          <visibility>PRIVATE</visibility>
          <userId>4939735684800670314</userId>
        </object>
      </objectList>
      <mediaType>VIDEO</mediaType>
      <userId>4939735684800670314</userId>
      <url>http://fe.example.org/rest/vcarc/r?uid=d3e9f1a7-c3be-448b-8a1f-7c4baa6b5985&amp;service_id=1</url>
    </media>
  </mediaList>
  <status>OK</status>
</response>

Parameters:

authenticatedUser -

guid - One or more GUIDs for retrieval.

dataGroups - For supported data groups, see ClientService.retrieveMediaObjects(AuthenticationParameter, DataGroups, Limits, IntegerParameter, StringParameter).

limits - paging limits

serviceIds - serviceIds If given, search is targeted only to the services with the listed ids. For supported service types, see CAContentCore.ServiceType.

userIds - If given, the search will return videos owned by the given user (provided that the currently logged in user has the required permissions).

Returns:

See VideoList

searchSimilarById

@HTTPServiceMethod(name="similarVideosById",
                   acceptedMethods="GET")
public Response searchSimilarById(@HTTPAuthenticationParameter(required=false)
                                                                                                                           AuthenticationParameter authenticatedUser,
                                                                                                                           @HTTPMethodParameter(name="uid")
                                                                                                                           StringParameter guid,
                                                                                                                           @HTTPMethodParameter(name="analysis_type",required=false)
                                                                                                                           StringParameter analysisType,
                                                                                                                           @HTTPMethodParameter(name="data_groups",required=false)
                                                                                                                           DataGroups dataGroups,
                                                                                                                           @HTTPMethodParameter(name="limits",required=false)
                                                                                                                           Limits limits,
                                                                                                                           @HTTPMethodParameter(name="service_id",required=false)
                                                                                                                           IntegerParameter serviceIds,
                                                                                                                           @HTTPMethodParameter(name="user_id",required=false)
                                                                                                                           LongParameter userIdFilters)

Search for videos which are similar to the video designated by the given GUID parameter. Non-authenticated users only have access to publicly available content.

Example Query:

GET /rest/vcarc/similarVideosById?uid=1

Example Result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response method="similarVideosById" service="vcarc">
  <mediaList>
    <media>
      <UID>0df3e3e1-6a01-4fe4-b7b7-028d30e9cbda</UID>
      <serviceId>1</serviceId>
      <objectList>
        <object>
          <backendId>662304604</backendId>
          <confidence>0.8431259817431758</confidence>
          <mediaObjectId>3865521640355036220</mediaObjectId>
          <mediaType>PHOTO</mediaType>
          <objectId>DgLdXtqJgYUZOqcQthUBVvKqirdjWWDVQTSbtNLHWdrMopIjpWpeYkTbpsBqyCda</objectId>
          <rank>1494104351</rank>
          <serviceId>1</serviceId>
          <status>USER_REJECTED</status>
          <objectType>KEYWORD</objectType>
          <value>RSLEqWKxwputpsqKvuMpyCUTGGbMVkHopBGGYpizqQriiveBEZTlwGiKFZqLTGwB</value>
          <visibility>PRIVATE</visibility>
          <userId>2010313765910020819</userId>
        </object>
      </objectList>
      <mediaType>VIDEO</mediaType>
      <userId>2010313765910020819</userId>
      <url>http://fe.example.org/rest/vcarc/r?uid=0df3e3e1-6a01-4fe4-b7b7-028d30e9cbda&amp;service_id=1</url>
    </media>
  </mediaList>
  <status>OK</status>
</response>

Parameters:

authenticatedUser -

guid - photo GUID

analysisType - optional list of analysis types to use for the search operation PhotoParameters.AnalysisType

dataGroups - For supported data groups, see ClientService.retrieveMediaObjects(AuthenticationParameter, DataGroups, Limits, IntegerParameter, StringParameter)

limits - paging limits

serviceIds - If given, search is targeted only to the services with the listed ids. For supported service types, see CAContentCore.ServiceType.

userIdFilters - If given, the search will return photos owned by the given user (provided that the currently logged in user has the required permissions).

Returns:

See VideoList