A B C D E F G H I J L M N O P R S T U V W

A

Action - Interface in org.jitterbit.connector.sdk

Represent an action that is being invoked by the user as part of a UI.

Action.ActionResultData - Class in org.jitterbit.connector.sdk

ActionResultData() - Constructor for class org.jitterbit.connector.sdk.Action.ActionResultData

activities - Variable in class org.jitterbit.connector.sdk.DeployedEntity.IdTuple

The chain of activities associated with this connector when configured.

Activity - Annotation Type in org.jitterbit.connector.sdk.annotation

Annotates classes that implement the JitterbitActivity interface and that represent a Jitterbit connector activity.

ActivityEntity() - Constructor for class org.jitterbit.connector.sdk.DeployedEntity.ActivityEntity

ActivityExecutionException - Exception in org.jitterbit.connector.sdk.exceptions

Exception thrown if there is an error during the execution of an activity.

ActivityExecutionException(String, String, Throwable) - Constructor for exception org.jitterbit.connector.sdk.exceptions.ActivityExecutionException

Exception thrown if there is an error during the execution of an activity.

ActivityExecutionException(String, String) - Constructor for exception org.jitterbit.connector.sdk.exceptions.ActivityExecutionException

Exception thrown if there is an error during the execution of an activity.

ActivityFunctionParameters - Class in org.jitterbit.connector.sdk.metadata

Defines properties used to describe a JitterbitActivity of a JitterbitConnector.

ActivityFunctionParameters() - Constructor for class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

ActivityRequestResponseMetaData - Class in org.jitterbit.connector.sdk.metadata

Defines an XML Schema for the request/response metadata associated with a JitterbitActivity of a JitterbitConnector.

ActivityRequestResponseMetaData() - Constructor for class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

ActivityStatus(JitterbitActivity.Status, String) - Constructor for class org.jitterbit.connector.sdk.JitterbitActivity.ActivityStatus

B

BaseJitterbitConnector - Class in org.jitterbit.connector.sdk

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

BaseJitterbitConnector() - Constructor for class org.jitterbit.connector.sdk.BaseJitterbitConnector

C

children - Variable in class org.jitterbit.connector.sdk.Action.ActionResultData

close() - Method in interface org.jitterbit.connector.sdk.Connection

Closes the connection.

close() - Method in interface org.jitterbit.connector.sdk.Payload

Closes all open streams, both input and output.

close() - Method in class org.jitterbit.connector.sdk.Payload.StringBufferOutputStream

Closes the output stream (empty).

close() - Method in class org.jitterbit.connector.sdk.Payload.StringPayload

Connection - Interface in org.jitterbit.connector.sdk

The API that a connection to an endpoint needs to implement.

Connection.ConnectionException - Exception in org.jitterbit.connector.sdk

Exception thrown if there is an error during a connection.

ConnectionException(String, String, Throwable) - Constructor for exception org.jitterbit.connector.sdk.Connection.ConnectionException

Exception thrown if there is an error during a connection.

ConnectionFactory - Interface in org.jitterbit.connector.sdk

A factory that creates a Connection instance.

ConnectionFactory.PoolSizeConfiguration - Class in org.jitterbit.connector.sdk

A configuration for a connection pool using default values.

Connector - Annotation Type in org.jitterbit.connector.sdk.annotation

Annotates classes that implement the JitterbitConnector and that represent a Jitterbit connector.

CONNECTOR_CONTEXT - Static variable in interface org.jitterbit.connector.sdk.JitterbitConnector

Stores an instance of the JitterbitConnector.ConnectorContext that the connector and activities have access to - this instance is available during the invocation of Discoverable APIs and as well during the invocation of JitterbitActivity.execute(ExecutionContext).

contextProps() - Method in interface org.jitterbit.connector.sdk.Discoverable.DiscoverContextRequest

Return context properties.

convertDateTo(Date) - Static method in class org.jitterbit.connector.sdk.util.Utils

Converts a Date into an XMLGregorianCalendar date.

create() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector.Factory

Creates an instance of JitterbitConnector.

createActivity() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.Factory

Creates an instance of a JitterbitActivity.

createConnection(Map<String, String>) - Method in interface org.jitterbit.connector.sdk.ConnectionFactory

Returns a Connection instance.

D

DeployedActivity(DeployedEntity, JitterbitActivity) - Constructor for class org.jitterbit.connector.sdk.DeployedEntity.DeployedActivity

Constructs a deployed activity with a deployed entity and an activity.

DeployedEntity - Class in org.jitterbit.connector.sdk

A deployed entity corresponds to an activity deployed within an operation with an attached endpoint entity as defined by a Jitterbit Cloud Studio project.

DeployedEntity() - Constructor for class org.jitterbit.connector.sdk.DeployedEntity

DeployedEntity.ActivityEntity - Class in org.jitterbit.connector.sdk

Represents an activity as an entity.

DeployedEntity.DeployedActivity - Class in org.jitterbit.connector.sdk

Represents an activity that has been deployed.

DeployedEntity.EndpointEntity - Class in org.jitterbit.connector.sdk

Represents an activity that is an endpoint entity.

DeployedEntity.Entity - Class in org.jitterbit.connector.sdk

An entity corresponds to an activity of a connector.

DeployedEntity.Id - Class in org.jitterbit.connector.sdk

Represents the key of an entity.

DeployedEntity.IdTuple - Class in org.jitterbit.connector.sdk

Represents the three types of keys sets associated with a connector.

DeployedEntity.OperationEntity - Class in org.jitterbit.connector.sdk

Represents the operation that a connector activity is deployed in.

DeployedEntity.Type - Enum in org.jitterbit.connector.sdk

The different types of deployed entities.

description - Variable in class org.jitterbit.connector.sdk.Action.ActionResultData

Discoverable - Interface in org.jitterbit.connector.sdk

Provides the interface defining the interactions with an endpoint for the discovery of the metadata associated with a connector.

Discoverable.DiscoverContextRequest<T> - Interface in org.jitterbit.connector.sdk

The context in which a discovery (configuration) operation is executed.

Discoverable.DiscoveryException - Exception in org.jitterbit.connector.sdk

Exception thrown if there is an error during discovery.

DiscoverableField - Class in org.jitterbit.connector.sdk.metadata

POJO that defines attributes associated to a field as part of the discovery process that handles Discoverable objects that a Jitterbit Activity works with.

DiscoverableField() - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableField

DiscoverableField(String, String, Boolean, Boolean, Boolean, String, Object, List<Object>, List<String>, List<DiscoverableField.Properties>) - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableField

DiscoverableField.Properties - Class in org.jitterbit.connector.sdk.metadata

DiscoverableObject - Class in org.jitterbit.connector.sdk.metadata

DiscoverableObject() - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableObject

DiscoverableObjectMetaData - Class in org.jitterbit.connector.sdk.metadata

DiscoverableObjectMetaData() - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

DiscoverableObjectMetaData.Relationship - Class in org.jitterbit.connector.sdk.metadata

DiscoverableObjectMetaDataRequest - Class in org.jitterbit.connector.sdk.metadata

DiscoverableObjectMetaDataRequest() - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

DiscoverableObjectRequest - Class in org.jitterbit.connector.sdk.metadata

DiscoverableObjectRequest() - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

DiscoveryException(String, String) - Constructor for exception org.jitterbit.connector.sdk.Discoverable.DiscoveryException

Exception thrown if there is an error during discovery.

DiscoveryException(String, String, Throwable) - Constructor for exception org.jitterbit.connector.sdk.Discoverable.DiscoveryException

Exception thrown if there is an error during discovery.

E

EndpointEntity() - Constructor for class org.jitterbit.connector.sdk.DeployedEntity.EndpointEntity

endpoints - Variable in class org.jitterbit.connector.sdk.DeployedEntity.IdTuple

The chain of endpoints associated with this connector when configured.

Entity() - Constructor for class org.jitterbit.connector.sdk.DeployedEntity.Entity

equals(Object) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Id

Returns true if the object being compared has the same key and type.

execute(JitterbitActivity.ExecutionContext) - Method in interface org.jitterbit.connector.sdk.JitterbitActivity

Executes an activity.

EXECUTION_CONTEXT - Static variable in interface org.jitterbit.connector.sdk.JitterbitConnector

Stores an instance of the JitterbitActivity.ExecutionContext for the current activity being executed.

F

flush() - Method in class org.jitterbit.connector.sdk.Payload.StringBufferOutputStream

Forces any buffered output to be written (empty).

G

getActivity() - Method in class org.jitterbit.connector.sdk.DeployedEntity.DeployedActivity

Returns the JitterbitActivity of this deployed activity.

getActivity() - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns the activity associated with an entity.

getActivityId() - Method in class org.jitterbit.connector.sdk.DeployedEntity.OperationEntity

Returns the ID of the activity it is associated with.

getActivityRequestResponseMetadata(Discoverable.DiscoverContextRequest<ActivityFunctionParameters>) - Method in interface org.jitterbit.connector.sdk.Discoverable

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

getActivityStatus() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.ExecutionContext

getChild() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

getCombinedParams(Map<String, String>) - Method in class org.jitterbit.connector.sdk.BaseJitterbitConnector

getCombinedParams(Map<String, String>) - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

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

getConnection() - Method in interface org.jitterbit.connector.sdk.Discoverable.DiscoverContextRequest

Returns a reference to the connection endpoint.

getConnection() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.ExecutionContext

Returns a reference to the connection.

getConnection() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector.TestQueryContext

Returns a reference to the connection endpoint.

getConnectionFactory() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

Returns a reference to a factory that can be used to create a connection to the endpoint.

getContent() - Method in class org.jitterbit.connector.sdk.metadata.SchemaMetaData

Return the content of the schema in a string format.

getContent() - Method in interface org.jitterbit.connector.sdk.Payload

Returns the content as a string.

getContent() - Method in class org.jitterbit.connector.sdk.Payload.StringBufferOutputStream

Returns the content of the output stream.

getContent() - Method in class org.jitterbit.connector.sdk.Payload.StringPayload

getDataType() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the dataType value for this Field.

getDefaultValue() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the defaultValue value for this Field.

getDeployedEntity() - Method in class org.jitterbit.connector.sdk.DeployedEntity.DeployedActivity

Returns the DeployedEntity of this deployed activity.

getDeployedEntityType() - Method in class org.jitterbit.connector.sdk.DeployedEntity.ActivityEntity

Returns the type of this entity, which is always DeployedEntity.Type.ACTIVITY.

getDeployedEntityType() - Method in class org.jitterbit.connector.sdk.DeployedEntity.EndpointEntity

Returns the type of this entity, which is always DeployedEntity.Type.ENDPOINT.

getDeployedEntityType() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the entity type that this entity represents when it is deployed.

getDeployedEntityType() - Method in class org.jitterbit.connector.sdk.DeployedEntity.OperationEntity

Returns the type of this entity, which is always DeployedEntity.Type.OPERATION.

getDiscoverableObject() - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

getDiscoverableObjects() - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

getDisplayName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the displayName value for this Field.

getEndpoint() - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns the endpoint entity associated with an entity.

getEndpointId() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the linked endpoint ID of this entity.

getEntityTypeId() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the entity type ID of this entity.

getEnvId() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the ID of the environment this entity.

getEnvId() - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns the environment ID of an entity.

getEnvironmentId() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector.ConnectorContext

getErrorCode() - Method in exception org.jitterbit.connector.sdk.Discoverable.DiscoveryException

Returns the error code of the exception.

getErrorCode() - Method in exception org.jitterbit.connector.sdk.exceptions.ActivityExecutionException

Returns the code of the error.

getErrorCode() - Method in exception org.jitterbit.connector.sdk.exceptions.TestQueryException

Returns the code of the error.

getErrorDescription() - Method in exception org.jitterbit.connector.sdk.Connection.ConnectionException

Returns the description of the error.

getField() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

getFieldName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the fieldName value for this Field.

getFieldName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

getFieldProperties() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the fieldProperties value for this Field.

getFilter() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

Filter the list of objects based on this value.

getFunctionParameters() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.ExecutionContext

Returns the configured properties associated with this activity.

getGuid() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the GUID of this entity.

getId() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the ID of this entity.

getInputStream() - Method in interface org.jitterbit.connector.sdk.Payload

Returns a reference to the InputStream associated with this payload.

getInputStream() - Method in class org.jitterbit.connector.sdk.Payload.StringPayload

getIsCreateable() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the isCreateable value for this Field.

getIsFilterable() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the isFilterable value for this Field.

getIsUpdateable() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the isUpdateable value for this Field.

getKey() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField.Properties

Gets the key value for this Properties.

getKeyValues() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the properties associated with this entity.

getLibraryPath() - Method in interface org.jitterbit.connector.sdk.ProviderLibrary

Returns the path to the local folder where the JARs associated with the library are located.

getLibraryProperties() - Method in interface org.jitterbit.connector.sdk.ProviderLibrary

Returns the set properties used to initialize a provider.

getMaxActive() - Method in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

Returns the maximum total number of active connections.

getMaxTotal() - Method in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

Returns the maximum total number of allowed connections.

getMaxWait() - Method in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

Returns the maximum number of waiting connections.

getMessage() - Method in class org.jitterbit.connector.sdk.JitterbitActivity.ActivityStatus

getName() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the deployed name of this entity.

getName() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity

Returns the name of the activity, unique within the context of the connector.

getName() - Method in class org.jitterbit.connector.sdk.metadata.ObjectName

Name of the object

getName() - Method in class org.jitterbit.connector.sdk.metadata.SchemaMetaData

Returns the name associated with the schema of an activity.

getName() - Method in interface org.jitterbit.connector.sdk.ProviderLibrary

Returns the name of the provider (such as ActiveMQ or RabbitMQ for JMS implementations).

getObjectDesc() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Gets the objectDesc value for this Object.

getObjectList(Discoverable.DiscoverContextRequest<DiscoverableObjectRequest>) - Method in interface org.jitterbit.connector.sdk.Discoverable

Return the list of objects associated to an activity.

getObjectMetadata(Discoverable.DiscoverContextRequest<DiscoverableObjectMetaDataRequest>) - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

Return the details about an object that has been previously return by (JitterbitActivity, Discoverable.DiscoverContextRequest )

getObjectName() - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

getObjectName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Gets the objectName value for this Object.

getObjectName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

getObjectName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

getObjectName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

getObjectName() - Method in class org.jitterbit.connector.sdk.metadata.ObjectSchemaMetaData

getObjectSchema(Discoverable.DiscoverContextRequest<DiscoverableObjectMetaDataRequest>) - Method in interface org.jitterbit.connector.sdk.Discoverable

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

getObjectType() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Get the type associated to this object as an Xml Schema Type.

getObjectType() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

getObjectType() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

getObjectType() - Method in class org.jitterbit.connector.sdk.metadata.ObjectSchemaMetaData

getOperation() - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns the operation that the entity is deployed within.

getOperation() - Method in exception org.jitterbit.connector.sdk.exceptions.LifecycleActivityException

Returns the operation included in an exception.

getOrgId() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the organization ID of this entity.

getOutputStream() - Method in interface org.jitterbit.connector.sdk.Payload

Returns a reference to the OutputStream associated with this payload.

getOutputStream() - Method in class org.jitterbit.connector.sdk.Payload.StringPayload

getParent() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

getParentObjectType() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Gets the parentObjectType value for this Object.

getPassword() - Method in class org.jitterbit.connector.sdk.DeployedEntity.EndpointEntity

Returns the password of this entity.

getPoolSizeConfiguration() - Method in interface org.jitterbit.connector.sdk.ConnectionFactory

Returns the pool size configuration properties associated with this type of Connection.

getPossibleValue() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the possibleValue value for this Field.

getProjectId() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector.ConnectorContext

getProperties() - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

Returns the properties describing an activity.

getProperties() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

getProperties() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

getProtectedParams() - Method in class org.jitterbit.connector.sdk.BaseJitterbitConnector

getProtectedParams() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

This returns connector parameters that shouldn't be accessible or modifiable by user who is using the connector.

getProviders() - Method in class org.jitterbit.connector.sdk.BaseJitterbitConnector

Returns an empty list of provider library objects.

getProviders() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

Returns a list of provider libraries associated with this connector.

getReferenceTo() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Gets the referenceTo value for this Field.

getRelationship() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

getRelationshipName() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

getRelationshipProperties() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

getRequest() - Method in interface org.jitterbit.connector.sdk.Discoverable.DiscoverContextRequest

Returns a reference to the request containing the requirements for the discovery process.

getRequest() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector.TestQueryContext

Returns a reference to the request containing the information required for the discovery process.

getRequestPayload() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.ExecutionContext

Returns the request payload associated with this execution context.

getRequestRootElement() - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns the request root element of this activity metadata.

getRequestSchema() - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

getRequestSchemaReferences() - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns the request schema metadata for this activity metadata.

getResponsePayload() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.ExecutionContext

Returns the response payload associated with this execution context.

getResponseRootElement() - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns the response root element of this activity metadata.

getResponseSchema() - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns the response schema metadata for this activity metadata.

getResponseSchemaReferences() - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

getResult() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector.TestQueryResult

Returns the result of testing the connection endpoint.

getSchemaContentType() - Method in class org.jitterbit.connector.sdk.metadata.SchemaMetaData

Return the type of the content.

getSchemaMetaData() - Method in class org.jitterbit.connector.sdk.metadata.ObjectSchemaMetaData

getSelectionObjects() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

getSelectionObjects() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

getSelectionPath() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

A set of properties that represents a list of properties according to user selection.

getStatus() - Method in class org.jitterbit.connector.sdk.JitterbitActivity.ActivityStatus

getStatus() - Method in enum org.jitterbit.connector.sdk.JitterbitActivity.Status

getType() - Method in enum org.jitterbit.connector.sdk.metadata.SchemaMetaData.SchemaContentType

getUsername() - Method in class org.jitterbit.connector.sdk.DeployedEntity.EndpointEntity

Returns the username of this entity.

getValue() - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField.Properties

Gets the value value for this Properties.

H

hashCode() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Id

Returns the hash code of the key.

I

Id() - Constructor for class org.jitterbit.connector.sdk.DeployedEntity.Id

id - Variable in class org.jitterbit.connector.sdk.DeployedEntity.Id

The key of the entity.

IdTuple() - Constructor for class org.jitterbit.connector.sdk.DeployedEntity.IdTuple

invoke(Connection, Map<String, String>) - Method in interface org.jitterbit.connector.sdk.Action

Invoke action

invokeAction(String, Discoverable.DiscoverContextRequest<Map<String, String>>) - Method in interface org.jitterbit.connector.sdk.Discoverable

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

J

JAXBHelper - Class in org.jitterbit.connector.sdk.util

Helper methods related to marshalling and unmarshalling JAXB objects into and out of strings.

JAXBHelper() - Constructor for class org.jitterbit.connector.sdk.util.JAXBHelper

JitterbitActivity - Interface in org.jitterbit.connector.sdk

A Jitterbit Activity is a unit of work that has a role of discovery (configuration) and execution.

JitterbitActivity.ActivityStatus - Class in org.jitterbit.connector.sdk

JitterbitActivity.ExecutionContext - Interface in org.jitterbit.connector.sdk

The context in which an activity is executed.

JitterbitActivity.Factory - Interface in org.jitterbit.connector.sdk

A factory that creates an instance of a JitterbitActivity.

JitterbitActivity.LifecycleOperation - Enum in org.jitterbit.connector.sdk

The possible stages of the lifecycle of an operation.

JitterbitActivity.State - Enum in org.jitterbit.connector.sdk

The possible states of an activity.

JitterbitActivity.Status - Enum in org.jitterbit.connector.sdk

JitterbitConnector - Interface in org.jitterbit.connector.sdk

Defines the connection test and activites that a Jitterbit Connector that runs within an agent should implement.

JitterbitConnector.ConnectorContext - Interface in org.jitterbit.connector.sdk

JitterbitConnector.Factory - Interface in org.jitterbit.connector.sdk

Factory that creates an instance of a JitterbitConnector.

JitterbitConnector.TestQueryContext<T> - Interface in org.jitterbit.connector.sdk

The context in which a query is tested during the discovery process.

JitterbitConnector.TestQueryResult - Interface in org.jitterbit.connector.sdk

Provides the results of testing a connection using a query string and connection properties.

L

LifecycleActivityException - Exception in org.jitterbit.connector.sdk.exceptions

Exception thrown if there is an error during the lifecycle of an activity.

LifecycleActivityException(JitterbitActivity.LifecycleOperation, String, Throwable) - Constructor for exception org.jitterbit.connector.sdk.exceptions.LifecycleActivityException

Exception thrown if there is an error during an activity of an operation.

M

marshall(Class, Object) - Static method in class org.jitterbit.connector.sdk.util.JAXBHelper

Serialize an JAXB-annotated object into a string.

MAX_ACTIVE - Static variable in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

MAX_TOTAL - Static variable in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

MAX_WAIT - Static variable in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

N

name - Variable in class org.jitterbit.connector.sdk.Action.ActionResultData

O

ObjectName - Class in org.jitterbit.connector.sdk.metadata

A simple named object.

ObjectName() - Constructor for class org.jitterbit.connector.sdk.metadata.ObjectName

ObjectSchemaMetaData - Class in org.jitterbit.connector.sdk.metadata

ObjectSchemaMetaData() - Constructor for class org.jitterbit.connector.sdk.metadata.ObjectSchemaMetaData

onDeploy(DeployedEntity) - Method in interface org.jitterbit.connector.sdk.JitterbitActivity

Invoked when an activity receives a deploy event request.

onInit() - Method in class org.jitterbit.connector.sdk.BaseJitterbitConnector

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

onInit() - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

Executed during the connector initialization.

onStart() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity

Invoked when an activity receives a start event request.

onStop() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity

Invoked when an activity receives a stop event request.

onUnDeploy(DeployedEntity) - Method in interface org.jitterbit.connector.sdk.JitterbitActivity

Invoked when an activity receives an undeploy event request.

open() - Method in interface org.jitterbit.connector.sdk.Connection

Opens a connection to an endpoint if is not currently open.

OperationEntity() - Constructor for class org.jitterbit.connector.sdk.DeployedEntity.OperationEntity

operations - Variable in class org.jitterbit.connector.sdk.DeployedEntity.IdTuple

The chain of operations associated with this connector when configured.

org.jitterbit.connector.sdk - package org.jitterbit.connector.sdk

The Jitterbit Connector SDK, an API for creating custom Jitterbit connectors.

org.jitterbit.connector.sdk.annotation - package org.jitterbit.connector.sdk.annotation

Annotations used in the Jitterbit Connector SDK.

org.jitterbit.connector.sdk.exceptions - package org.jitterbit.connector.sdk.exceptions

Exceptions used in the Jitterbit Connector SDK.

org.jitterbit.connector.sdk.metadata - package org.jitterbit.connector.sdk.metadata

Metadata used in the Jitterbit Connector SDK.

org.jitterbit.connector.sdk.util - package org.jitterbit.connector.sdk.util

Utility classes and methods used in the Jitterbit Connector SDK.

P

Payload - Interface in org.jitterbit.connector.sdk

Payload.StringBufferOutputStream - Class in org.jitterbit.connector.sdk

A default implementation of an output stream, as a string buffer combined with an output stream.

Payload.StringPayload - Class in org.jitterbit.connector.sdk

A default implementation of a payload.

persistenceRequired() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.ExecutionContext

Returns true if persistence is required.

PoolSizeConfiguration() - Constructor for class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

Properties() - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableField.Properties

Properties(String, Object) - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableField.Properties

ProviderLibrary - Interface in org.jitterbit.connector.sdk

Defines any provider implementations related to a connector.

R

Relationship() - Constructor for class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

reset() - Method in class org.jitterbit.connector.sdk.Payload.StringBufferOutputStream

Resets the output stream, deleting any content stored in the string buffer.

S

SchemaMetaData - Class in org.jitterbit.connector.sdk.metadata

Defines an XML Schema of metadata representing the input and output (request/response) of a JitterbitActivity.

SchemaMetaData() - Constructor for class org.jitterbit.connector.sdk.metadata.SchemaMetaData

SchemaMetaData.SchemaContentType - Enum in org.jitterbit.connector.sdk.metadata

setActivity(DeployedEntity.ActivityEntity) - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns this deployed entity after setting the associated activity.

setActivityId(DeployedEntity.Id) - Method in class org.jitterbit.connector.sdk.DeployedEntity.OperationEntity

Returns the entity after setting the ID of the activity it is associated with.

setActivityStatus(JitterbitActivity.ActivityStatus) - Method in interface org.jitterbit.connector.sdk.JitterbitActivity.ExecutionContext

Update the activity status to SUCCESS_WITH_INFO or SUCCESS_WITH_WARNING from SUCCESS when there is a need to let the operation know that there is extra information that the activity may return.

setChild(List<DiscoverableObject>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

setContent(String) - Method in class org.jitterbit.connector.sdk.metadata.SchemaMetaData

Returns this schema after setting the contents associated with it.

setContent(String) - Method in interface org.jitterbit.connector.sdk.Payload

Sets the content of the payload.

setContent(String) - Method in class org.jitterbit.connector.sdk.Payload.StringBufferOutputStream

Sets the content of the output stream after first resetting it.

setContent(String) - Method in class org.jitterbit.connector.sdk.Payload.StringPayload

setDataType(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the dataType value for this Field.

setDefaultValue(Object) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the defaultValue value for this Field.

setDeployedEntity(DeployedEntity) - Method in class org.jitterbit.connector.sdk.DeployedEntity.DeployedActivity

Returns this deployed activity after setting its DeployedEntity.

setDeployedEntityType(DeployedEntity.Type) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns the entity after setting the type it represents when it is deployed.

setDiscoverableObject(DiscoverableObject) - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

setDiscoverableObjects(Map<String, DiscoverableObject>) - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

setDisplayName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the displayName value for this Field.

setEndpoint(DeployedEntity.EndpointEntity) - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns this deployed entity after setting the associated endpoint entity.

setEndpointId(DeployedEntity.Id) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting its linked endpoint ID.

setEntityTypeId(int) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting its the entity type ID.

setEnvId(Long) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting its environment ID.

setEnvId(Long) - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns this deployed entity after setting its environment ID.

setField(List<DiscoverableField>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

setFieldName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the fieldName value for this Field.

setFieldName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

setFilter(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

setGuid(String) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting its GUID.

setId(DeployedEntity.Id) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting its ID.

setIsCreateable(Boolean) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the isCreateable value for this Field.

setIsFilterable(Boolean) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the isFilterable value for this Field.

setIsUpdateable(Boolean) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the isUpdateable value for this Field.

setKey(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField.Properties

Sets the key value for this Properties.

setKeyValues(Map<String, String>) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting the properties associated with this entity.

setMaxActive(int) - Method in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

Returns this connection pool after setting the maximum total number of active connections.

setMaxTotal(int) - Method in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

Returns this connection pool after setting the maximum total number of allowed connections.

setMaxWait(int) - Method in class org.jitterbit.connector.sdk.ConnectionFactory.PoolSizeConfiguration

Returns this connection pool after setting the maximum number of waiting connections.

setName(String) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting its deployed name.

setName(String) - Method in class org.jitterbit.connector.sdk.metadata.ObjectName

setName(String) - Method in class org.jitterbit.connector.sdk.metadata.SchemaMetaData

Returns this schema after setting the name associated with it.

setObjectDesc(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Sets the objectDesc value for this Object.

setObjectName(String) - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

setObjectName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Sets the objectName value for this Object.

setObjectName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

setObjectName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

setObjectName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

setObjectName(String) - Method in class org.jitterbit.connector.sdk.metadata.ObjectSchemaMetaData

setObjectType(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Sets the objectType value for this Object.

setObjectType(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

setObjectType(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

setObjectType(String) - Method in class org.jitterbit.connector.sdk.metadata.ObjectSchemaMetaData

setOperation(DeployedEntity.OperationEntity) - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns this deployed entity after setting the operation that the entity is deployed within.

setOrgId(long) - Method in class org.jitterbit.connector.sdk.DeployedEntity.Entity

Returns this entity after setting its organization ID.

setParent(List<DiscoverableObject>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

setParentObjectType(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObject

Sets the parentObjectType value for this Object.

setPassword(String) - Method in class org.jitterbit.connector.sdk.DeployedEntity.EndpointEntity

Sets the password of this entity.

setPossibleValue(List<Object>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the possibleValue value for this Field.

setProperties(Map<String, String>) - Method in class org.jitterbit.connector.sdk.metadata.ActivityFunctionParameters

Returns the properties after setting them using a new collection.

setProperties(Map<String, String>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

setProperties(Map<String, String>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

setProtectedParams(Map<? extends String, ? extends String>) - Method in class org.jitterbit.connector.sdk.BaseJitterbitConnector

setProtectedParams(Map<? extends String, ? extends String>) - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

Set protected paramaters that shouldn't be modifiable or accessible by user who is using the connector.

setReferenceTo(List<String>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField

Sets the referenceTo value for this Field.

setRelationship(List<DiscoverableObjectMetaData.Relationship>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData

setRelationshipName(String) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

setRelationshipProperties(List<DiscoverableField.Properties>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaData.Relationship

setRequestRootElement(QName) - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns this activity metadata after setting its request root element.

setRequestSchema(SchemaMetaData) - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns this activity metadata after setting its request schema metadata.

setResponseRootElement(QName) - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns this activity metadata after setting its response root element.

setResponseSchema(SchemaMetaData) - Method in class org.jitterbit.connector.sdk.metadata.ActivityRequestResponseMetaData

Returns this activity metadata after setting its response schema metadata.

setSchemaContentType(SchemaMetaData.SchemaContentType) - Method in class org.jitterbit.connector.sdk.metadata.SchemaMetaData

setSchemaMetaData(SchemaMetaData) - Method in class org.jitterbit.connector.sdk.metadata.ObjectSchemaMetaData

setSelectionObjects(Map<String, DiscoverableObject>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectMetaDataRequest

setSelectionObjects(Map<String, DiscoverableObject>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

setSelectionPath(List<DiscoverableField.Properties>) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableObjectRequest

setUsername(String) - Method in class org.jitterbit.connector.sdk.DeployedEntity.EndpointEntity

Sets the username of this entity.

setValue(Object) - Method in class org.jitterbit.connector.sdk.metadata.DiscoverableField.Properties

Sets the value value for this Properties.

state() - Method in interface org.jitterbit.connector.sdk.JitterbitActivity

Returns the state of this activity.

status - Variable in enum org.jitterbit.connector.sdk.JitterbitActivity.Status

StringPayload(String) - Constructor for class org.jitterbit.connector.sdk.Payload.StringPayload

T

testConnection(Map<String, String>) - Method in class org.jitterbit.connector.sdk.BaseJitterbitConnector

Uses the specified properties to test a connection.

testConnection(Map<String, String>) - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

Tests that a connection to the endpoint is successful.

testQuery(JitterbitConnector.TestQueryContext<String>) - Method in interface org.jitterbit.connector.sdk.JitterbitConnector

Tests a query string when the test query button is pressed in the Jitterbit Studio.

TestQueryException - Exception in org.jitterbit.connector.sdk.exceptions

Exception thrown if there is an error during the execution of a test query.

TestQueryException(String, String, Throwable) - Constructor for exception org.jitterbit.connector.sdk.exceptions.TestQueryException

Exception thrown if there is an error during the execution of a test query.

toMap(List<DiscoverableField.Properties>) - Static method in class org.jitterbit.connector.sdk.metadata.DiscoverableField.Properties

toString() - Method in class org.jitterbit.connector.sdk.DeployedEntity.Id

Returns the string representation of the key.

toString() - Method in class org.jitterbit.connector.sdk.DeployedEntity

Returns a string-representation of an entity.

U

UIAction - Annotation Type in org.jitterbit.connector.sdk.annotation

Applies to classes that extend Action interface and represent and action that is executed on behalf of UI.

unmarshall(Class, Reader) - Static method in class org.jitterbit.connector.sdk.util.JAXBHelper

Create an instance of a JAXB object of type clz.

Utils - Class in org.jitterbit.connector.sdk.util

Utils() - Constructor for class org.jitterbit.connector.sdk.util.Utils

V

value - Variable in class org.jitterbit.connector.sdk.Action.ActionResultData

valueOf(String) - Static method in enum org.jitterbit.connector.sdk.DeployedEntity.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jitterbit.connector.sdk.JitterbitActivity.LifecycleOperation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jitterbit.connector.sdk.JitterbitActivity.State

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jitterbit.connector.sdk.JitterbitActivity.Status

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jitterbit.connector.sdk.metadata.SchemaMetaData.SchemaContentType

Returns the enum constant of this type with the specified name.

valueOfProp(String, Map<String, String>, int) - Static method in class org.jitterbit.connector.sdk.util.Utils

Returns the integer value of a named property that is part of a collection of properties.

values() - Static method in enum org.jitterbit.connector.sdk.DeployedEntity.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jitterbit.connector.sdk.JitterbitActivity.LifecycleOperation

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jitterbit.connector.sdk.JitterbitActivity.State

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jitterbit.connector.sdk.JitterbitActivity.Status

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jitterbit.connector.sdk.metadata.SchemaMetaData.SchemaContentType

Returns an array containing the constants of this enum type, in the order they are declared.

W

write(int) - Method in class org.jitterbit.connector.sdk.Payload.StringBufferOutputStream

Writes to the output stream.

A B C D E F G H I J L M N O P R S T U V W