flux
Interface WebServiceAction

All Superinterfaces:

Action, java.lang.Cloneable, DynamicMethod, RuntimeDataMap, java.io.Serializable

public interface WebServiceAction
extends DynamicMethod, Action

Invokes an operation on a Web service. The operation name and input arguments to the Web service are specified using the DynamicMethod interface.

This action supports invoking Web services that are secured using usernames and passwords, as defined in the Web Services Security UsernameToken Profile.

The Web Service Action returns its result in the flow context variable "RESULT". The following table contains more information on accessing and using the result.

Flow Context Variable	Field	Java Type	Description
RESULT	result	java.lang.Object	The result returned by the Web service, which is not a Flux persistent object and may be a simple object like a string or an integer or a more complex object like an object array whose types are defined by the WSDL. The exact type of result depends entirely on the WSDL. Consult the WSDL for the exact return type.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Nested Class Summary

static class

WebServiceAction.WebServiceActionResult The result returned by the Web service, which is not a Flux persistent object and may be a single result object or multi-valued result object, which is returned as an object array whose types are defined by the WSDL.

Method Summary

java.lang.String	getPassword() Returns the optional password used to access the Web service, assuming the Web service is secured.
WebServiceActionPasswordType	getPasswordType() Returns the kind of password used to authenticate a secure Web service.
java.lang.String	getUsername() Returns the optional username used to access the Web service, assuming the web service is secured.
java.net.URL	getWsdl() Returns the WSDL location that defines how the Web service is accessed and used.
boolean	isAddressingEnabled() Indicates whether the WS-Addressing flag on the Web service request is enabled.
void	setAddressingEnabled(boolean enabled) Indicates whether the WS-Addressing flag on the Web service request is enabled.
void	setPassword(java.lang.String password) Sets the optional password used to access the Web service, assuming the Web service is secured.
void	setPasswordType(WebServiceActionPasswordType passwordType) Sets the kind of password used to authenticate a secure Web service.
void	setUsername(java.lang.String username) Sets the optional username used to access the Web service, assuming the Web service is secured.
void	setWsdl(java.net.URL wsdl) Sets the WSDL location that defines how the Web service is accessed and used.

Methods inherited from interface flux.DynamicMethod

getArgument, getArgumentCount, getArgumentType, getListenerSignature, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setArgument, setListenerSignature

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getPassword

java.lang.String getPassword()

Returns the optional password used to access the Web service, assuming the Web service is secured. The returned password is in clear text.

Returns:

The optional password used to access the Web service. The returned password is in clear text. May be null.

getPasswordType

WebServiceActionPasswordType getPasswordType()

Returns the kind of password used to authenticate a secure Web service. Defaults to plain text.

Returns:

The kind of password used to authenticate a secure Web service.

getUsername

java.lang.String getUsername()

Returns the optional username used to access the Web service, assuming the web service is secured.

Returns:

The optional username used to access the Web service.

getWsdl

java.net.URL getWsdl()

Returns the WSDL location that defines how the Web service is accessed and used.

Returns:

The WSDL location that defines how the Web service is accessed and used.

isAddressingEnabled

boolean isAddressingEnabled()

Indicates whether the WS-Addressing flag on the Web service request is enabled. Defaults to false.

Returns:

Whether the WS-Addressing flag on the Web service request is enabled.

setAddressingEnabled

void setAddressingEnabled(boolean enabled)

Indicates whether the WS-Addressing flag on the Web service request is enabled.

Parameters:

enabled - Whether the WS-Addressing flag on the Web service request is enabled.

setPassword

void setPassword(java.lang.String password)

Sets the optional password used to access the Web service, assuming the Web service is secured. The password must be in clear text.

Parameters:

password - The optional password used to access the Web service. The password must be in clear text. May be null.

setPasswordType

void setPasswordType(WebServiceActionPasswordType passwordType)

Sets the kind of password used to authenticate a secure Web service.

Parameters:

passwordType - The kind of password used to authenticate a secure Web service.

Throws:

java.lang.IllegalArgumentException - If passwordType is null.

setUsername

void setUsername(java.lang.String username)

Sets the optional username used to access the Web service, assuming the Web service is secured.

Parameters:

username - The optional username used to access the Web service. May be null.

setWsdl

void setWsdl(java.net.URL wsdl)

Sets the WSDL location that defines how the Web service is accessed and used.

Parameters:

wsdl - The WSDL location that defines how the Web service is accessed and used.