Package org.opencastproject.execute.remote

Class ExecuteServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.execute.remote.ExecuteServiceRemoteImpl

All Implemented Interfaces:

ExecuteService

public class ExecuteServiceRemoteImpl
extends RemoteBase
implements ExecuteService

Remote implementation of the execute service

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.serviceregistry.api.RemoteBase

RemoteBase.HttpClientClosingInputStream

Field Summary

Fields inherited from class org.opencastproject.serviceregistry.api.RemoteBase

client, elementsFromHttpResponse, remoteServiceManager, serviceType

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
ExecuteServiceRemoteImpl()	Constructs a new execute service proxy

Method Summary

Modifier and Type	Method	Description
Job	execute(String exec, String params, MediaPackageElement inElement, String outFileName, MediaPackageElement.Type type, 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 type, float load)	Execute the operation specified by exec with the argument string indicated by args.
void	setRemoteServiceManager(ServiceRegistry serviceRegistry)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient trustedHttpClient)	Sets the trusted http client

Methods inherited from class org.opencastproject.serviceregistry.api.RemoteBase

closeConnection, getResponse, getResponse, runRequest

Methods inherited from class java.lang.Object

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

Constructor Details

ExecuteServiceRemoteImpl

public ExecuteServiceRemoteImpl()

Constructs a new execute service proxy

Method Details

execute

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

Description copied from interface: ExecuteService

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.

type - 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.MediaPackageElement, java.lang.String, org.opencastproject.mediapackage.MediaPackageElement.Type, float)

execute

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

Description copied from interface: ExecuteService

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.

type - 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)

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient trustedHttpClient)

Description copied from class: RemoteBase

Sets the trusted http client

Overrides:

setTrustedHttpClient in class RemoteBase

Parameters:

trustedHttpClient -

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry serviceRegistry)

Description copied from class: RemoteBase

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class RemoteBase

Parameters:

serviceRegistry -