oracle.webservices

Class OracleService

java.lang.Object

javax.xml.ws.Service

oracle.webservices.OracleService

public class OracleService
extends javax.xml.ws.Service

This class adds Oracle implementation specific features to the standard jaxws javax.xml.ws.Service class.

Additional features include

- Creating a Service using a javax.wsdl.Definition to avoid parsing wsdl documents more than once.

- Creating an instance of a javax.xml.ws.Dispatch without a WSDL.

- Allowing a user to set HTTP connection properties to used when fetching a wsdl.

Nested Class Summary

Nested classes/interfaces inherited from class javax.xml.ws.Service

javax.xml.ws.Service.Mode

Constructor Summary

Constructors

Constructor and Description
OracleService(java.net.URL wsdlDocumentLocation, javax.xml.namespace.QName serviceName) The standard constructor for an OracleService
OracleService(java.net.URL wsdlDocumentLocation, javax.xml.namespace.QName serviceName, javax.wsdl.Definition definition, oracle.webservices.ConnectionConfig connectionConfig) The constructor for an Oracle Service

Method Summary

Methods

Modifier and Type	Method and Description
static <T> javax.xml.ws.Dispatch<T>	copyDispatch(javax.xml.ws.Dispatch<T> dispatch) This method copies all thread safe dispatch properties to a new instance of dispatch.
static <T> javax.xml.ws.Dispatch<T>	createDispatch(java.util.Map<java.lang.String,java.lang.Object> requestContext, java.lang.Class<T> type, javax.xml.ws.Service.Mode mode) Create a dispatch object without a wsdl document.
static javax.xml.ws.Dispatch<javax.xml.soap.SOAPMessage>	createDispatch(javax.xml.namespace.QName serviceName, javax.xml.namespace.QName portName, java.lang.String endpointAddress) Creates an instance of Dispatch<SOAPMessage> thru ServiceDelegateImpl
static javax.xml.ws.Dispatch<javax.xml.soap.SOAPMessage>	createDispatch(javax.xml.namespace.QName serviceName, javax.xml.namespace.QName portName, java.lang.String endpointAddress, boolean soap11) Creates an instance of Dispatch<SOAPMessage> thru ServiceDelegateImpl
static <T> javax.xml.ws.Dispatch<T>	createDispatch(javax.xml.namespace.QName serviceName, javax.xml.namespace.QName portName, java.lang.String endpointAddress, java.lang.String soapBindingId, java.lang.Class<T> type, javax.xml.ws.Service.Mode mode) Creates an instance of Dispatch<SOAPMessage> thru ServiceDelegateImpl
static javax.xml.ws.Dispatch<javax.xml.soap.SOAPMessage>	createDispatch(java.lang.String endpointAddress) Creates an instance of Dispatch<SOAPMessage> without a wsdl document.
oracle.webservices.ConnectionConfig	getConnectionConfig() The connection configuration for this service.
javax.wsdl.Definition	getDefinition() The wsdl definition associated with this service.

Methods inherited from class javax.xml.ws.Service

addPort, create, create, create, create, createDispatch, createDispatch, createDispatch, createDispatch, createDispatch, createDispatch, getExecutor, getHandlerResolver, getPort, getPort, getPort, getPort, getPort, getPorts, getServiceName, getWSDLDocumentLocation, setExecutor, setHandlerResolver

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleService

public OracleService(java.net.URL wsdlDocumentLocation,
             javax.xml.namespace.QName serviceName)

The standard constructor for an OracleService

Parameters:

wsdlDocumentLocation - The location of the wsdl document.

serviceName - A service name in the wsdl document.

OracleService

public OracleService(java.net.URL wsdlDocumentLocation,
             javax.xml.namespace.QName serviceName,
             javax.wsdl.Definition definition,
             oracle.webservices.ConnectionConfig connectionConfig)

The constructor for an Oracle Service

Parameters:

wsdlDocumentLocation - The location of the wsdl document.

serviceName - A service name in the wsdl document, if null the first service in the wsdl will be used.

definition - The definition for the wsdl document, if null then the wsdlDocumentLocation will be used to create a definition, if not null then the wsdl document location will not be parsed.

connectionConfig - The connection configuration used when creating the a definition from the wsdlDocumentLocation. This parameter can be null.

Method Detail

createDispatch

public static <T> javax.xml.ws.Dispatch<T> createDispatch(java.util.Map<java.lang.String,java.lang.Object> requestContext,
                                          java.lang.Class<T> type,
                                          javax.xml.ws.Service.Mode mode)

Create a dispatch object without a wsdl document.

Parameters:

requestContext - A map of properties to use for this dispatch object. A property with the name of BindingProvider.ENDPOINT_ADDRESS_PROPERTY must be set in the request context before calling any of the invoke methods on the returned Dispatch instance.

type - The type used for messages, supported types include javax.xml.transform.Source and javax.xml.soap.SOAPMessage

mode - The orientation of the dispatch. MESSAGE provides access to the entire protocol message, PAYLOAD to protocol message payload only.

Returns:

An instance of Dispatch

createDispatch

public static javax.xml.ws.Dispatch<javax.xml.soap.SOAPMessage> createDispatch(java.lang.String endpointAddress)

Creates an instance of Dispatch<SOAPMessage> without a wsdl document.

Parameters:

endpointAddress - The endpoint address of the service for example, http://host/ws/service

Returns:

An instance of Dispatch<SOAPMessage> with a javax.xml.ws.Service.Mode of MESSAGE

createDispatch

public static javax.xml.ws.Dispatch<javax.xml.soap.SOAPMessage> createDispatch(javax.xml.namespace.QName serviceName,
                                                               javax.xml.namespace.QName portName,
                                                               java.lang.String endpointAddress)

Creates an instance of Dispatch<SOAPMessage> thru ServiceDelegateImpl

Parameters:

serviceName - The service QName to create ServiceDelegateImpl

portName - The port QName to create dispatch

endpointAddress - The service endpointAddress

Returns:

An instance of Dispatch<SOAPMessage> with a javax.xml.ws.Service.Mode of MESSAGE

createDispatch

public static javax.xml.ws.Dispatch<javax.xml.soap.SOAPMessage> createDispatch(javax.xml.namespace.QName serviceName,
                                                               javax.xml.namespace.QName portName,
                                                               java.lang.String endpointAddress,
                                                               boolean soap11)

Creates an instance of Dispatch<SOAPMessage> thru ServiceDelegateImpl

Parameters:

serviceName - The service QName to create ServiceDelegateImpl

portName - The port QName to create dispatch

endpointAddress - The service endpointAddress

soap11 - The flag true for SOAPBinding.SOAP11HTTP_BINDING or SOAPBinding.SOAP12HTTP_BINDING

Returns:

An instance of Dispatch<SOAPMessage> with a javax.xml.ws.Service.Mode of MESSAGE

createDispatch

public static <T> javax.xml.ws.Dispatch<T> createDispatch(javax.xml.namespace.QName serviceName,
                                          javax.xml.namespace.QName portName,
                                          java.lang.String endpointAddress,
                                          java.lang.String soapBindingId,
                                          java.lang.Class<T> type,
                                          javax.xml.ws.Service.Mode mode)

Creates an instance of Dispatch<SOAPMessage> thru ServiceDelegateImpl

Parameters:

serviceName - The service QName to create ServiceDelegateImpl

portName - The port QName to create dispatch

endpointAddress - The service endpointAddress

type - The type used for messages, supported types include javax.xml.transform.Source and javax.xml.soap.SOAPMessage

mode - The orientation of the dispatch. MESSAGE provides

Returns:

An instance of Dispatch<T> with a javax.xml.ws.Service.Mode of MESSAGE

copyDispatch

public static <T> javax.xml.ws.Dispatch<T> copyDispatch(javax.xml.ws.Dispatch<T> dispatch)
                                             throws javax.xml.ws.WebServiceException

This method copies all thread safe dispatch properties to a new instance of dispatch.

Parameters:

dispatch - The dispatch to copy from.

Returns:

A new dispatch object with the same properties as the one specified.

Throws:

javax.xml.ws.WebServiceException - if the dispatch parameter was not created from the oracle implementation of jaxws.

getDefinition

public javax.wsdl.Definition getDefinition()

The wsdl definition associated with this service.

Returns:

The wsdl definition associated with this service.

getConnectionConfig

public oracle.webservices.ConnectionConfig getConnectionConfig()

The connection configuration for this service.

Returns:

The connection configuration for this service. This value may be null.