org.jboss.wise.core.client

Interface WSMethod

All Known Implementing Classes:

WSMethodImpl

@ThreadSafe
public interface WSMethod

It Represents a webservice operation(action) invocation and it always refer to a specific endpoint.

Since:

23-Aug-2007

Author:

stefano.maestri@javalinux.it

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESULT
static String	RESULTS
static String	TYPE_PREFIX

Method Summary

Methods

Modifier and Type	Method and Description
WSEndpoint	getEndpoint()
Map<String,? extends WebParameter>	getWebParams() Gets the map of WebParameter for the webserice method represented by instance of this type
InvocationResult	invoke(Object args) Invokes this method with the provided arguments
InvocationResult	invoke(Object args, WiseMapper mapper) Invokes this method with the provided arguments applying provided mapper
boolean	isOneWay()
void	writeRequestPreview(Map<String,Object> args, OutputStream os) Generates and writes a preview of the request message for invoking this method with the provided arguments.

Field Detail

RESULT

static final String RESULT

See Also:

Constant Field Values

RESULTS

static final String RESULTS

See Also:

Constant Field Values

TYPE_PREFIX

static final String TYPE_PREFIX

See Also:

Constant Field Values

Method Detail

invoke

InvocationResult invoke(Object args,
                      WiseMapper mapper)
                        throws InvocationException,
                               IllegalArgumentException,
                               MappingException

Invokes this method with the provided arguments applying provided mapper

Parameters:

args - the arguments to call operation. It could be a generic Object to be passed to provided mapper. If mapper is null it works exactly like invoke(Object)

mapper - if null no mappings are applied method will be invoked using args directly. in this case the keys of the map gotta be the parameters names as defined in wsdl/wsconsume generated classes

Returns:

return an InvocationResult object populated with returned values (implementation will process both directed returned values and OUT parameters as defined in wsdl)

Throws:

InvocationException

IllegalArgumentException

MappingException

invoke

InvocationResult invoke(Object args)
                        throws InvocationException,
                               IllegalArgumentException,
                               MappingException

Invokes this method with the provided arguments

Parameters:

args - the arguments to call operation. args must be a Map. This Map have to contain entries for all needed parameters, keys have to reflect operation parameter name as defined in wsdl. Keys which names are not defined in wsdls will be simply ignored. Implementation will take care values nullability will reflect "nillable" properties defined in wsdl. order isn't important since WSMethod implementation will take care of reorder parameters in right position to make operation call. If it isn't a Map or keys don't contain all parameters name an IllegalArgumentException is thrown.

Returns:

return an InvocationResult object populated with returned values (implementation will process both directed returned values and OUT parameters as defined in wsdl)

Throws:

InvocationException

IllegalArgumentException

MappingException

writeRequestPreview

void writeRequestPreview(Map<String,Object> args,
                       OutputStream os)
                         throws InvocationException

Generates and writes a preview of the request message for invoking this method with the provided arguments.

Parameters:

args -

os -

Throws:

InvocationException

getWebParams

Map<String,? extends WebParameter> getWebParams()

Gets the map of WebParameter for the webserice method represented by instance of this type

Returns:

a Map representing valid webparameters where keys contain symbolic names as defined by wsdl. It may be null in case of selected operation haven't parameter.

isOneWay

boolean isOneWay()

Returns:

true if operation is defined as OneWay in wsdl

getEndpoint

WSEndpoint getEndpoint()

Returns:

the endpoint on which this method is attached.