org.jitterbit.connector.sdk

Interface Discoverable

All Known Subinterfaces:

JitterbitActivity

public interface Discoverable

Provides the interface defining the interactions with an endpoint for the discovery of the metadata associated with a connector. The discovered metadata will be used by the connector's activities at runtime as part of the execution process. For example, after interacting with a database endpoint or system, the list of tables and table details obtained represents the metadata for an activity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Discoverable.DiscoverContextRequest<T> The context in which a discovery (configuration) operation is executed.
static class	Discoverable.DiscoveryException Exception thrown if there is an error during discovery.

Method Summary

Modifier and Type	Method and Description
ActivityRequestResponseMetaData	getActivityRequestResponseMetadata(Discoverable.DiscoverContextRequest<ActivityFunctionParameters> activityFunctionParams) Returns as an XML Schema the request/response metadata associated with an activity.
default List<DiscoverableObject>	getObjectList(Discoverable.DiscoverContextRequest<DiscoverableObjectRequest> objectListRequest) Return the list of objects associated to an activity.
default DiscoverableObjectMetaData	getObjectSchema(Discoverable.DiscoverContextRequest<DiscoverableObjectMetaDataRequest> objectSchemaRequest) Return the details about an object that has been previously return by getObjectList(Discoverable.DiscoverContextRequest) (ObjectListRequest)}
default List<DiscoverableObject>	invokeAction(String actionName, Discoverable.DiscoverContextRequest<Map<String,String>> req) Experimental - This API can be invoked from UI to fetch meta-data/data from endpoint system.

Method Detail

getActivityRequestResponseMetadata

ActivityRequestResponseMetaData getActivityRequestResponseMetadata(Discoverable.DiscoverContextRequest<ActivityFunctionParameters> activityFunctionParams)
                                                            throws Discoverable.DiscoveryException

Returns as an XML Schema the request/response metadata associated with an activity.

The payload request/response returned when an activity is run in the JitterbitActivity.execute(JitterbitActivity.ExecutionContext) needs to conform with the request/response structure. In general, if the request/response payload needs to be processed, that can be accomplished using a transformation activity. The transformation activity will use the metadata to render the structure for the request/response.

Parameters:

activityFunctionParams - parameters for the activity function

Returns:

the request/response metadata

Throws:

Discoverable.DiscoveryException - if there is an exception discovering the metadata

getObjectList

default List<DiscoverableObject> getObjectList(Discoverable.DiscoverContextRequest<DiscoverableObjectRequest> objectListRequest)
                                        throws Discoverable.DiscoveryException

Return the list of objects associated to an activity. For example, for a db activity, one may choose to return the list of tables and then based on the table selected ask for list of columns associated with that table.

Parameters:

objectListRequest -

Returns:

Throws:

Discoverable.DiscoveryException

getObjectSchema

default DiscoverableObjectMetaData getObjectSchema(Discoverable.DiscoverContextRequest<DiscoverableObjectMetaDataRequest> objectSchemaRequest)
                                            throws Discoverable.DiscoveryException

Return the details about an object that has been previously return by getObjectList(Discoverable.DiscoverContextRequest) (ObjectListRequest)}

Parameters:

objectSchemaRequest -

Returns:

Throws:

Discoverable.DiscoveryException

invokeAction

default List<DiscoverableObject> invokeAction(String actionName,
                                              Discoverable.DiscoverContextRequest<Map<String,String>> req)

Experimental - This API can be invoked from UI to fetch meta-data/data from endpoint system.

Parameters:

actionName -

req -

Returns: