This project has retired. For details please refer to its Attic page.

org.apache.cocoon.components.cron
Class CocoonPipelineCronJob

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.cron.ServiceableCronJob
          org.apache.cocoon.components.cron.CocoonPipelineCronJob

All Implemented Interfaces:

Configurable, LogEnabled, Serviceable, ConfigurableCronJob, CronJob

public class CocoonPipelineCronJob
extends ServiceableCronJob
implements Configurable, ConfigurableCronJob

A simple CronJob which calls an internal cocoon:// pipeline. You must provide it with a <pipeline>pipeline/to/call</pipeline> parameter in cocoon.xconf Your supplied pipeline String will have "cocoon://" prepended to it. If you set info log enabled, this will write the output of the pipeline to the cron log

Since:

2.1.5

Version:

$Id: CocoonPipelineCronJob.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Giacomo Pati, Reinhard Poetz, Jeremy Quinn

Field Summary

static String

PIPELINE_PARAM

Fields inherited from class org.apache.cocoon.components.cron.ServiceableCronJob

manager

Fields inherited from interface org.apache.cocoon.components.cron.CronJob

ROLE

Constructor Summary

CocoonPipelineCronJob()

Method Summary

void	configure(Configuration config)
void	execute(String name) This methods get called to allow an implementing class to do its supposed job
void	setup(Parameters params, Map objects) Setup CronJob with additional information first

Methods inherited from class org.apache.cocoon.components.cron.ServiceableCronJob

service

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

PIPELINE_PARAM

public static final String PIPELINE_PARAM

See Also:

Constant Field Values

Constructor Detail

CocoonPipelineCronJob

public CocoonPipelineCronJob()

Method Detail

execute

public void execute(String name)

Description copied from interface: CronJob

This methods get called to allow an implementing class to do its supposed job

Specified by:

execute in interface CronJob

Parameters:

name - the name given to this job

configure

public void configure(Configuration config)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

setup

public void setup(Parameters params,
                  Map objects)

Description copied from interface: ConfigurableCronJob

Setup CronJob with additional information first

Specified by:

setup in interface ConfigurableCronJob

Parameters:

params - Any Parameters

objects - Some additional Objects