com.highqsoft.moma.rules.utils

Class WebServiceRule

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.xsd.AbstractRule

com.highqsoft.xsd.AbstractSequencerRule

com.highqsoft.moma.rules.utils.WebServiceRule

All Implemented Interfaces:

ExecutableIF, ImplementationIF, RuleIF

public class WebServiceRule
extends AbstractSequencerRule

\page MappingRules \section rules_com_highqsoft_moma_rules_utils_WebServiceRule WebServiceRule \addindex webservice REST This rule request a REST resource from a web service. The rule gives back only one NameValueUnit with name 'WebServiceBody' and value of type DT_STRING carrying the web service native response body. This rule can be used as a sequence of rules or can be used in the 'init' or terminate section of a jobfile. Type: SequencerRule \par Properties \li \b WebServiceURL (required, no default, DT_STRING)
Specifies the URL of the web service resource, to which the request command is sent. \b Note: If the \WebServiceMethod is GET and the URL starts with file:// the rule will read the file the URL points to instead of sending a real GET request to a web service. This can be useful to test and simulation outside the customers environment. \li \b WebServiceAccept (optional, default "application/xml", DT_STRING)
When this value is defined in the job file, the value will define the format of the data, by which the requested resource will be extracted from service. \li \b WebServiceMethod (optional, default "POST", DT_STRING)
When this value is defined in the job file, the value will define the web service method use to extract the requested resource. \li \b WebServicePayload (optional, no default, DT_STRING)
Must contain the data that will be posted to the web service. For example: (session, sda:sda@HQS/weatherdemo.ASAM-ODS, hql, hql * from Station) \li \b WebServicePayloadSeparator (optional, default ",", DT_STRING)
When this value is defined in the job file, the value will define the character for splitting the data from parameter: WebServicePayLoad. When missing the payload will be given to the service as it is! \li \b WebServicePayloadType(optional, default application/x-www-form-urlencoded, DT_STRING)
When this value is defined in the job file, the value will define the character for splitting the data from parameter: WebServicePayLoad. When missing the payload will be given to the service as it is! \li \b WebServiceHeader (optional, no default, DT_STRING)
This property contains optional header fields. The fields and values are separated by \e WebServiceHeaderSeparator. The number of parameters must be even (name1,value1,...,namex,valuex) \li \b WebServiceHeaderSeparator (optional, default ",", DT_STRING)
The character used to split \e WebServiceHeader \li \b WebServiceFailOnError (optional, default "true", DT_BOOLEAN)
The character used to split \e WebServiceHeader \par Example The example below is called to add the path to an attribute, which contains only a filename. /code \endcode /code \endcode

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractSequencerRule

cleanAfterGet, localNVU

Fields inherited from class com.highqsoft.xsd.AbstractRule

loggerName, postMethods, preMethods, sessionRef

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
WebServiceRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	createPayload(java.lang.String type, java.lang.String body, java.lang.String separator) Split the payload into name value pairs if the payload type is APPLICATION_X_WWW_FORM_URLENCODED
void	execute() The execute method.
NameValueUnit[][]	getValue() The getValue method, return the values of the AbstractSequencerRule.localNVU field.
void	init() Initialize the work.
void	setValue(NameValueUnit[][] nvu) The setValue, change the values.
void	terminate() The terminate method reset the private variables.

Methods inherited from class com.highqsoft.xsd.AbstractRule

execute, executePostMethods, executePreMethods, getAoSessionFromContextWithSessionRef, getId, getOdsCache, getPointTo, getSessionRef, getType, isPedantic, setGathermode, setId, setPointTo, setPostMethods, setPreMethods, setSessionRef, setType, toString, toString, toString

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

WebServiceRule

public WebServiceRule()

Method Detail

init

public void init()
          throws InitializationFailedException

Description copied from class: AbstractImplementation

Initialize the work.

Specified by:

init in interface ImplementationIF

Overrides:

init in class AbstractSequencerRule

Throws:

InitializationFailedException - if the initialization fails.

getValue

public NameValueUnit[][] getValue()
                           throws RuleException

Description copied from class: AbstractSequencerRule

The getValue method, return the values of the AbstractSequencerRule.localNVU field. If rule property 'CLEANAFTERGET' was set to true, the nvu field of the rule is wiped to clear memory.

Specified by:

getValue in interface RuleIF

Overrides:

getValue in class AbstractSequencerRule

Returns:

the values.

Throws:

RuleException

See Also:

RuleIF.getValue()

setValue

public void setValue(NameValueUnit[][] nvu)
              throws RuleException

The setValue, change the values.

Parameters:

nvu - The name value of the rule.

Throws:

RuleException

execute

public void execute()
             throws ExecutableException

The execute method. It is useful for when used as implementation only.

Specified by:

execute in interface ExecutableIF

Overrides:

execute in class AbstractSequencerRule

Throws:

ExecutableException - if execution fails.

See Also:

AbstractRule.execute()

terminate

public void terminate()
               throws TerminationException

The terminate method reset the private variables.

Specified by:

terminate in interface ExecutableIF

Overrides:

terminate in class AbstractSequencerRule

Throws:

TerminationException - if termination fails.

See Also:

AbstractRule.terminate()

createPayload

protected final java.lang.String createPayload(java.lang.String type,
                             java.lang.String body,
                             java.lang.String separator)
                                        throws ExecutableException

Split the payload into name value pairs if the payload type is APPLICATION_X_WWW_FORM_URLENCODED

Parameters:

type - The payload type

body - The payload

separator - The separator used to split the body

Returns:

The formatted payload

Throws:

ExecutableException