Package vodserver.service

This package contains service implementations.

See: Description

Interface Summary

Interface	Description
Service	This interface describes the contract for service implementations.

Class Summary

Class	Description
AbstractParamBuilderService	This abstract service provides support for defining a ParamBuilder list.
AbstractService	This is the abstract base class for VODServer services.
CommandRunnerService	This service will execute the configured list of ParamBuilders, then execute the command as specified by the CommandRunnerService.command property.
MappingForwardingService	This forwarding service will forward requests to another service, by mapping a request parameter value to a forward url.
ParamBuilderForwardingService	This forwarding service will execute the configured list of ParamBuilders, then forward to the value of the ParamBuilderForwardingService.forwardParam parameter.
ShutdownService	This service will shut down VODServer.
StaticForwardingService	This forwarding service will simply forward to the service defined by the forward property.

Package vodserver.service Description

This package contains service implementations. Services are called by VODServer based on the request URI, and basically define how the request will be handled. The following service implementations are currently available:

• CommandRunnerService
  This service implementation can run arbitrary commands, optionally based on the output of a set of ParamBuilders. Usually the configured command will retrieve and transcode a (remote) video stream. The configured command can contain expressions (see ExpressionUtil) that will be evaluated before running the command. This allows the configured command to reference the set of parameters build by the ParamBuilders.
• MappingForwardingService
  This service implementation basically allows you to define aliases to other services, including service parameters. Its main use is to define a static channel mapping. This allows clients to invoke simple URL's like http://vodserver:port/channel?id=MyChannel. ForwardingService will look up and invoke the configured forward URI for 'MyChannel', for example /myService?url=http://myservice/page/containing/video. This is the recommended approach for accessing services for the following reasons:
  • Clients can use a simple URL; they don't need to know which service to use for a specific channel and what request parameters to use.
  • Channels are administered in a central place; if for example you want to use a different service or different service parameters to view a specific channel, this only needs to be updated in the VODServer configuration.
• ParamBuilderForwardingService
  Configured with a set of ParamBuilders and the forward parameter name, this service implementation will build a set of parameters by executing the ParamBuilders, then looks up the parameter as specified by the forwardParam parameter, and uses the value of that parameter as the forward URI.
• StaticForwardingService
  This is the most simple forwarding service implementation; it is configured with a static forward URI. Whenever this service is called, it will simply forward to the configured forward URI.

Apart from the concrete service implementations, this package contains some other classes and interfaces:

• Service
  This interface specifies the method(s) that service implementations are required to implement.
• vodserver.service.AbstractService
  This is an abstract base class for service implementations. Its main function is to log the service configuration on startup.
• {@link vodserver.service.AbstractParamBuilderService}
  This is an abstract base class for service implementations that can be configured with a set of {@link vodserver.parambuilder.ParamBuilder}s. It provides functionality for configuring the set of {@link vodserver.parambuilder.ParamBuilder}s, sorting them based on their order, and retrieving a String representation of their configuration.