com.goldencode.p2j.util.osresource

Class WebServiceImpl

java.lang.Object

com.goldencode.p2j.util.osresource.WebServiceImpl

All Implemented Interfaces:

SessionListener, WebService

class WebServiceImpl
extends java.lang.Object
implements WebService, SessionListener

Client-side implementation of WebService. P2J delegates all call here so that the 'remote' procedure is called form P2J client-side and benefit from true client network environment (firewall setting, host of request from POV of the machine that hosts the WebService.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	WebServiceImpl.WebServiceData Data structure that is used to store data on client side between calls from P2J server side.
private static class	WebServiceImpl.WorkArea Container for the context-local data.

Field Summary

Fields

Modifier and Type	Field and Description
private static ContextLocal<WebServiceImpl>	instance The single instance available of this class.
private static ContextLocal<WebServiceImpl.WorkArea>	local The context-local data of this class.
private static CentralLogger	LOG Logger
private static java.lang.Object	modToken Token used to authenticate with the dispatcher when registering APIs.
private static org.apache.axiom.soap.SOAPFactory	soapFactory A SOAP factory to create message data.

Fields inherited from interface com.goldencode.p2j.util.osresource.WebService

ERR_BINDING_NOT_IN_WSDL_DOCUMENT, ERR_BINDING_NOT_SUPPORTED, ERR_INVALID_PARAMS_IN_CONNECTION_STRING, ERR_LOADING_WSDL_DOCUMENT, ERR_NO_SERVICE_ERROR, ERR_NO_SERVICE_SPECIFIED, ERR_PORT_NOT_IN_WSDL_DOCUMENT, ERR_SERVICE_AND_PORT_NOT_FOUND, ERR_SERVICE_NOT_IN_WSDL_DOCUMENT, ERR_TARGETNAMESPACE_NOT_MATCH_WDSL

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WebServiceImpl(boolean local) Private c'tor, to not allow explicit usage of this class.

Method Summary

Modifier and Type	Method and Description
private static org.apache.axiom.om.OMElement	buildInputMessage(WebServiceImpl.WebServiceData wsd, javax.wsdl.Operation op, javax.xml.namespace.QName[][] inMsgParams, java.lang.Object[] inputParams) Using the input parameters configured at the operation's input message and the input parameters sent by the caller, create a new XML payload representing the input message passed to the operation call.
private static void	buildSchema(WebServiceImpl.WebServiceData serviceData) If the WebServiceImpl.WebServiceData.xmlSchemas list is not yet build, extract all the schema extensibility elements from the WSDL definition and save them in the WebServiceImpl.WebServiceData.xmlSchemas list.
void	cleanupInvocation(int id) Clears the temporary state of an invocation.
private static java.lang.Object[]	collectParameters(java.lang.String modes, java.lang.Object[] args, boolean input) Search the given parameter modes and return the input or output parameters, based on the input flag.
int	connect(WebServiceConnectOptions options) Validate parameters and establish a new connection using the given options.
boolean	disconnect(int id) Disconnect the web service.
private static java.lang.String	getEnvelopeNameSpaces(org.apache.axis2.client.ServiceClient sc) Build a string containing the SOAP Envelope namespaces in reverse order.
private static <T> T	getExtension(java.util.List<?> extensions, java.lang.Class<T> type) Search the through the list of ExtensibilityElements for one matching the give type.
java.lang.String[]	getHeaderEntries(int id) Get the header entries of the response to last invoked operation on the specified connection.
private static javax.wsdl.Port	getImplicitSoapPort(java.util.Collection<?> ports) Get the implicit port from the given collection of ports.
(package private) static WebServiceImpl	getInstance(boolean local) Retrieve the target instance.
private static javax.xml.namespace.QName[][]	getMessageParameters(javax.wsdl.Message msg, WebServiceImpl.WebServiceData wsd) Resolve the parameters for the given message.
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.
private static java.lang.String	getPortName(java.lang.String portTypeName, javax.wsdl.Definition wsdlDef) Get the WSDL port name we'd like to access.
java.lang.String	getPortTypeName(int id) Get the name of the PortType of the specified connection.
void	initialize(Session session) This callback will be called after the security context has been set up.
boolean	invoke(int id, java.lang.String operationName, java.lang.String portTypeName, java.lang.String requestHeader) Do the actual Web Service invocation.
private static java.lang.String	marshallValue(javax.xml.namespace.QName paramName, javax.xml.namespace.QName paramType, BaseDataType value) Marshall a value from Java/Progress style to SOAP style.
private static Text	mergeNameSpaces(Text res, java.lang.String envns) Merge response namespace with SOAP Envelope namespaces.
private static void	noServicesError() Show a specific 4GL-style error meaning that no service could be resolved from the WSDL document.
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.
private static boolean	processOutputMessage(javax.xml.namespace.QName[][] outMsgParams, java.lang.Object[] outputParams, org.apache.axiom.om.OMElement message) Process the message received after an operation invocation and populate the output parameters sent by the caller accordingly.
private static void	resolveParameters(org.apache.ws.commons.schema.XmlSchemaElement element, javax.xml.namespace.QName name, java.util.List<javax.xml.namespace.QName[]> params) Resolve the parameters from the specified schema element and save them in the params list: on index 0 the name and on index 1 the schema type.
void	terminate(Session session) This method is called when the session is ending.
private static BaseDataType	unmarshallValue(javax.xml.namespace.QName paramName, javax.xml.namespace.QName paramType, org.apache.axiom.om.OMElement param) Unmarshall a value received as a response for an service operation request to a BaseDataType, depending on the parameter's type defined at the operation's output message.
private static boolean	validateParameters(javax.wsdl.Operation op, javax.wsdl.Service service, java.lang.Object[] input, java.lang.Object[] output, int inParams, int outParams) Validate the operation's parameters against the input and output parameters sent by the caller.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

local

private static ContextLocal<WebServiceImpl.WorkArea> local

The context-local data of this class.

modToken

private static java.lang.Object modToken

Token used to authenticate with the dispatcher when registering APIs.

instance

private static final ContextLocal<WebServiceImpl> instance

The single instance available of this class.

soapFactory

private static final org.apache.axiom.soap.SOAPFactory soapFactory

A SOAP factory to create message data.

Constructor Detail

WebServiceImpl

private WebServiceImpl(boolean local)

Private c'tor, to not allow explicit usage of this class. Its intended goal is to be exported as a network server.

Parameters:

local - true to register purely on a local basis (no remote/network access to these methods).

Method Detail

getInstance

static WebServiceImpl getInstance(boolean local)

Retrieve the target instance.

Parameters:

local - true to register purely on a local basis (no remote/network access to these methods).

initialize

public void initialize(Session session)

This callback will be called after the security context has been set up.

Specified by:

initialize in interface SessionListener

Parameters:

session - The session that is starting.

terminate

public void terminate(Session session)

This method is called when the session is ending. We close and cleanup all resources allocated in the current context.

Specified by:

terminate in interface SessionListener

Parameters:

session - The session that is ending.

connect

public int connect(WebServiceConnectOptions options)

Validate parameters and establish a new connection using the given options.

The Web Services are not real connection and no actual connection remains open. Instead, the following actions are taken:

1. use network protocols to acquire the requested WSDL document
2. parses the document and verifies the passed in parameters against the configurations from WSDl document
3. in case of errors ErrorManager is used to report them
4. a new WebServiceImpl.WebServiceData structure is created and populated with validated values and stored in context local data structures. At this moment object is populated only with final information needed for further service invocation. The object is assigned to a unique identifier that will be used from this point forward for accessing this connection. This id is returned in case of success.

The returned id will be used in further references to this connection until the connection is disconnected.

The #CONNECT_OPTION_MAX_CONNECTIONS, #CONNECT_OPTION_CONNECTION_LIFETIME, #CONNECT_OPTION_NO_SESSION_REUSE and #CONNECT_OPTION_NO_HOST_VERIFY options are not supported.

Specified by:

connect in interface WebService

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. In the latter case the error was already reported. Check the ErrorManager for details about any errors.

getPortTypeName

public java.lang.String getPortTypeName(int id)

Get the name of the PortType of the specified connection.

Specified by:

getPortTypeName in interface WebService

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

public boolean disconnect(int id)

Disconnect the web service. If a web service invocation is in progress the internal state if dropped first.

Specified by:

disconnect in interface WebService

Parameters:

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

Returns:

true if no errors were encountered during disconnect.

prepareInvoke

public 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.

Specified by:

prepareInvoke in interface WebService

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 (incorrect operation name, invalid parameters or could not build the request message).

getNamespace

public java.lang.String getNamespace(int id)

Get the wsdl namespace of this connection.

Specified by:

getNamespace in interface WebService

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

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

Get the header entries of the response to last invoked operation on the specified connection.

Specified by:

getHeaderEntries in interface WebService

Parameters:

id - The id of an open connection.

Returns:

the header entries of the specified connection or null if the id is not the identifier of an open and prepared connection or the last response envelope does not contain any headers.

cleanupInvocation

public 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.

Specified by:

cleanupInvocation in interface WebService

Parameters:

id - The id of an open connection.

invoke

public 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.

Specified by:

invoke in interface WebService

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

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

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

Specified by:

getOutputValues in interface WebService

Parameters:

id - The id of an open connection.

Returns:

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

collectParameters

private static java.lang.Object[] collectParameters(java.lang.String modes,
                                                    java.lang.Object[] args,
                                                    boolean input)

Search the given parameter modes and return the input or output parameters, based on the input flag.

The INPUT-OUTPUT will be returned in both cases.

Parameters:

modes - The parameter modes.

args - The passed arguments.

input - On true, collect input parameters; else, collect output parameters.

Returns:

The collected parameters from the args array.

resolveParameters

private static void resolveParameters(org.apache.ws.commons.schema.XmlSchemaElement element,
                                      javax.xml.namespace.QName name,
                                      java.util.List<javax.xml.namespace.QName[]> params)

Resolve the parameters from the specified schema element and save them in the params list: on index 0 the name and on index 1 the schema type.

Parameters:

element - The schema element which needs to be resolved.

name - The name of this element.

params - The list where to save the parameters.

getExtension

private static <T> T getExtension(java.util.List<?> extensions,
                                  java.lang.Class<T> type)

Search the through the list of ExtensibilityElements for one matching the give type.

Parameters:

extensions - The list of extensibility elements.

type - The type to be matched.

Returns:

The found element or null if not found.

getImplicitSoapPort

private static javax.wsdl.Port getImplicitSoapPort(java.util.Collection<?> ports)

Get the implicit port from the given collection of ports. The found Port must be associated with a Binding with a SOAP 1.1. extensibility. If more than one port matches or no port found, return null.

Parameters:

ports - The Port instances to be searched.

Returns:

The found Port following the above rules.

noServicesError

private static void noServicesError()

Show a specific 4GL-style error meaning that no service could be resolved from the WSDL document.

validateParameters

private static boolean validateParameters(javax.wsdl.Operation op,
                                          javax.wsdl.Service service,
                                          java.lang.Object[] input,
                                          java.lang.Object[] output,
                                          int inParams,
                                          int outParams)

Validate the operation's parameters against the input and output parameters sent by the caller.

The rules are:

1. all output parameters must be a BaseDataType;
2. if only one input (or output) parameter is specified, is assumed to be wrapped;
3. if no input (or output) parameters are specified, then the operation must have no input (or output) parameters.

Parameters:

op - The service operation to be invoked.

service - TBA

input - The passed input parameters.

output - The passed output parameters.

inParams - The number of input parameters defined at the operation.

outParams - The number of output parameters defined at the operation.

Returns:

true if the parameters are valid.

buildInputMessage

private static org.apache.axiom.om.OMElement buildInputMessage(WebServiceImpl.WebServiceData wsd,
                                                               javax.wsdl.Operation op,
                                                               javax.xml.namespace.QName[][] inMsgParams,
                                                               java.lang.Object[] inputParams)

Using the input parameters configured at the operation's input message and the input parameters sent by the caller, create a new XML payload representing the input message passed to the operation call.

The caller may not pass null or unknown values. If the caller passes only one input parameter of type Text or String, then it is assumed we are in wrapped mode and the parameter holds the entire XML payload.

Parameters:

wsd - The definition of the WSDL that contains the operation.

op - The operation to be invoked.

inMsgParams - The (name, type) mappings of each parameter, defined at the operation's input.

inputParams - The input parameters sent by the caller.

Returns:

A new OMElement structure with the XML payload for the input message.

marshallValue

private static java.lang.String marshallValue(javax.xml.namespace.QName paramName,
                                              javax.xml.namespace.QName paramType,
                                              BaseDataType value)

Marshall a value from Java/Progress style to SOAP style. This will also validate the input value with the parameter's type defined at the schema.

See the "Table 3-2: Supported XML data types" from OpenEdge(R) Development: Web Services, page 3-15.

Parameters:

paramName - The parameter's name, as defined at the SOAP message.

paramType - The parameter's type, as defined at the schema.

value - The JAva or Progress-style value to be converted.

Returns:

The string representation of this value. The method does the best effort to convert to a string representation of XSD parameter type. The last resort being BaseDataType.toStringMessage() method.

unmarshallValue

private static BaseDataType unmarshallValue(javax.xml.namespace.QName paramName,
                                            javax.xml.namespace.QName paramType,
                                            org.apache.axiom.om.OMElement param)

Unmarshall a value received as a response for an service operation request to a BaseDataType, depending on the parameter's type defined at the operation's output message. This will also validate the value with the parameter's type defined at the schema.

See the "Table 3-2: Supported XML data types" from OpenEdge(R) Development: Web Services, page 3-15.

Parameters:

paramName - The parameter's name, as defined at the SOAP message.

paramType - The parameter's type, as defined at the schema.

param - The response received after an operation invocation.

Returns:

A BaseDataType instance for the received parameter or null if conversion is not possible.

processOutputMessage

private static boolean processOutputMessage(javax.xml.namespace.QName[][] outMsgParams,
                                            java.lang.Object[] outputParams,
                                            org.apache.axiom.om.OMElement message)

Process the message received after an operation invocation and populate the output parameters sent by the caller accordingly.

If the caller passes only one input parameter of type Text, then it is assumed we are in wrapped mode and that parameter will hold the entire XML payload for the received message, serialized as string.

Parameters:

outMsgParams - The (name, type) mappings of each parameter, defined at the operation's output.

outputParams - The output parameters sent by the caller; each element is a BaseDataType.

message - The message received after the operation invocation.

Returns:

true if message processed or false if there were problems during conversion of the received to their BaseDataType expected type.

getPortName

private static java.lang.String getPortName(java.lang.String portTypeName,
                                            javax.wsdl.Definition wsdlDef)

Get the WSDL port name we'd like to access. Check if portTypeName is in the list of WSDL ports. If true the portTypeName is equals to port name and could be used for bindings. If false return null and let service to choose the appropriate SOAP port.

Parameters:

portTypeName - port type name.

wsdlDef - The definition of the WSDL that contains the port type.

Returns:

name of the WSDL port we'd like to access.

getMessageParameters

private static javax.xml.namespace.QName[][] getMessageParameters(javax.wsdl.Message msg,
                                                                  WebServiceImpl.WebServiceData wsd)

Resolve the parameters for the given message.

Parameters:

msg - The message.

wsd - A WebServiceData structure that contains information about schemas and parameters.

Returns:

An array where, for each element, on index 0 is the parameter's name and on index 1 is the parameter's type.

buildSchema

private static void buildSchema(WebServiceImpl.WebServiceData serviceData)

If the WebServiceImpl.WebServiceData.xmlSchemas list is not yet build, extract all the schema extensibility elements from the WSDL definition and save them in the WebServiceImpl.WebServiceData.xmlSchemas list.

Parameters:

serviceData - The structure that contains information about the current connection and where the schema will be stored.

getEnvelopeNameSpaces

private static java.lang.String getEnvelopeNameSpaces(org.apache.axis2.client.ServiceClient sc)
                                               throws org.apache.axis2.AxisFault

Build a string containing the SOAP Envelope namespaces in reverse order.

Parameters:

sc - ServiceClient instance.

Returns:

SOAP Envelope namespaces serialized as as string.

Throws:

org.apache.axis2.AxisFault - In case of errors.

mergeNameSpaces

private static Text mergeNameSpaces(Text res,
                                    java.lang.String envns)

Merge response namespace with SOAP Envelope namespaces.

Parameters:

res - Response string in XML format.

envns - A string containing serialized SOAP Envelope namespaces

Returns:

Response merged with SOAP Envelope namespaces