org.jitterbit.connector.sdk

Class BaseJitterbitConnector

java.lang.Object

org.jitterbit.connector.sdk.BaseJitterbitConnector

All Implemented Interfaces:

JitterbitConnector

public abstract class BaseJitterbitConnector
extends Object
implements JitterbitConnector

Provides the base implementation of common methods that a Jitterbit Connector must implement.

A connector should extend this class as it provides the base implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jitterbit.connector.sdk.JitterbitConnector

JitterbitConnector.ConnectorContext, JitterbitConnector.Factory, JitterbitConnector.TestQueryContext<T>, JitterbitConnector.TestQueryResult

Field Summary

Fields inherited from interface org.jitterbit.connector.sdk.JitterbitConnector

CONNECTOR_CONTEXT, EXECUTION_CONTEXT

Constructor Summary

Constructors

Constructor and Description
BaseJitterbitConnector()

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getCombinedParams(Map<String,String> params) Convenience method to combine the protected parameters and non-protected parameters / properties.
Map<? extends String,? extends String>	getProtectedParams() This returns connector parameters that shouldn't be accessible or modifiable by user who is using the connector.
List<ProviderLibrary>	getProviders() Returns an empty list of provider library objects.
void	onInit() Upon successful connector initialization, logs a message announcing the initialization with the connector name.
void	setProtectedParams(Map<? extends String,? extends String> params) Set protected paramaters that shouldn't be modifiable or accessible by user who is using the connector.
void	testConnection(Map<String,String> props) Uses the specified properties to test a connection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jitterbit.connector.sdk.JitterbitConnector

getConnectionFactory, getObjectMetadata, testQuery

Constructor Detail

BaseJitterbitConnector

public BaseJitterbitConnector()

Method Detail

testConnection

public void testConnection(Map<String,String> props)
                    throws Connection.ConnectionException

Uses the specified properties to test a connection.

Specified by:

testConnection in interface JitterbitConnector

Parameters:

props - a map with the properties required to test the connection

Throws:

Connection.ConnectionException - if an error happens during the test

getProviders

public List<ProviderLibrary> getProviders()

Returns an empty list of provider library objects.

Specified by:

getProviders in interface JitterbitConnector

Returns:

an empty list of provider library objects

onInit

public void onInit()

Upon successful connector initialization, logs a message announcing the initialization with the connector name.

Specified by:

onInit in interface JitterbitConnector

getProtectedParams

public Map<? extends String,? extends String> getProtectedParams()

Description copied from interface: JitterbitConnector

This returns connector parameters that shouldn't be accessible or modifiable by user who is using the connector. These are set by the person who created the connector and are essentially protected from the end user. e.g. an endpoint URL

Specified by:

getProtectedParams in interface JitterbitConnector

Returns:

Key / Value Map

setProtectedParams

public void setProtectedParams(Map<? extends String,? extends String> params)

Description copied from interface: JitterbitConnector

Set protected paramaters that shouldn't be modifiable or accessible by user who is using the connector. These are set by the person who created the connector and are essentially protected from the end user. e.g. an endpoint URL

Specified by:

setProtectedParams in interface JitterbitConnector

getCombinedParams

public Map<String,String> getCombinedParams(Map<String,String> params)

Description copied from interface: JitterbitConnector

Convenience method to combine the protected parameters and non-protected parameters / properties.

Specified by:

getCombinedParams in interface JitterbitConnector

Returns: