net.sf.jkniv.camel.sap.jco3

Class SapJcoEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

net.sf.jkniv.camel.sap.jco3.SapJcoEndpoint

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(scheme="jkniv-jco",
             title="jkniv-jco",
             syntax="jkniv-jco:name",
             label="jkniv-jco")
public class SapJcoEndpoint
extends org.apache.camel.impl.DefaultEndpoint

Represents a sap jco endpoint.

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
SapJcoEndpoint()
SapJcoEndpoint(java.lang.String endpointUri)
SapJcoEndpoint(java.lang.String uri, SapJcoComponent component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
<T> java.lang.Class<T>	getClassToParserResultStrategy()
java.lang.String	getName()
java.lang.String	getParserResultStrategy() Class name from implementation of ParserResult
java.lang.String	getPrefixParams() The prefix name of parameters.
java.util.Properties	getPropSapConnection()
java.lang.String	getSapDestName() The name of SAP JCoDestination name that identifies a physical destination of a function call.
java.lang.String	getSapFunction() The name of SAP JCoFunction
java.lang.String	getSapJcoTable() The name of SAP JCoTable that encapsulates a database table
java.lang.String	getSapJcoTableIn() The name of SAP JCoTable that encapsulates a input of table parameters
boolean	isSingleton()
boolean	isSupportsNull() When supportsNull is true the list of result could be null values.
boolean	isUseHeaderAsParam() Parameters of JCo.
void	setName(java.lang.String name) Some description of this option, and what it does
void	setParserResultStrategy(java.lang.String parserResultStrategy) Define the class name that implements ParserResult
void	setPrefixParams(java.lang.String prefixParams) Define prefix name for JCo parameters.
void	setPropSapConnection(java.util.Properties propSapConnection)
void	setSapDestName(java.lang.String sapDestName) Set the name of SAP JCoDestination name that identifies a physical destination of a function call
void	setSapFunction(java.lang.String sapFunction) Define the name of SAP JCoFunction
void	setSapJcoTable(java.lang.String sapJcoTable) The name of SAP JCoTable
void	setSapJcoTableIn(java.lang.String sapJcoTableIn) The name of SAP JCoTable
void	setSupportsNull(boolean supportsNull) set true to support null values at result list.
void	setUseHeaderAsParam(boolean useHeaderAsParam) Define if JCo parameters are in header message.

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, 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

SapJcoEndpoint

public SapJcoEndpoint()

SapJcoEndpoint

public SapJcoEndpoint(java.lang.String uri,
                      SapJcoComponent component)

SapJcoEndpoint

public SapJcoEndpoint(java.lang.String endpointUri)

Method Detail

createProducer

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

Throws:

java.lang.Exception

createConsumer

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

Throws:

java.lang.Exception

isSingleton

public boolean isSingleton()

setName

public void setName(java.lang.String name)

Some description of this option, and what it does

Parameters:

name - endpoint

getName

public java.lang.String getName()

getSapFunction

public java.lang.String getSapFunction()

The name of SAP JCoFunction

Returns:

the name of function

See Also:

JCoFunction

setSapFunction

public void setSapFunction(java.lang.String sapFunction)

Define the name of SAP JCoFunction

Parameters:

sapFunction - name of SAP function

getSapDestName

public java.lang.String getSapDestName()

The name of SAP JCoDestination name that identifies a physical destination of a function call. It contains all required properties in order to connect to an SAP system.

Returns:

the name of JCoDestination

See Also:

JCoDestination

setSapDestName

public void setSapDestName(java.lang.String sapDestName)

Set the name of SAP JCoDestination name that identifies a physical destination of a function call

Parameters:

sapDestName - the name of JCoDestination

getSapJcoTable

public java.lang.String getSapJcoTable()

The name of SAP JCoTable that encapsulates a database table

Returns:

the name of SAP JCoTable .

See Also:

JCoTable

setSapJcoTable

public void setSapJcoTable(java.lang.String sapJcoTable)

The name of SAP JCoTable

Parameters:

sapJcoTable - name of SAP JCoTable

getSapJcoTableIn

public java.lang.String getSapJcoTableIn()

The name of SAP JCoTable that encapsulates a input of table parameters

Returns:

the name of SAP JCoTable .

See Also:

JCoTable

setSapJcoTableIn

public void setSapJcoTableIn(java.lang.String sapJcoTableIn)

The name of SAP JCoTable

Parameters:

sapJcoTableIn - name of SAP JCoTable

getPrefixParams

public java.lang.String getPrefixParams()

The prefix name of parameters. Default is SAPJco_

Returns:

prefix name of JCo parameters

setPrefixParams

public void setPrefixParams(java.lang.String prefixParams)

Define prefix name for JCo parameters. Default is SAPJco_

Parameters:

prefixParams - name of prefix

isUseHeaderAsParam

public boolean isUseHeaderAsParam()

Parameters of JCo.

Returns:

true if parameters from JCo come from header message, false otherwise.

setUseHeaderAsParam

public void setUseHeaderAsParam(boolean useHeaderAsParam)

Define if JCo parameters are in header message.

Parameters:

useHeaderAsParam - parameters from JCo come from header message

isSupportsNull

public boolean isSupportsNull()

When supportsNull is true the list of result could be null values.

Returns:

false if result of JCo function supports null values, true otherwise.

setSupportsNull

public void setSupportsNull(boolean supportsNull)

set true to support null values at result list.

Parameters:

supportsNull - indicate if result list could be contains null values.

getParserResultStrategy

public java.lang.String getParserResultStrategy()

Class name from implementation of ParserResult

Returns:

the name of concrete class that implements ParserResult

getClassToParserResultStrategy

public <T> java.lang.Class<T> getClassToParserResultStrategy()

setParserResultStrategy

public void setParserResultStrategy(java.lang.String parserResultStrategy)

Define the class name that implements ParserResult

Parameters:

parserResultStrategy - class name to parse result

Throws:

org.apache.camel.RuntimeCamelException - when net.sf.jkniv.camel.sap.jco3.ParserResult implementation cannot be found

setPropSapConnection

public void setPropSapConnection(java.util.Properties propSapConnection)

getPropSapConnection

public java.util.Properties getPropSapConnection()