org.apache.camel.component.scp

Class ScpComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.component.file.GenericFileComponent<T>

org.apache.camel.component.file.remote.RemoteFileComponent<ScpFile>

org.apache.camel.component.scp.ScpComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

public class ScpComponent
extends RemoteFileComponent<ScpFile>

Component providing secure messaging using JSch

Field Summary

Fields inherited from class org.apache.camel.component.file.remote.RemoteFileComponent

REMOTE_FILE_INPUT_STREAM

Fields inherited from class org.apache.camel.component.file.GenericFileComponent

log

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

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

Constructor Summary

Constructors

Constructor and Description
ScpComponent()
ScpComponent(CamelContext context)

Method Summary

Modifier and Type	Method and Description
protected void	afterPropertiesSet(GenericFileEndpoint<ScpFile> endpoint) A factory method for derived file components to perform validation of properties
protected GenericFileEndpoint<ScpFile>	buildFileEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method for derived file components to create the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
protected void	initJsch()
boolean	isVerboseLogging()
void	setVerboseLogging(boolean verboseLogging) JSCH is verbose logging out of the box.

Methods inherited from class org.apache.camel.component.file.GenericFileComponent

createEndpoint

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

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

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

afterConfiguration, createConfiguration, createEndpoint, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, preProcessUri, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScpComponent

public ScpComponent()

ScpComponent

public ScpComponent(CamelContext context)

Method Detail

buildFileEndpoint

protected GenericFileEndpoint<ScpFile> buildFileEndpoint(String uri,
                                                         String remaining,
                                                         Map<String,Object> parameters)
                                                  throws Exception

Description copied from class: GenericFileComponent

A factory method for derived file components to create the endpoint

Specified by:

buildFileEndpoint in class GenericFileComponent<ScpFile>

Parameters:

uri - the full URI of the endpoint

remaining - the remaining part of the URI without the query parameters or component prefix

parameters - the optional parameters passed in

Returns:

a newly created endpoint or null if the endpoint cannot be created based on the inputs

Throws:

Exception - can be thrown

afterPropertiesSet

protected void afterPropertiesSet(GenericFileEndpoint<ScpFile> endpoint)
                           throws Exception

Description copied from class: GenericFileComponent

A factory method for derived file components to perform validation of properties

Specified by:

afterPropertiesSet in class GenericFileComponent<ScpFile>

Parameters:

endpoint - the endpoint

Throws:

Exception - can be thrown in case of validation errors

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStart()

isVerboseLogging

public boolean isVerboseLogging()

setVerboseLogging

public void setVerboseLogging(boolean verboseLogging)

JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again.

initJsch

protected void initJsch()