|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.trans.step.BaseStepMeta org.pentaho.di.trans.steps.rest.RestMeta
public class RestMeta
Field Summary | |
---|---|
static String |
APPLICATION_TYPE_ATOM_XML
|
static String |
APPLICATION_TYPE_FORM_URLENCODED
|
static String |
APPLICATION_TYPE_JSON
|
static String |
APPLICATION_TYPE_OCTET_STREAM
|
static String |
APPLICATION_TYPE_SVG_XML
|
static String |
APPLICATION_TYPE_TEXT_PLAIN
|
static String |
APPLICATION_TYPE_TEXT_XML
|
static String |
APPLICATION_TYPE_XHTML
|
static String |
APPLICATION_TYPE_XML
|
static String[] |
APPLICATION_TYPES
|
static String |
HTTP_METHOD_DELETE
|
static String |
HTTP_METHOD_GET
|
static String |
HTTP_METHOD_HEAD
|
static String |
HTTP_METHOD_OPTIONS
|
static String |
HTTP_METHOD_POST
|
static String |
HTTP_METHOD_PUT
|
static String[] |
HTTP_METHODS
|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
RestMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrheaders,
int nrparamers)
|
void |
check(List<CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepMeta,
RowMetaInterface prev,
String[] input,
String[] output,
RowMetaInterface info)
Checks the settings of this step and puts the findings in a remarks List. |
Object |
clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc. |
String |
getApplicationType()
Getter |
String |
getBodyField()
|
String |
getFieldName()
|
void |
getFields(RowMetaInterface inputRowMeta,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String[] |
getHeaderField()
|
String[] |
getHeaderName()
|
String |
getHttpLogin()
Getter |
String |
getHttpPassword()
|
String |
getMethod()
|
String |
getMethodFieldName()
|
String[] |
getParameterField()
|
String[] |
getParameterName()
|
String |
getProxyHost()
Getter |
String |
getProxyPort()
Getter |
String |
getResponseTimeFieldName()
|
String |
getResultCodeFieldName()
|
StepInterface |
getStep(StepMeta stepMeta,
StepDataInterface stepDataInterface,
int cnr,
TransMeta transMeta,
Trans trans)
Get the executing step, needed by Trans to launch a step. |
StepDataInterface |
getStepData()
Get a new instance of the appropriate data class. |
String |
getTrustStoreFile()
|
String |
getTrustStorePassword()
|
String |
getUrl()
|
String |
getUrlField()
|
String |
getXML()
Produces the XML string that describes this step's information. |
static boolean |
isActiveBody(String method)
|
static boolean |
isActiveParameters(String method)
|
boolean |
isDynamicMethod()
|
boolean |
isPreemptive()
|
boolean |
isUrlInField()
|
void |
loadXML(Node stepnode,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Load the values for this step from an XML Node |
void |
readRep(Repository rep,
ObjectId id_step,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Read the steps information from a Kettle repository |
void |
saveRep(Repository rep,
ObjectId id_transformation,
ObjectId id_step)
Save the steps data into a Kettle repository |
void |
setApplicationType(String applicationType)
Setter |
void |
setBodyField(String value)
|
void |
setDefault()
Set default values |
void |
setDynamicMethod(boolean dynamicMethod)
|
void |
setFieldName(String resultName)
|
void |
setHeaderField(String[] value)
|
void |
setHeaderName(String[] value)
|
void |
setHttpLogin(String httpLogin)
Setter |
void |
setHttpPassword(String httpPassword)
Setter |
void |
setMethod(String value)
|
void |
setMethodFieldName(String methodFieldName)
|
void |
setParameterField(String[] value)
|
void |
setParameterName(String[] value)
|
void |
setPreemptive(boolean preemptive)
|
void |
setProxyHost(String proxyHost)
Setter |
void |
setProxyPort(String proxyPort)
Setter |
void |
setResponseTimeFieldName(String responseTimeFieldName)
|
void |
setResultCodeFieldName(String resultCodeFieldName)
|
void |
setTrustStoreFile(String trustStoreFile)
Setter |
void |
setTrustStorePassword(String trustStorePassword)
Setter |
void |
setUrl(String procedure)
|
void |
setUrlField(String urlField)
|
void |
setUrlInField(boolean urlInField)
|
boolean |
supportsErrorHandling()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String[] APPLICATION_TYPES
public static final String APPLICATION_TYPE_TEXT_PLAIN
public static final String APPLICATION_TYPE_XML
public static final String APPLICATION_TYPE_JSON
public static final String APPLICATION_TYPE_OCTET_STREAM
public static final String APPLICATION_TYPE_XHTML
public static final String APPLICATION_TYPE_FORM_URLENCODED
public static final String APPLICATION_TYPE_ATOM_XML
public static final String APPLICATION_TYPE_SVG_XML
public static final String APPLICATION_TYPE_TEXT_XML
public static final String[] HTTP_METHODS
public static final String HTTP_METHOD_GET
public static final String HTTP_METHOD_POST
public static final String HTTP_METHOD_PUT
public static final String HTTP_METHOD_DELETE
public static final String HTTP_METHOD_HEAD
public static final String HTTP_METHOD_OPTIONS
Constructor Detail |
---|
public RestMeta()
Method Detail |
---|
public String getMethod()
public void setMethod(String value)
value
- The method to set.public String getBodyField()
public void setBodyField(String value)
value
- The bodyField to set.public String[] getHeaderName()
public void setHeaderName(String[] value)
value
- The headerName to set.public String[] getParameterField()
public void setParameterField(String[] value)
value
- The parameterField to set.public String[] getParameterName()
public void setParameterName(String[] value)
value
- The parameterName to set.public String[] getHeaderField()
public void setHeaderField(String[] value)
value
- The headerField to set.public String getUrl()
public void setUrl(String procedure)
procedure
- The procedure to set.public boolean isUrlInField()
public void setUrlInField(boolean urlInField)
urlInField
- Is the url coded in a field?public boolean isPreemptive()
public void setPreemptive(boolean preemptive)
preemptive
- Ispreemptive?public boolean isDynamicMethod()
public void setDynamicMethod(boolean dynamicMethod)
dynamicMethod
- If the method is defined in a field?public String getMethodFieldName()
public void setMethodFieldName(String methodFieldName)
methodFieldName
- public String getUrlField()
public void setUrlField(String urlField)
urlField
- name of the field that contains the urlpublic String getFieldName()
public void setFieldName(String resultName)
resultName
- The resultName to set.public void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public void allocate(int nrheaders, int nrparamers)
public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public void getFields(RowMetaInterface inputRowMeta, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) throws KettleStepException
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
inputRowMeta
- the input row metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the space
KettleStepException
- the kettle step exceptionpublic String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) throws KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
KettleException
- When an unexpected error occurred (database, network, etc)public void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
StepMetaInterface
check
in interface StepMetaInterface
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the steppublic StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettransMeta
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public boolean supportsErrorHandling()
supportsErrorHandling
in interface StepMetaInterface
supportsErrorHandling
in class BaseStepMeta
public String getResultCodeFieldName()
public void setResultCodeFieldName(String resultCodeFieldName)
resultCodeFieldName
- the resultCodeFieldName to setpublic void setProxyHost(String proxyHost)
proxyHost
- public String getProxyHost()
public void setProxyPort(String proxyPort)
proxyPort
- public String getProxyPort()
public void setApplicationType(String applicationType)
httpLogin
- public String getApplicationType()
public void setHttpLogin(String httpLogin)
httpLogin
- public String getHttpLogin()
public void setHttpPassword(String httpPassword)
httpPassword
- public String getHttpPassword()
public void setTrustStoreFile(String trustStoreFile)
trustStoreFile
- public String getTrustStoreFile()
public void setTrustStorePassword(String trustStorePassword)
trustStorePassword
- public String getTrustStorePassword()
public String getResponseTimeFieldName()
public void setResponseTimeFieldName(String responseTimeFieldName)
public static boolean isActiveBody(String method)
public static boolean isActiveParameters(String method)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |