Package org.teiid.translator.ws

Class WSExecutionFactory

java.lang.Object

org.teiid.translator.ExecutionFactory<ConnectionFactory,WSConnection>

org.teiid.translator.ws.WSExecutionFactory

@Translator(name="ws",
            description="A translator for making Web Service calls")
public class WSExecutionFactory
extends ExecutionFactory<ConnectionFactory,WSConnection>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WSExecutionFactory.Binding
static class	WSExecutionFactory.Event

Nested classes/interfaces inherited from class org.teiid.translator.ExecutionFactory

ExecutionFactory.Format, ExecutionFactory.NullOrder, ExecutionFactory.SupportedJoinCriteria, ExecutionFactory.TransactionSupport

Field Summary

Fields

Modifier and Type	Field	Description
static BundleUtil	UTIL

Fields inherited from class org.teiid.translator.ExecutionFactory

DEFAULT_MAX_FROM_GROUPS, DEFAULT_MAX_IN_CRITERIA_SIZE, DEFAULT_MAX_PROJECTED_COLUMNS

Constructor Summary

Constructors

Constructor	Description
WSExecutionFactory()

Method Summary

Modifier and Type	Method	Description
boolean	areLobsUsableAfterClose()	Indicates if LOBs are usable after the execution is closed.
ProcedureExecution	createProcedureExecution(Call command, ExecutionContext executionContext, RuntimeMetadata metadata, WSConnection connection)
WSExecutionFactory.Binding	getDefaultBinding()
Service.Mode	getDefaultServiceMode()
void	getMetadata(MetadataFactory metadataFactory, WSConnection conn)	Implement to provide metadata to the metadata for use by the engine.
MetadataProcessor<WSConnection>	getMetadataProcessor()	Get a MetadataProcessor for the translator to read the metadata.
List<String>	getSupportedFunctions()	Get list of all supported function names.
String	getXMLParamName()
void	setDefaultBinding(WSExecutionFactory.Binding defaultInvocationType)
void	setDefaultServiceMode(Service.Mode mode)
void	setXMLParamName(String xmlParamName)

Methods inherited from class org.teiid.translator.ExecutionFactory

addPushDownFunction, closeConnection, createDirectExecution, createExecution, createResultSetExecution, createUpdateExecution, getCacheDirective, getCollationLocale, getConnection, getConnection, getDefaultNullOrder, getDirectQueryProcedureName, getExcludedCommonTableExpressionName, getInstance, getLanguageFactory, getMaxDependentInPredicates, getMaxFromGroups, getMaxInCriteriaSize, getMaxProjectedColumns, getNativeQueryProcedureName, getPushDownFunctions, getRequiredLikeEscape, getSupportedJoinCriteria, getTransactionSupport, getTypeFacility, initCapabilities, isCopyLobs, isForkable, isImmutable, isSourceRequired, isSourceRequiredForCapabilities, isSourceRequiredForMetadata, isThreadBound, requiresCriteria, returnsSingleUpdateCount, setCollationLocale, setCopyLobs, setDirectQueryProcedureName, setExcludedCommonTableExpressionName, setImmutable, setMaxDependentInPredicates, setMaxInCriteriaSize, setNativeQueryProcedureName, setRequiresCriteria, setSourceRequired, setSourceRequiredForMetadata, setSupportedJoinCriteria, setSupportsDirectQueryProcedure, setSupportsFullOuterJoins, setSupportsInnerJoins, setSupportsNativeQueries, setSupportsOrderBy, setSupportsOuterJoins, setSupportsSelectDistinct, setThreadBound, setTransactionSupport, start, supportsAdvancedOlapOperations, supportsAggregatesAvg, supportsAggregatesCount, supportsAggregatesCountBig, supportsAggregatesCountStar, supportsAggregatesDistinct, supportsAggregatesEnhancedNumeric, supportsAggregatesMax, supportsAggregatesMin, supportsAggregatesSum, supportsAliasedTable, supportsArrayAgg, supportsArrayType, supportsBatchedUpdates, supportsBulkUpdate, supportsCommonTableExpressions, supportsCompareCriteriaEquals, supportsCompareCriteriaOrdered, supportsCompareCriteriaOrderedExclusive, supportsConvert, supportsCorrelatedSubqueries, supportsCorrelatedSubqueryLimit, supportsDependentJoins, supportsDirectQueryProcedure, supportsElementaryOlapOperations, supportsExcept, supportsExistsCriteria, supportsFormatLiteral, supportsFullDependentJoins, supportsFullOuterJoins, supportsFunctionsInGroupBy, supportsGeographyType, supportsGroupBy, supportsGroupByMultipleDistinctAggregates, supportsGroupByRollup, supportsHaving, supportsInCriteria, supportsInCriteriaSubquery, supportsInlineViews, supportsInnerJoins, supportsInsertWithQueryExpression, supportsIntersect, supportsIsDistinctCriteria, supportsIsNullCriteria, supportsLateralJoin, supportsLateralJoinCondition, supportsLikeCriteria, supportsLikeCriteriaEscapeCharacter, supportsLikeRegex, supportsListAgg, supportsMultipleOpenExecutions, supportsNativeQueries, supportsNotCriteria, supportsOnlyCorrelatedSubqueries, supportsOnlyFormatLiterals, supportsOnlyLateralJoinProcedure, supportsOnlyLiteralComparison, supportsOnlyRelationshipStyleJoins, supportsOnlySingleTableGroupBy, supportsOnlyTimestampAddLiteral, supportsOrCriteria, supportsOrderBy, supportsOrderByNullOrdering, supportsOrderByUnrelated, supportsOrderByWithExtendedGrouping, supportsOuterJoins, supportsPartialFiltering, supportsProcedureParameterExpression, supportsProcedureTable, supportsQuantifiedCompareCriteriaAll, supportsQuantifiedCompareCriteriaSome, supportsRecursiveCommonTableExpressions, supportsRowLimit, supportsRowOffset, supportsScalarSubqueries, supportsScalarSubqueryProjection, supportsSearchedCaseExpressions, supportsSelectDistinct, supportsSelectExpression, supportsSelectExpressionArrayType, supportsSelectWithoutFrom, supportsSelfJoins, supportsSetQueryLimitOffset, supportsSetQueryOrderBy, supportsSimilarTo, supportsStringAgg, supportsSubqueryCommonTableExpressions, supportsSubqueryInOn, supportsUnions, supportsUpsert, supportsWindowDistinctAggregates, supportsWindowFrameClause, supportsWindowFunctionCumeDist, supportsWindowFunctionNthValue, supportsWindowFunctionNtile, supportsWindowFunctionPercentRank, supportsWindowOrderByWithAggregates, useAnsiJoin, useBindingsForDependentJoin

Methods inherited from class java.lang.Object

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

Field Detail

UTIL

public static BundleUtil UTIL

Constructor Detail

WSExecutionFactory

public WSExecutionFactory()

Method Detail

getDefaultServiceMode

@TranslatorProperty(description="Contols request/response message wrapping - set to MESSAGE for full control over SOAP messages.",
                    display="Default Service FrameMode")
public Service.Mode getDefaultServiceMode()

setDefaultServiceMode

public void setDefaultServiceMode(Service.Mode mode)

getDefaultBinding

@TranslatorProperty(description="Contols what SOAP or HTTP type of invocation will be used if none is specified.",
                    display="Default Binding")
public WSExecutionFactory.Binding getDefaultBinding()

setDefaultBinding

public void setDefaultBinding(WSExecutionFactory.Binding defaultInvocationType)

getXMLParamName

@TranslatorProperty(description="Used with the HTTP binding (typically with the GET method) to indicate that the request document should be part of the query string.",
                    display="XML Param Name")
public String getXMLParamName()

setXMLParamName

public void setXMLParamName(String xmlParamName)

createProcedureExecution

public ProcedureExecution createProcedureExecution(Call command,
                                                   ExecutionContext executionContext,
                                                   RuntimeMetadata metadata,
                                                   WSConnection connection)
                                            throws TranslatorException

Overrides:

createProcedureExecution in class ExecutionFactory<ConnectionFactory,WSConnection>

Throws:

TranslatorException

getSupportedFunctions

public final List<String> getSupportedFunctions()

Description copied from class: ExecutionFactory

Get list of all supported function names. Arithmetic functions have names like "+".

Overrides:

getSupportedFunctions in class ExecutionFactory<ConnectionFactory,WSConnection>

See Also:

for a listing of system pushdown functions. Note that not all system functions are listed as some functions will use a common name such as CONCAT vs. the || operator, and other functions will be rewritten and not pushed down, such as SPACE. Note: User defined functions should be specified fully qualified.

getMetadataProcessor

public MetadataProcessor<WSConnection> getMetadataProcessor()

Description copied from class: ExecutionFactory

Get a MetadataProcessor for the translator to read the metadata. Typically this will return a new instance.

Overrides:

getMetadataProcessor in class ExecutionFactory<ConnectionFactory,WSConnection>

Returns:

getMetadata

public void getMetadata(MetadataFactory metadataFactory,
                        WSConnection conn)
                 throws TranslatorException

Description copied from class: ExecutionFactory

Implement to provide metadata to the metadata for use by the engine. This is the primary method of creating metadata for dynamic VDBs.

Overrides:

getMetadata in class ExecutionFactory<ConnectionFactory,WSConnection>

conn - may be null if the source is not required

Throws:

TranslatorException - to indicate a recoverable error, otherwise a RuntimeException

See Also:

ExecutionFactory.isSourceRequiredForMetadata()

areLobsUsableAfterClose

public boolean areLobsUsableAfterClose()

Description copied from class: ExecutionFactory

Indicates if LOBs are usable after the execution is closed. This check is not performed for values that are already ClobType or BlobType

Overrides:

areLobsUsableAfterClose in class ExecutionFactory<ConnectionFactory,WSConnection>

Returns:

true if LOBs can be used after close