org.pentaho.di.trans.steps.webservices

Class WebServiceMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.webservices.WebServiceMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class WebServiceMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STEP
static String	XSD_NS_URI

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
WebServiceMeta()
WebServiceMeta(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore)
WebServiceMeta(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases)

Method Summary

Modifier and Type	Method and Description
void	addFieldIn(WebServiceField field)
void	addFieldOut(WebServiceField field)
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Checks the settings of this step and puts the findings in a remarks List.
WebServiceMeta	clone() Make an exact copy of this step, make sure to explicitly copy Collections etc.
int	getCallStep()
WebServiceField	getFieldInFromName(String name)
WebServiceField	getFieldOutFromWsName(String wsName, boolean ignoreWsNsPrefix) Returns the WebServicesField for the given wsName.
void	getFields(org.pentaho.di.core.row.RowMetaInterface r, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
List<WebServiceField>	getFieldsIn()
List<WebServiceField>	getFieldsOut()
String	getHttpLogin()
String	getHttpPassword()
String	getInFieldArgumentName()
String	getInFieldContainerName()
String	getOperationName()
String	getOperationNamespace()
String	getOperationRequestName()
String	getOutFieldArgumentName()
String	getOutFieldContainerName()
String	getProxyHost()
String	getProxyPort()
String	getRepeatingElementName()
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans disp) Get the executing step, needed by Trans to launch a step.
StepDataInterface	getStepData() Get a new instance of the appropriate data class.
String	getUrl()
String	getXML() Produces the XML string that describes this step's information.
boolean	hasFieldsIn()
boolean	isCompatible()
boolean	isPassingInputData()
boolean	isReturningReplyAsString()
void	loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Node
void	readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) Read the steps information from a Kettle repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) Save the steps data into a Kettle repository
void	setCallStep(int callStep)
void	setCompatible(boolean compatible)
void	setDefault() Set default values
void	setFieldsIn(List<WebServiceField> fieldsIn)
void	setFieldsOut(List<WebServiceField> fieldsOut)
void	setHttpLogin(String httpLogin)
void	setHttpPassword(String httpPassword)
void	setInFieldArgumentName(String inFieldArgumentName)
void	setInFieldContainerName(String inFieldContainerName)
void	setOperationName(String operationName)
void	setOperationNamespace(String operationNamespace)
void	setOperationRequestName(String operationRequestName)
void	setOutFieldArgumentName(String outFieldArgumentName)
void	setOutFieldContainerName(String outFieldContainerName)
void	setPassingInputData(boolean passingInputData)
void	setProxyHost(String proxyHost)
void	setProxyPort(String proxyPort)
void	setRepeatingElementName(String repeatingElementName)
void	setReturningReplyAsString(boolean returningReplyAsString)
void	setUrl(String url)

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, analyseImpact, cancelQueries, check, check, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, supportsErrorHandling

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, analyseImpact, cancelQueries, check, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta, supportsErrorHandling

Field Detail

XSD_NS_URI

public static final String XSD_NS_URI

See Also:

Constant Field Values

DEFAULT_STEP

public static final int DEFAULT_STEP

See Also:

Constant Field Values

Constructor Detail

WebServiceMeta

public WebServiceMeta()

WebServiceMeta

public WebServiceMeta(Node stepnode,
                      List<org.pentaho.di.core.database.DatabaseMeta> databases,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws org.pentaho.di.core.exception.KettleXMLException

Throws:

org.pentaho.di.core.exception.KettleXMLException

WebServiceMeta

public WebServiceMeta(Repository rep,
                      org.pentaho.metastore.api.IMetaStore metaStore,
                      org.pentaho.di.repository.ObjectId id_step,
                      List<org.pentaho.di.core.database.DatabaseMeta> databases)
               throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

Method Detail

getFields

public void getFields(org.pentaho.di.core.row.RowMetaInterface r,
                      String name,
                      org.pentaho.di.core.row.RowMetaInterface[] info,
                      StepMeta nextStep,
                      org.pentaho.di.core.variables.VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws org.pentaho.di.core.exception.KettleStepException

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

r - the input row meta that is modified in this method to reflect the output row metadata of the step

name - Name of the step to use as input for the origin field in the values

info - Fields used as extra lookup information

nextStep - the next step that is targeted

space - the space The variable space to use to replace variables

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

Throws:

org.pentaho.di.core.exception.KettleStepException - the kettle step exception

clone

public WebServiceMeta clone()

Description copied from interface: StepMetaInterface

Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:

clone in interface StepMetaInterface

Overrides:

clone in class BaseStepMeta

Returns:

an exact copy of this step

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  org.pentaho.di.core.row.RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  org.pentaho.di.core.row.RowMetaInterface info,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from interface: StepMetaInterface

Checks the settings of this step and puts the findings in a remarks List.

Specified by:

check in interface StepMetaInterface

Overrides:

check in class BaseStepMeta

Parameters:

remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult

stepMeta - The stepMeta to help checking

prev - The fields coming from the previous step

input - The input step names

output - The output step names

info - The fields that are used as information by the step

space - the variable space to resolve variable expressions with

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

getXML

public String getXML()

Description copied from class: BaseStepMeta

Produces the XML string that describes this step's information.

Specified by:

getXML in interface StepMetaInterface

Overrides:

getXML in class BaseStepMeta

Returns:

String containing the XML describing this step.

loadXML

public void loadXML(Node stepnode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Overrides:

loadXML in class BaseStepMeta

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

metaStore - the metastore to optionally load external reference metadata from

Throws:

org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

readRep

public void readRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_step,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases)
             throws org.pentaho.di.core.exception.KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Overrides:

readRep in class BaseStepMeta

Parameters:

rep - The repository to read from

metaStore - The MetaStore to read external information from

id_step - The step ID

databases - The databases to reference

Throws:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_transformation,
                    org.pentaho.di.repository.ObjectId id_step)
             throws org.pentaho.di.core.exception.KettleException

Description copied from interface: StepMetaInterface

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Overrides:

saveRep in class BaseStepMeta

Parameters:

rep - The Kettle repository to save to

metaStore - the metaStore to optionally write to

id_transformation - The transformation ID

id_step - The step ID

Throws:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

getOperationName

public String getOperationName()

setOperationName

public void setOperationName(String operationName)

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta transMeta,
                             Trans disp)

Description copied from interface: StepMetaInterface

Get the executing step, needed by Trans to launch a step.

Specified by:

getStep in interface StepMetaInterface

Parameters:

stepMeta - The step info

stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.

cnr - The copy nr to get

transMeta - The transformation info

disp - The launching transformation

getStepData

public StepDataInterface getStepData()

Description copied from interface: StepMetaInterface

Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:

getStepData in interface StepMetaInterface

Returns:

The appropriate StepDataInterface class.

getFieldInFromName

public WebServiceField getFieldInFromName(String name)

getFieldOutFromWsName

public WebServiceField getFieldOutFromWsName(String wsName,
                                             boolean ignoreWsNsPrefix)

Returns the WebServicesField for the given wsName.

Parameters:

wsName - The name of the WebServiceField to return

ignoreWsNsPrefix - If true the lookup of the cache of WebServiceFields will not include the target namespace prefix.

Returns:

getFieldsIn

public List<WebServiceField> getFieldsIn()

setFieldsIn

public void setFieldsIn(List<WebServiceField> fieldsIn)

hasFieldsIn

public boolean hasFieldsIn()

addFieldIn

public void addFieldIn(WebServiceField field)

getFieldsOut

public List<WebServiceField> getFieldsOut()

setFieldsOut

public void setFieldsOut(List<WebServiceField> fieldsOut)

addFieldOut

public void addFieldOut(WebServiceField field)

getInFieldArgumentName

public String getInFieldArgumentName()

setInFieldArgumentName

public void setInFieldArgumentName(String inFieldArgumentName)

getOutFieldArgumentName

public String getOutFieldArgumentName()

setOutFieldArgumentName

public void setOutFieldArgumentName(String outFieldArgumentName)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getCallStep

public int getCallStep()

setCallStep

public void setCallStep(int callStep)

getOperationNamespace

public String getOperationNamespace()

setOperationNamespace

public void setOperationNamespace(String operationNamespace)

getHttpLogin

public String getHttpLogin()

setHttpLogin

public void setHttpLogin(String httpLogin)

getHttpPassword

public String getHttpPassword()

setHttpPassword

public void setHttpPassword(String httpPassword)

getProxyHost

public String getProxyHost()

setProxyHost

public void setProxyHost(String proxyHost)

getProxyPort

public String getProxyPort()

setProxyPort

public void setProxyPort(String proxyPort)

getInFieldContainerName

public String getInFieldContainerName()

setInFieldContainerName

public void setInFieldContainerName(String inFieldContainerName)

getOutFieldContainerName

public String getOutFieldContainerName()

setOutFieldContainerName

public void setOutFieldContainerName(String outFieldContainerName)

isPassingInputData

public boolean isPassingInputData()

Returns:

the passingInputData

setPassingInputData

public void setPassingInputData(boolean passingInputData)

Parameters:

passingInputData - the passingInputData to set

isCompatible

public boolean isCompatible()

Returns:

the compatible

setCompatible

public void setCompatible(boolean compatible)

Parameters:

compatible - the compatible to set

getRepeatingElementName

public String getRepeatingElementName()

Returns:

the repeatingElementName

setRepeatingElementName

public void setRepeatingElementName(String repeatingElementName)

Parameters:

repeatingElementName - the repeatingElementName to set

isReturningReplyAsString

public boolean isReturningReplyAsString()

Returns:

true if the reply from the service is simply passed on as a String, mostly in XML

setReturningReplyAsString

public void setReturningReplyAsString(boolean returningReplyAsString)

Parameters:

returningReplyAsString - true if the reply from the service is simply passed on as a String, mostly in XML

getOperationRequestName

public String getOperationRequestName()

Returns:

the operationRequestName

setOperationRequestName

public void setOperationRequestName(String operationRequestName)

Parameters:

operationRequestName - the operationRequestName to set