Package com.boomi.connector.testutil

Class SimpleOperationContext

java.lang.Object

com.boomi.connector.testutil.SimpleAtomContext

com.boomi.connector.testutil.SimpleBrowseContext

com.boomi.connector.testutil.SimpleOperationContext

All Implemented Interfaces:

AtomContext, BrowseContext, ConnectorContext, OperationContext, PayloadMetadataFactory

public class SimpleOperationContext
extends SimpleBrowseContext
implements OperationContext

Simple implementation of OperationContext.

Constructor Summary

Constructors

Constructor	Description
SimpleOperationContext(AtomConfig config, Connector connector, OperationType opType, String customOpType, Map<String,Object> connProps, Map<String,Object> opProps, String objectTypeId, Map<ObjectDefinitionRole,String> cookies)	Constructs a new SimpleOperationContext with a custom operation type.
SimpleOperationContext(AtomConfig config, Connector connector, OperationType opType, Map<String,Object> connProps, Map<String,Object> opProps, String objectTypeId, Map<ObjectDefinitionRole,String> cookies)	Constructs a new SimpleOperationContext.
SimpleOperationContext(AtomConfig config, Connector connector, OperationType opType, Map<String,Object> connProps, Map<String,Object> opProps, String objectTypeId, Map<ObjectDefinitionRole,String> cookies, List<String> selectedFields)	Constructs a new SimpleOperationContext with selected fields.

Method Summary

Modifier and Type	Method	Description
PayloadMetadata	createMetadata()	Creates a new payload metadata instance that can be used in an ExtendedPayload.
Optional<ProfileSchema>	getInputSchema()	Returns the Schema instance defining the input profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata.
String	getObjectDefinitionCookie(ObjectDefinitionRole role)	Returns an object definition cookie constructed by the object profile retrieval during a browsing request.
String	getObjectTypeId()	Returns the id of the object type for which this operation is being executed.
Optional<ProfileSchema>	getOutputSchema()	Returns the Schema instance defining the output profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata.
List<String>	getSelectedFields()	Returns a field list describing the fields to be retrieved.

Methods inherited from class com.boomi.connector.testutil.SimpleBrowseContext

getConnectionProperties, getConnector, getConnectorCache, getCustomOperationType, getOperationProperties, getOperationType, getSSLContext

Methods inherited from class com.boomi.connector.testutil.SimpleAtomContext

createSSLContext, createTempOutputStream, getConfig, tempOutputStreamToInputStream, tempOutputStreamToPayload

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.boomi.connector.api.AtomContext

createTempOutputStream, getConfig, getSSLContext, tempOutputStreamToInputStream, tempOutputStreamToPayload

Methods inherited from interface com.boomi.connector.api.BrowseContext

getCustomOperationType, getOperationProperties, getOperationType

Methods inherited from interface com.boomi.connector.api.ConnectorContext

getConnectionProperties, getConnector, getConnectorCache

Constructor Detail

SimpleOperationContext

public SimpleOperationContext(AtomConfig config,
                              Connector connector,
                              OperationType opType,
                              Map<String,Object> connProps,
                              Map<String,Object> opProps,
                              String objectTypeId,
                              Map<ObjectDefinitionRole,String> cookies)

Constructs a new SimpleOperationContext.

Parameters:

config - the basic config for for operation execution

opType - the type of operation for operation execution

connProps - the connection properties for operation execution, may be null

opProps - the operation properties for operation execution, may be null

objectTypeId - the type of the object for operation execution

cookies - any cookies from the ObjectDefinition for the relevant object type, may be null

SimpleOperationContext

public SimpleOperationContext(AtomConfig config,
                              Connector connector,
                              OperationType opType,
                              String customOpType,
                              Map<String,Object> connProps,
                              Map<String,Object> opProps,
                              String objectTypeId,
                              Map<ObjectDefinitionRole,String> cookies)

Constructs a new SimpleOperationContext with a custom operation type.

Parameters:

config - the basic config for for operation execution

connector - the connector instance

opType - the type of operation for operation execution

customOpType - the custom operation type identifier, may be null

connProps - the connection properties for operation execution, may be null

opProps - the operation properties for operation execution, may be null

objectTypeId - the type of the object for operation execution

cookies - any cookies from the ObjectDefinition for the relevant object type, may be null

SimpleOperationContext

public SimpleOperationContext(AtomConfig config,
                              Connector connector,
                              OperationType opType,
                              Map<String,Object> connProps,
                              Map<String,Object> opProps,
                              String objectTypeId,
                              Map<ObjectDefinitionRole,String> cookies,
                              List<String> selectedFields)

Constructs a new SimpleOperationContext with selected fields.

Parameters:

config - the basic config for for operation execution

connector - the connector instance

opType - the type of operation for operation execution

connProps - the connection properties for operation execution, may be null

opProps - the operation properties for operation execution, may be null

objectTypeId - the type of the object for operation execution

cookies - any cookies from the ObjectDefinition for the relevant object type, may be null

selectedFields - the list of selected fields for the operation, may be null

Method Detail

getObjectTypeId

public String getObjectTypeId()

Description copied from interface: OperationContext

Returns the id of the object type for which this operation is being executed.

Specified by:

getObjectTypeId in interface OperationContext

getObjectDefinitionCookie

public String getObjectDefinitionCookie(ObjectDefinitionRole role)

Description copied from interface: OperationContext

Returns an object definition cookie constructed by the object profile retrieval during a browsing request.

Specified by:

getObjectDefinitionCookie in interface OperationContext

Parameters:

role - the role identifying the profile for which the profile is desired

Returns:

the stored cookie, or null if no cookie was stored for the profile

getSelectedFields

public List<String> getSelectedFields()

Description copied from interface: OperationContext

Returns a field list describing the fields to be retrieved. This may be null, indicating that all fields should be retrieved

Specified by:

getSelectedFields in interface OperationContext

getInputSchema

public Optional<ProfileSchema> getInputSchema()

Returns the Schema instance defining the input profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata. Each call returns a new ProfileSchema instance.

Specified by:

getInputSchema in interface OperationContext

Returns:

an Optional containing the ProfileSchema for input data if available, or Optional.empty() if no input schema is defined.

getOutputSchema

public Optional<ProfileSchema> getOutputSchema()

Returns the Schema instance defining the output profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata. Each call returns a new ProfileSchema instance.

Specified by:

getOutputSchema in interface OperationContext

Returns:

an Optional containing the ProfileSchema for output data if available, or Optional.empty() if no output schema is defined.

createMetadata

public PayloadMetadata createMetadata()

Description copied from interface: PayloadMetadataFactory

Creates a new payload metadata instance that can be used in an ExtendedPayload.

Specified by:

createMetadata in interface PayloadMetadataFactory

Returns:

the metadata instance