org.apache.camel.component.fop

Class FopEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.fop.FopEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.10.0",
             scheme="fop",
             title="FOP",
             syntax="fop:outputType",
             producerOnly=true,
             label="transformation")
public class FopEndpoint
extends org.apache.camel.impl.DefaultEndpoint

The fop component allows you to render a message into different output formats using Apache FOP.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
FopEndpoint(String uri, FopComponent component, FopOutputType outputType)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
protected void	doStart()
org.apache.fop.apps.FopFactory	getFopFactory()
FopOutputType	getOutputType()
String	getUserConfigURL()
boolean	isSingleton()
void	setFopFactory(org.apache.fop.apps.FopFactory fopFactory) Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory.
void	setOutputType(FopOutputType outputType) The primary output format is PDF but other output formats are also supported.
void	setUserConfigURL(String userConfigURL) The location of a configuration file which can be loaded from classpath or file system.

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

FopEndpoint

public FopEndpoint(String uri,
                   FopComponent component,
                   FopOutputType outputType)

Method Detail

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

getOutputType

public FopOutputType getOutputType()

setOutputType

public void setOutputType(FopOutputType outputType)

The primary output format is PDF but other output formats are also supported.

getUserConfigURL

public String getUserConfigURL()

setUserConfigURL

public void setUserConfigURL(String userConfigURL)

The location of a configuration file which can be loaded from classpath or file system.

getFopFactory

public org.apache.fop.apps.FopFactory getFopFactory()

setFopFactory

public void setFopFactory(org.apache.fop.apps.FopFactory fopFactory)

Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory.

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception