service.tut.pori.contentanalysis

Class CAContentCore

java.lang.Object

service.tut.pori.contentanalysis.CAContentCore

public final class CAContentCore
extends java.lang.Object

This class includes functions for general content operations, such as updating the keywords, modifying photo details, and uploading new content Note: this does not have UserEventListener for user removal, this is because currently all content is managed by ContentStorage service, which will call all the necessary method for removing photo content (when needed)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CAContentCore.ServiceType Service type declarations.
static class	CAContentCore.Visibility The visibility.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<AnalysisBackend.Capability>	DEFAULT_CAPABILITIES default capabilities for photo tasks

Method Summary

Modifier and Type	Method and Description
static boolean	deletePhotos(UserIdentity authenticatedUser, java.util.List<java.lang.String> guids) Delete the given photos.
static java.lang.String	generateRedirectUrl(java.lang.String guid, CAContentCore.ServiceType type)
static RedirectResponse	generateTargetUrl(UserIdentity authenticatedUser, CAContentCore.ServiceType serviceType, java.lang.String guid) resolves dynamic /rest/r? redirection URL to static access URL
static MediaObjectList	getMediaObjects(UserIdentity authenticatedUser, DataGroups dataGroups, Limits limits, java.util.EnumSet<MediaUrlValidator.MediaType> mediaTypes, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, java.util.List<java.lang.String> mediaObjectIdFilters)
static PhotoList	getPhotos(UserIdentity authenticatedUser, java.util.List<java.lang.String> guids, DataGroups dataGroups, Limits limits, java.util.EnumSet<CAContentCore.ServiceType> serviceTypes, long[] userIdFilters)
static AbstractTaskDetails	queryTaskDetails(java.lang.Integer backendId, java.lang.Long taskId, DataGroups dataGroups, Limits limits) This method is called by back-ends to retrieve a list of photos to be analyzed.
static boolean	schedule(org.quartz.JobBuilder builder) Uses the platform defined scheduler to schedule the given builder.
static void	scheduleBackendFeedback(java.lang.Integer backendId, PhotoList photos, java.lang.Long taskId) Create and schedule the task for all capable back-ends included in the task designated by the task Id.
static boolean	scheduleTask(org.quartz.JobBuilder builder, java.lang.Long taskId)
static java.lang.Long	scheduleTask(PhotoTaskDetails details) Note: if the details already contain a taskId, the task will NOT be re-added to the database, but simply re-scheduled.
static void	similarityFeedback(UserIdentity authenticatedUser, PhotoFeedbackList feedbackList) This will allow some amount of bad GUIDs to exist as long as there are enough to make a proper request: at least one ref photo must exist, at least one similar or dissimilar photo must exist.
static void	taskFinished(PhotoTaskResponse response)
static void	updatePhotos(UserIdentity authenticatedUser, PhotoList photoList) This does NOT sync the changes back to content storage (e.g.
static void	validateTaskResponse(TaskResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CAPABILITIES

public static final java.util.EnumSet<AnalysisBackend.Capability> DEFAULT_CAPABILITIES

default capabilities for photo tasks

Method Detail

taskFinished

public static void taskFinished(PhotoTaskResponse response)
                         throws java.lang.IllegalArgumentException

Parameters:

response -

Throws:

java.lang.IllegalArgumentException

validateTaskResponse

public static void validateTaskResponse(TaskResponse response)
                                 throws java.lang.IllegalArgumentException

Parameters:

response -

Throws:

java.lang.IllegalArgumentException - on null response, bad task id, bad backend id and/or bad task type

generateRedirectUrl

public static java.lang.String generateRedirectUrl(java.lang.String guid,
                                                   CAContentCore.ServiceType type)

Parameters:

guid -

type -

Returns:

redirection URL for the given GUID and type or null if either one the given values was null

generateTargetUrl

public static RedirectResponse generateTargetUrl(UserIdentity authenticatedUser,
                                                 CAContentCore.ServiceType serviceType,
                                                 java.lang.String guid)

resolves dynamic /rest/r? redirection URL to static access URL

Parameters:

authenticatedUser -

serviceType -

guid -

Returns:

redirection to static URL referenced by the given parameters

queryTaskDetails

public static AbstractTaskDetails queryTaskDetails(java.lang.Integer backendId,
                                                   java.lang.Long taskId,
                                                   DataGroups dataGroups,
                                                   Limits limits)

This method is called by back-ends to retrieve a list of photos to be analyzed. To query tasks status from back-end use queryTaskStatus.

Parameters:

backendId -

taskId -

dataGroups -

limits -

Returns:

the task or null if not found

scheduleTask

public static java.lang.Long scheduleTask(PhotoTaskDetails details)

Note: if the details already contain a taskId, the task will NOT be re-added to the database, but simply re-scheduled. If the details contains no back-ends, default back-ends will be added. See DEFAULT_CAPABILITIES

Parameters:

details -

Returns:

task id of the generated task, null if task could not be created

scheduleTask

public static boolean scheduleTask(org.quartz.JobBuilder builder,
                                   java.lang.Long taskId)
                            throws java.lang.IllegalArgumentException

Parameters:

builder -

taskId -

Returns:

true if the task was successfully scheduled

Throws:

java.lang.IllegalArgumentException - on bad values

See Also:

schedule(JobBuilder)

schedule

public static boolean schedule(org.quartz.JobBuilder builder)
                        throws java.lang.IllegalArgumentException

Uses the platform defined scheduler to schedule the given builder. This may add a scheduling delay depending on the system property configuration. Note that the task may not necessarily start immediately, but may be delayed because of other tasks already added into the queue.

Parameters:

builder -

Returns:

true if the job was successfully scheduled

Throws:

java.lang.IllegalArgumentException - on bad parameters

getPhotos

public static PhotoList getPhotos(UserIdentity authenticatedUser,
                                  java.util.List<java.lang.String> guids,
                                  DataGroups dataGroups,
                                  Limits limits,
                                  java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                  long[] userIdFilters)

Parameters:

authenticatedUser -

guids -

dataGroups -

limits -

serviceTypes -

userIdFilters -

Returns:

list of photos or null if none was found with the given parameters

updatePhotos

public static void updatePhotos(UserIdentity authenticatedUser,
                                PhotoList photoList)
                         throws java.lang.IllegalArgumentException

This does NOT sync the changes back to content storage (e.g. picasa) to prevent conflicts in future synchronizations

Parameters:

authenticatedUser -

photoList -

Throws:

java.lang.IllegalArgumentException

similarityFeedback

public static void similarityFeedback(UserIdentity authenticatedUser,
                                      PhotoFeedbackList feedbackList)

This will allow some amount of bad GUIDs to exist as long as there are enough to make a proper request: at least one ref photo must exist, at least one similar or dissimilar photo must exist. The GUIDs must be unique, the same GUID may not appear in similar, dissimilar and ref list.

Parameters:

authenticatedUser - must be given

feedbackList -

getMediaObjects

public static MediaObjectList getMediaObjects(UserIdentity authenticatedUser,
                                              DataGroups dataGroups,
                                              Limits limits,
                                              java.util.EnumSet<MediaUrlValidator.MediaType> mediaTypes,
                                              java.util.EnumSet<CAContentCore.ServiceType> serviceTypes,
                                              java.util.List<java.lang.String> mediaObjectIdFilters)

Parameters:

authenticatedUser -

dataGroups -

limits -

mediaTypes - optional media types for the retrieval, if null or empty, all types will be searched for

serviceTypes -

mediaObjectIdFilters -

Returns:

list of media objects or null if none was found with the given parameters

deletePhotos

public static boolean deletePhotos(UserIdentity authenticatedUser,
                                   java.util.List<java.lang.String> guids)
                            throws java.lang.IllegalArgumentException

Delete the given photos. Normal user (ROLE_USER) can only delete his/her own photos. Back-end user (ROLE_BACKEND) can delete any photos.

Parameters:

authenticatedUser -

guids - list of guids. Non-existent guids will be ignored.

Returns:

true on success, false on failure. Failure generally means a permission problem.

Throws:

java.lang.IllegalArgumentException - on bad user id

scheduleBackendFeedback

public static void scheduleBackendFeedback(java.lang.Integer backendId,
                                           PhotoList photos,
                                           java.lang.Long taskId)

Create and schedule the task for all capable back-ends included in the task designated by the task Id. The given back-end Id will not participate in the feedback task.

Parameters:

backendId - the back-end that send the task finished call, this back-end is automatically omitted from the list of target back-ends

photos - photos returned in task finished call

taskId - the id of the finished analysis task