com.tle.core.harvester.soap
Interface SoapHarvesterService
Declaration: public interface SoapHarvesterService

 

 

Methods Summary
abstract java.lang.String getDynamicCollections()
    
Returns a list of all dynamic collections that the currently logged in user can search.
abstract java.lang.String getItemXml(java.lang.String itemUuid, int version)
    
Gets the item xml for the supplied item.
If the item has a DRM acceptance, the logged in use must have accepted it or the "Skip DRM for harvesters" setting must be set.
abstract java.lang.String getSearchableCollections()
    
Returns a list of all collections that the currently logged in user can search.
abstract java.lang.String login(java.lang.String username, java.lang.String password)
    
Login with the given username and password.
abstract java.lang.String loginWithToken(java.lang.String token)
    
Login with the given token.
abstract void logout()
    
Logout the current user.
abstract java.lang.String prepareDownload(java.lang.String itemUuid, int version)
    
Zips up an item for downloading later by the returned URL.
abstract java.lang.String searchDynamicCollection(java.lang.String dynaCollection, java.lang.String virtualisationValue, java.lang.String since, boolean liveOnly)
    
Searches a dynamic collection for all the items modified since the supplied date.
abstract java.lang.String searchItemsSince(java.lang.String[] collectionUuids, boolean onlyLive, java.lang.String since)
    
Searches a collection for all the items modified since the supplied date.

 

 

 

 

login

 

public abstract java.lang.String login( java.lang.String username,
java.lang.String password)
throws java.lang.Exception

 

Login with the given username and password.

Note that the response sent back by this method will include a new cookie. Your client MUST have cookies enabled.

 

Parameters:
username-
The username
password-
The password
Returns:
The user XML. See the section on XML Formats in SOAP Services
Throws:
An - exception is thrown if login fails for any reason (e.g. invalid credentials)

 

 

 

loginWithToken

 

public abstract java.lang.String loginWithToken( java.lang.String token)
throws java.lang.Exception

 

Login with the given token. The token format is described in the "LMS Integration Specification" document.

Note that the response sent back by this method will include a new cookie. Your client MUST have cookies enabled.

 

Parameters:
token-
Token string
Returns:
The user XML. See the section on XML Formats in SOAP Services
Throws:
An - exception is thrown if login fails for any reason (e.g. invalid credentials)

 

 

 

logout

 

public abstract void logout( )

 

Logout the current user.

 

Parameters:
token-
The current session id (Important: please see documentation on com.tle.core.remoting.SoapInterfaceV1 sessions)

 

 

 

searchItemsSince

 

public abstract java.lang.String searchItemsSince( java.lang.String[] collectionUuids,
boolean onlyLive,
java.lang.String since)

 

Searches a collection for all the items modified since the supplied date.

 

Parameters:
collectionUuids-
An array of collections uuids to search
onlyLive-
Search only live items
since-
The date to search from in the format of "yyyy-MM-dd'T'HH:mm:ssZ"
Returns:
XML of the search results in the form of:
 <results count="number of returned results">
    <available>number of total results obtainable</available>
    <result>
       Item XML      
    </result>
    ...
 </results>
 
See the section on XML Formats in SOAP Services for the format of the returned Item XML.

 

 

 

getSearchableCollections

 

public abstract java.lang.String getSearchableCollections( )
throws java.lang.Exception

 

Returns a list of all collections that the currently logged in user can search.
 <xml>
   Collection XML
   ... 
 </xml>
 
See the section on XML Formats in SOAP Services for the format of the returned Collection XML.

 

 

 

getDynamicCollections

 

public abstract java.lang.String getDynamicCollections( )
throws java.lang.Exception

 

Returns a list of all dynamic collections that the currently logged in user can search.
 <xml>
   <dyncol>
     <id></id>
     <uuid></uuid>
     <name></name>
     <system></system>
     <virtval></virtval>
   </dyncol>
 </xml>
 

 

 

 

searchDynamicCollection

 

public abstract java.lang.String searchDynamicCollection( java.lang.String dynaCollection,
java.lang.String virtualisationValue,
java.lang.String since,
boolean liveOnly)

 

Searches a dynamic collection for all the items modified since the supplied date.

 

Parameters:
dynaCollection-
The dynamic collection id
virtualisationValue-
The virtualisation value if there is one
since-
The date to search from in the format of "yyyy-MM-dd'T'HH:mm:ssZ"
onlyLive-
Search only live items
Returns:
XML of the search results in the form of:
 <results count="number of returned results">
    <available>number of total results obtainable</available>
    <result>
       Item XML      
    </result>
    ...
 </results>
 
See the section on XML Formats in SOAP Services for the format of the returned Item XML.

 

 

 

getItemXml

 

public abstract java.lang.String getItemXml( java.lang.String itemUuid,
int version)
throws java.lang.Exception

 

Gets the item xml for the supplied item.
If the item has a DRM acceptance, the logged in use must have accepted it or the "Skip DRM for harvesters" setting must be set.

 

Parameters:
itemUuid-
The item uuid
version-
The item version
Returns:
The xml for the item

 

 

 

prepareDownload

 

public abstract java.lang.String prepareDownload( java.lang.String itemUuid,
int version)
throws java.lang.Exception

 

Zips up an item for downloading later by the returned URL. If the item has a DRM acceptance, the logged in use must have accepted it or the "Skip DRM for harvesters" setting must be set.

 

Parameters:
itemUuid-
The item id
version-
The item version
Returns:
A URL to a .tar.gz download over standard HTTP.