Package org.opencastproject.execute.impl

Class ExecuteServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.execute.impl.ExecuteServiceImpl

All Implemented Interfaces:

ExecuteService, JobProducer, org.osgi.service.cm.ManagedService

public class ExecuteServiceImpl
extends AbstractJobProducer
implements ExecuteService, org.osgi.service.cm.ManagedService

Implements a service that runs CLI commands with MediaPackage elements as arguments

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExecuteServiceImpl.Operation

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<String>	allowedCommands	List of allowed commands that can be run with an executor.
static final String	COMMANDS_ALLOWED_PROPERTY	Bundle property specifying which commands can be run with this executor
static final float	DEFAULT_EXECUTE_JOB_LOAD	The approximate load placed on the system by running an execute operation
static final String	EXECUTE_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_EXECUTE_JOB_LOAD
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
protected SecurityService	securityService	The security service
protected UserDirectoryService	userDirectoryService	The user directory service
protected Workspace	workspace	The workspace service

Fields inherited from class org.opencastproject.job.api.AbstractJobProducer

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

Fields inherited from interface org.opencastproject.execute.api.ExecuteService

COLLECTION, ENDPOINT_NAME, EXEC_FORM_PARAM, INPUT_ELEM_FORM_PARAM, INPUT_FILE_PATTERN, INPUT_MP_FORM_PARAM, JOB_TYPE, LOAD_FORM_PARAM, MP_ID_PATTERN, ORG_ID_PATTERN, OUTPUT_FILE_PATTERN, OUTPUT_NAME_FORM_PARAMETER, PARAMS_FORM_PARAM, TYPE_FORM_PARAMETER

Constructor Summary

Constructors

Constructor	Description
ExecuteServiceImpl()	Creates a new instance of the execute service.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Activates this component with its properties once all of the collaborating services have been set
protected String	doProcess(List<String> arguments, MediaPackageElement element, String outFileName, MediaPackageElement.Type expectedType)	Does the actual processing, given a mediapackage element (Execute Many WOH)
protected String	doProcess(List<String> arguments, MediaPackage mp, String outFileName, MediaPackageElement.Type expectedType)	Does the actual processing, given a mediapackage (Execute Once WOH)
Job	execute(String exec, String params, MediaPackageElement inElement, String outFileName, MediaPackageElement.Type expectedType, float load)	Execute the operation specified by exec with the argument string indicated by args.
Job	execute(String exec, String params, MediaPackage mp, String outFileName, MediaPackageElement.Type expectedType, float load)	Execute the operation specified by exec with the argument string indicated by args.
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected SecurityService	getSecurityService()	Returns a reference to the security service
protected ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
protected UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the receipt service
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
void	setWorkspace(Workspace workspace)	Sets a reference to the workspace service.
void	updated(Dictionary properties)

Methods inherited from class org.opencastproject.job.api.AbstractJobProducer

acceptJob, countJobs, finallyUpdateJob, getJobType, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Field Details

securityService

protected SecurityService securityService

The security service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

workspace

protected Workspace workspace

The workspace service

allowedCommands

protected final Set<String> allowedCommands

List of allowed commands that can be run with an executor. By convention, an empty set doesn't mean any command can be run. An '*' in the service configuration means any command can be executed

COMMANDS_ALLOWED_PROPERTY

public static final String COMMANDS_ALLOWED_PROPERTY

Bundle property specifying which commands can be run with this executor

See Also:

• Constant Field Values

DEFAULT_EXECUTE_JOB_LOAD

public static final float DEFAULT_EXECUTE_JOB_LOAD

The approximate load placed on the system by running an execute operation

See Also:

• Constant Field Values

EXECUTE_JOB_LOAD_KEY

public static final String EXECUTE_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_EXECUTE_JOB_LOAD

See Also:

• Constant Field Values

Constructor Details

ExecuteServiceImpl

public ExecuteServiceImpl()

Creates a new instance of the execute service.

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)

Activates this component with its properties once all of the collaborating services have been set

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - The component's context, containing the properties used for configuration

execute

public Job execute(String exec,
 String params,
 MediaPackageElement inElement,
 String outFileName,
 MediaPackageElement.Type expectedType,
 float load)
            throws ExecuteException,
IllegalArgumentException

Execute the operation specified by exec with the argument string indicated by args. This method may create an output file with the name outFileName and a MediaPackageElement will be created with the MediaPackageElement.Type indicated by the argument type.

Specified by:

execute in interface ExecuteService

Parameters:

exec - The command to be executed by this method

params - A string containing the argument list for this command. The special argument "#{in}" will be substituted by the location of the resource represented by the inElement parameter, and "#{out}" by the file name indicated in outFileName.

inElement - An MediaPackageElement object to be used as an input to the command

outFileName - The name of the file the command may possibly create.

expectedType - The MediaPackageElement.Type of the MediaPackageElement created by this command.

load - A floating point estimate of the load imposed on the node by executing the command

Returns:

A Job representing the execution of the command. After a successful execution, the {link @Job} payload will contain a serialized mediapackage element.

Throws:

IllegalArgumentException - if the input arguments are incorrect

ExecuteException - if an internal error occurs

See Also:

• ExecuteService.execute(java.lang.String, java.lang.String, org.opencastproject.mediapackage.MediaPackageElement, java.lang.String, org.opencastproject.mediapackage.MediaPackageElement.Type, float)

execute

public Job execute(String exec,
 String params,
 MediaPackage mp,
 String outFileName,
 MediaPackageElement.Type expectedType,
 float load)
            throws ExecuteException

Execute the operation specified by exec with the argument string indicated by args. This method accepts a MediaPackage as an argument, and elements within that MediaPackage may be referenced in the argument list by using certain placeholders.

Specified by:

execute in interface ExecuteService

Parameters:

exec - The command to be executed by this method

params - A string containing the argument list for this command. Some special placeholders are allowed, that will be converted into the actual locations of elements in the supplied MediaPackage

mp - The MediaPackage containing MediaPackageElements that will be used as inputs of the command

outFileName - The name of the file the command may possibly create.

expectedType - The MediaPackageElement.Type of the MediaPackageElement created by this command.

load - A floating point estimate of the load imposed on the node by executing the command

Returns:

A Job representing the execution of the command. After a successful execution, the {link @Job} payload will contain a serialized mediapackage element.

Throws:

ExecuteException - if this method fails to create the Job correctly

See Also:

• ExecuteService.execute(java.lang.String, java.lang.String, org.opencastproject.mediapackage.MediaPackage, java.lang.String, org.opencastproject.mediapackage.MediaPackageElement.Type, float)

process

protected String process(Job job)
                  throws ExecuteException

Asks the overriding class to process the arguments using the given operation. The result will be added to the associated job as the payload.

Specified by:

process in class AbstractJobProducer

Parameters:

job - the job to process

Returns:

the operation result

Throws:

ExecuteException

See Also:

• AbstractJobProducer.process(org.opencastproject.job.api.Job)

doProcess

protected String doProcess(List<String> arguments,
 MediaPackage mp,
 String outFileName,
 MediaPackageElement.Type expectedType)
                    throws ExecuteException

Does the actual processing, given a mediapackage (Execute Once WOH)

Parameters:

arguments - The list containing the program and its arguments

mp - MediaPackage used in the operation

outFileName - The name of the resulting file

expectedType - The expected element type

Returns:

A String containing the command output

Throws:

ExecuteException - if some internal error occurred

doProcess

protected String doProcess(List<String> arguments,
 MediaPackageElement element,
 String outFileName,
 MediaPackageElement.Type expectedType)
                    throws ExecuteException

Does the actual processing, given a mediapackage element (Execute Many WOH)

Parameters:

arguments - The list containing the program and its arguments

outFileName - The name of the resulting file

expectedType - The expected element type

Returns:

A String containing the command output

Throws:

ExecuteException - if some internal error occurred

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the receipt service

Parameters:

serviceRegistry - the service registry

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

See Also:

• AbstractJobProducer.getServiceRegistry()

getSecurityService

protected SecurityService getSecurityService()

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

See Also:

• AbstractJobProducer.getSecurityService()

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Callback for setting the user directory service.

Parameters:

userDirectoryService - the userDirectoryService to set

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

See Also:

• AbstractJobProducer.getUserDirectoryService()

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

See Also:

• AbstractJobProducer.getOrganizationDirectoryService()

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

setWorkspace

public void setWorkspace(Workspace workspace)

Sets a reference to the workspace service.

Parameters:

workspace -

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException