com.goldencode.p2j.util.osresource

Interface WebService

All Known Implementing Classes:

WebServiceImpl

public interface WebService

Interface defining APIs to connect and invoke Web Services in P2J. This interface is exported as a service during P2J client startup.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERR_BINDING_NOT_IN_WSDL_DOCUMENT Error code.
static int	ERR_BINDING_NOT_SUPPORTED Error code.
static int	ERR_INVALID_PARAMS_IN_CONNECTION_STRING Error code.
static int	ERR_LOADING_WSDL_DOCUMENT Error code.
static int	ERR_NO_SERVICE_ERROR Error code.
static int	ERR_NO_SERVICE_SPECIFIED Error code.
static int	ERR_PORT_NOT_IN_WSDL_DOCUMENT Error code.
static int	ERR_SERVICE_AND_PORT_NOT_FOUND Error code.
static int	ERR_SERVICE_NOT_IN_WSDL_DOCUMENT Error code.
static int	ERR_TARGETNAMESPACE_NOT_MATCH_WDSL Error code.

Method Summary

Modifier and Type	Method and Description
void	cleanupInvocation(int id) Clears the temporary state of an invocation.
int	connect(WebServiceConnectOptions options) Validate parameters and establish a new connection using the given options.
boolean	disconnect(int id) Disconnect the web service.
java.lang.String[]	getHeaderEntries(int id) Get the header entries of an already open and prepared connection.
java.lang.String	getNamespace(int id) Get the wsdl namespace of this connection.
java.lang.Object[]	getOutputValues(int id) Obtain the values of output parameters after a successful Web Service invocation.
java.lang.String	getPortTypeName(int id) Get the name of the PortType of the specified connection.
boolean	invoke(int id, java.lang.String operationName, java.lang.String portTypeName, java.lang.String requestHeader) Do the actual Web Service invocation.
boolean	prepareInvoke(int id, java.lang.String portTypeName, java.lang.String operationName, java.lang.String modes, java.lang.Object... args) Prepare the connection for an invocation of an operation on the Web Service.

Field Detail

ERR_LOADING_WSDL_DOCUMENT

static final int ERR_LOADING_WSDL_DOCUMENT

Error code. Specified WSDL document failed to load.

See Also:

Constant Field Values

ERR_INVALID_PARAMS_IN_CONNECTION_STRING

static final int ERR_INVALID_PARAMS_IN_CONNECTION_STRING

Error code. Parameters specified in connection string failed validation.

See Also:

Constant Field Values

ERR_SERVICE_NOT_IN_WSDL_DOCUMENT

static final int ERR_SERVICE_NOT_IN_WSDL_DOCUMENT

Error code. The Service is not in the WSDL document.

See Also:

Constant Field Values

ERR_NO_SERVICE_ERROR

static final int ERR_NO_SERVICE_ERROR

Error code. No service.

See Also:

Constant Field Values

ERR_PORT_NOT_IN_WSDL_DOCUMENT

static final int ERR_PORT_NOT_IN_WSDL_DOCUMENT

Error code. The Port is not in the WSDL document.

See Also:

Constant Field Values

ERR_BINDING_NOT_SUPPORTED

static final int ERR_BINDING_NOT_SUPPORTED

Error code. The Binding is not supported, it must be a SOAP 1.1 binding.

See Also:

Constant Field Values

ERR_BINDING_NOT_IN_WSDL_DOCUMENT

static final int ERR_BINDING_NOT_IN_WSDL_DOCUMENT

Error code. The Binding cannot be found in the WSDL document.

See Also:

Constant Field Values

ERR_SERVICE_AND_PORT_NOT_FOUND

static final int ERR_SERVICE_AND_PORT_NOT_FOUND

Error code. Internal error locating Service and Port for Binding.

See Also:

Constant Field Values

ERR_NO_SERVICE_SPECIFIED

static final int ERR_NO_SERVICE_SPECIFIED

Error code. A specific Service name must be specified from the WSDL document.

See Also:

Constant Field Values

ERR_TARGETNAMESPACE_NOT_MATCH_WDSL

static final int ERR_TARGETNAMESPACE_NOT_MATCH_WDSL

Error code. The TargetNamespace option does not match the WSDL's target namespace.

See Also:

Constant Field Values

Method Detail

connect

int connect(WebServiceConnectOptions options)

Validate parameters and establish a new connection using the given options. The returned id will be used in further references to this connection until the connection is disconnected.

Parameters:

options - A collection of all parameters used for this connection.

Returns:

A positive (possible 0) integer representing the id of this connection to web-service server and a negative value representing an error code if any error occurred during validation and initialization of this connection.

getPortTypeName

java.lang.String getPortTypeName(int id)

Get the name of the PortType of the specified connection.

Parameters:

id - The id of the connection.

Returns:

the name of the PortType of specified connection or empty string if there is no connection with requested id.

disconnect

boolean disconnect(int id)

Disconnect the web service.

Parameters:

id - The ID of the associated web service on P2J Client side.

Returns:

true if no errors were encountered during disconnect.

cleanupInvocation

void cleanupInvocation(int id)

Clears the temporary state of an invocation. Does not close open connections. It is called when the result of the invocation was obtained on server side or when an error occurred. If id is invalid nothing happens.

Parameters:

id - The id of an open connection.

prepareInvoke

boolean prepareInvoke(int id,
                      java.lang.String portTypeName,
                      java.lang.String operationName,
                      java.lang.String modes,
                      java.lang.Object... args)

Prepare the connection for an invocation of an operation on the Web Service. The parameters are validated and, on success, the internal state of the call is temporarily saved.

Parameters:

id - The id of an open connection.

portTypeName - The name of the port type to be invoked.

operationName - The name of the operation to be invoked on the Web Service.

modes - A string representation of the modes of each parameter. May not be null.

args - The operation's arguments.

Returns:

true if validation was successful and false if some errors occurred and invocation is not available.

invoke

boolean invoke(int id,
               java.lang.String operationName,
               java.lang.String portTypeName,
               java.lang.String requestHeader)

Do the actual Web Service invocation. The call uses an already open and prepared connection identified by id.

Parameters:

id - The id of an open connection.

operationName - The name of the operation to be invoked on the Web Service.

portTypeName - The name of the port type to be invoked.

requestHeader - The request header if any was obtained form a call to a configured header callback.

Returns:

true if the service operation was successful and false if id does not represent a valid connection or other error occurred.

getOutputValues

java.lang.Object[] getOutputValues(int id)

Obtain the values of output parameters after a successful Web Service invocation.

Parameters:

id - The id of an open connection.

Returns:

An array with output values returned by the last web service operation.

getNamespace

java.lang.String getNamespace(int id)

Get the wsdl namespace of this connection.

Parameters:

id - The id of an open connection.

Returns:

the wsdl namespace of this connection or null if id does not represent the identifier of a valid open connection.

getHeaderEntries

java.lang.String[] getHeaderEntries(int id)

Get the header entries of an already open and prepared connection.

Parameters:

id - The id of an open connection.

Returns:

the header entries of the specified connection ot null if the id is not the identifier of an open and prepared connection.