vodserver.service

Class CommandRunnerService

java.lang.Object

vodserver.util.BaseBeanNameAware

vodserver.service.AbstractService

vodserver.service.AbstractParamBuilderService

vodserver.service.CommandRunnerService

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, Service

public class CommandRunnerService
extends AbstractParamBuilderService

This service will execute the configured list of ParamBuilders, then execute the command as specified by the command property. The command output will be piped to the HTTP response, with the content type as specified by the contentTypeParam parameter. The command can contain expressions; see ExpressionUtil for more details. Usually this service is configured using Spring with a bean definition like this:

<bean id="/someService" class="vodserver.service.StandardService">
        <property name="paramBuilders">
                <list>
                        <bean class="vodserver.parambuilder.StaticParamBuilder>
                                <property name="staticParams>
                                        <map>
                                                <entry key="someCommandParam" value="someParamValue"/>
                                        </map>
                                </property>
                        </bean>
                </list>
        </property>
        <property name="command" value="someCommand -a !!someCommandParam!! -b abc" />
</bean>

This example definition will execute 'someCommand -a someParamValue -b abc' whenever http://vodeserver:port/someService is called.

Author:

Ruud Senden

Field Summary

Fields inherited from class vodserver.service.AbstractParamBuilderService

paramBuilders

Fields inherited from class vodserver.service.AbstractService

LOG

Constructor Summary

Constructors

Constructor and Description
CommandRunnerService()

Method Summary

Methods

Modifier and Type	Method and Description
String	getCommand() Get the configured command (expressions will not yet have been evaluated).
String	getContentTypeParam() Get the configured content type parameter.
void	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle the service request.
void	setCommand(String command) Set the command to execute.
void	setContentTypeParam(String contentTypeParam) Set the content type parameter name, used to look up the parameter containing the content type to use for the HTTP response.
String	toString() Provide a string representation of the configuration of this service.

Methods inherited from class vodserver.service.AbstractParamBuilderService

appendParamBuilderInfo, buildParams, extraAfterPropertiesSet, extraExtraAfterPropertiesSet, getParamBuilders, setParamBuilders

Methods inherited from class vodserver.service.AbstractService

afterPropertiesSet

Methods inherited from class vodserver.util.BaseBeanNameAware

getBeanName, setBeanName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

Constructor Detail

CommandRunnerService

public CommandRunnerService()

Method Detail

handle

public void handle(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   javax.servlet.ServletException

Handle the service request. This will execute the configured ParamBuilders, evaluate any expressions specified in the command property, and then execute the command.

Throws:

IOException

javax.servlet.ServletException

getCommand

public String getCommand()

Get the configured command (expressions will not yet have been evaluated).

Returns:

setCommand

public void setCommand(String command)

Set the command to execute. The command can contain expressions as described in ExpressionUtil, which will be evaluated before the command is executed.

Parameters:

command -

getContentTypeParam

public String getContentTypeParam()

Get the configured content type parameter.

Returns:

setContentTypeParam

public void setContentTypeParam(String contentTypeParam)

Set the content type parameter name, used to look up the parameter containing the content type to use for the HTTP response.

Parameters:

contentTypeParam -

toString

public String toString()

Provide a string representation of the configuration of this service.

Overrides:

toString in class Object