oracle.webservices

Interface OracleCall

All Superinterfaces:

javax.xml.rpc.Call, ClientConstants

public interface OracleCall
extends javax.xml.rpc.Call, ClientConstants

This is Oracle's dynamic invocation call interface that extends the javax.xml.rpc.Call interface with additional API's.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENDPOINT_ADDRESS_PROPERTY A property to set the endpoint address on the Call object instance.

Fields inherited from interface javax.xml.rpc.Call

ENCODINGSTYLE_URI_PROPERTY, OPERATION_STYLE_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY

Fields inherited from interface oracle.webservices.ClientConstants

ACCEPT_ENCODING, ALL_OPERATIONS_ONE_WAY, CHARACTER_SET_ENCODING, CHUNK_SIZE, CLIENT_CONFIG, ContentNegotiation, COOKIE_MAP, DIME_ENCODE_MESSAGES_WITH_ATTACHMENTS, DISABLE_MUST_UNDERSTAND, DO_NOT_CHUNK, HTTP_CONN_TIMEOUT, HTTP_OPNAME_QUERYSTRING_PARAM, HTTP_READ_TIMEOUT, JAXRPC_STUB_INSTANCE, JMS_TARGET_CORRELATION_ID, JMS_TARGET_MESSAGE_ID, JMS_TARGET_REPLY_TO_FACTORY_NAME, JMS_TARGET_REPLY_TO_QUEUE_NAME, JMS_TARGET_REPLY_TO_TOPIC_NAME, JMS_TRANSPORT_REPLY_TO_FACTORY_NAME, JMS_TRANSPORT_REPLY_TO_QUEUE_NAME, MTOM_DOTNET_HEADER_STYLE, MTOM_SUPPORT, POLICY_SUBJECT_RESOURCE_PATTERN, PREEMPTIVE_BASIC_AUTH, PROVIDER_MSG_CONTEXT_PROPS, PROXY_AUTH_TYPE, PROXY_HOST, PROXY_PASSWORD, PROXY_PORT, PROXY_REALM, PROXY_USERNAME, SERVICEIMPL_NAME, SOAP_VERSION, SOAP_XML_RESPONSE, STREAMING_INCOMING_ATTACHMENTS, STREAMING_OUTGOING_ATTACHMENTS, TRANSACTIONAL, TRUST_MANAGER_ARRAY, WALLET_KEYSTORE_PROVIDER, WALLET_KEYSTORE_TYPE, WALLET_LOCATION, WALLET_PASSWORD, WS_SSL_KEY_ALIAS, WS_SSL_KEYSTORE_LOCATION, WS_SSL_KEYSTORE_TYPE, WS_SSL_TRUSTSTORE_LOCATION, WS_SSL_TRUSTSTORE_TYPE, WSA_ACTION, WSA_FAULT_TO, WSA_MESSAGE_ID, WSA_RELATES_TO, WSA_REPLY_TO, WSDL_DEFINITION, WSM_INTERCEPTOR_PIPELINE_CONFIG, WSM_SUBJECT_PRECEDENCE, WSSEC_ENC_KEY_ALIAS, WSSEC_ENC_KEY_PASSWORD, WSSEC_KERBEROS_SERVICE_PRINCIPAL, WSSEC_KEYSTORE_LOCATION, WSSEC_KEYSTORE_PASSWORD, WSSEC_KEYSTORE_TYPE, WSSEC_RECIPIENT_KEY_ALIAS, WSSEC_SAML_ISSUER_NAME, WSSEC_SIG_KEY_ALIAS, WSSEC_SIG_KEY_PASSWORD

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttachment(javax.activation.DataHandler dataHandler, java.lang.String contentEncoding, java.lang.String contentID) Add an attachment to the SOAPMessage in a DII call.
void	addHeader(org.w3c.dom.Element header) Add a header which should be inserted into each outgoing message we generate.
void	destroy() Destroys the call and releases any resouces that may be held by it.
ClientTransport	getClientTransport() Gets the ClientTransport object representing the transport mechanism that will be used to send and receive soap messages.
java.util.Vector	getHeaders() Get the headers that were added with the above method.
javax.xml.namespace.QName	getPortName() Get the QName of the port that the call will be made to.
java.util.Iterator	getResponseAttachmentsIterator() Get an iterator of repsonse attachments.
java.util.Vector	getResponseHeaders() Get the headers in SOAP response Note: Not part of JAX-RPC specification.
Attachments	getStreamedResponseAttachments() Deprecated.
org.w3c.dom.Element	invoke(org.w3c.dom.Element req) Invokes a specific operation using a synchronous request-response interaction mode.
org.w3c.dom.Element	invoke(javax.xml.namespace.QName operationName, org.w3c.dom.Element[] messageParts) Invokes a specific operation using a synchronous request-response interaction mode.
javax.xml.soap.SOAPMessage	invoke(javax.xml.soap.SOAPMessage req) Invokes a specific operation using a synchronous request-response interaction mode.
void	invokeOneWay(org.w3c.dom.Element req) Invokes a remote method using the one-way interaction mode.
void	invokeOneWay(javax.xml.namespace.QName operationName, org.w3c.dom.Element[] messageParts) Invokes a remote method using the one-way interaction mode.
void	invokeOneWay(javax.xml.soap.SOAPMessage req) Invokes a remote method using the one-way interaction mode.
void	setClientTransportFactory(ClientTransportFactory clientTransportFactory) Sets the ClientTransportFactory that will be used to create ClientTransport objects to send and receive SOAP messages.
void	setKeepSocketAlive(boolean keepAlive) Sets the HTTP socket keep-alive flag.
void	setPortName(javax.xml.namespace.QName name) Set the QName of the port that the call will be made to.
void	setRequestAttachmentsIterator(java.util.Iterator iterator) Set an iterator of StreamedAttachments to send with the request.
void	setStreamResponseAttachments(boolean stream) Enable/disable streaming of response attachment.
void	streamResponseAttachment() Deprecated.

Methods inherited from interface javax.xml.rpc.Call

addParameter, addParameter, getOperationName, getOutputParams, getOutputValues, getParameterTypeByName, getPortTypeName, getProperty, getPropertyNames, getReturnType, getTargetEndpointAddress, invoke, invoke, invokeOneWay, isParameterAndReturnSpecRequired, removeAllParameters, removeProperty, setOperationName, setPortTypeName, setProperty, setReturnType, setReturnType, setTargetEndpointAddress

Field Detail

ENDPOINT_ADDRESS_PROPERTY

static final java.lang.String ENDPOINT_ADDRESS_PROPERTY

A property to set the endpoint address on the Call object instance.

Type: java.lang.String

See Also:

Constant Field Values

Method Detail

getPortName

javax.xml.namespace.QName getPortName()

Get the QName of the port that the call will be made to.

Returns:

QName of webservice port

setPortName

void setPortName(javax.xml.namespace.QName name)

Set the QName of the port that the call will be made to.

Parameters:

name - QName of the webservice port

getClientTransport

ClientTransport getClientTransport()

Gets the ClientTransport object representing the transport mechanism that will be used to send and receive soap messages.

Returns:

The ClientTransport set on this Call

invokeOneWay

void invokeOneWay(org.w3c.dom.Element req)

Invokes a remote method using the one-way interaction mode. The client thread does not block waiting for the completion of the server processing for this remote method invocation. This method must not throw any remote exceptions. This method may throw a JAXRPCException during the processing of the one-way remote call.

Methods suchs as addParameter, setOperationName, setReturnType etc. are ignored if set as they don't apply here.

Parameters:

req - - This element is stuffed into the SOAP Body as-is without any wrapping and dispatched to the destination

Throws:

javax.xml.rpc.JAXRPCException - if there is an error in the configuration of the Call object (example: a non-void return type has been incorrectly specified for the one-way call) or if there is any error during the invocation of the one-way remote call

invoke

org.w3c.dom.Element invoke(org.w3c.dom.Element req)
                           throws java.rmi.RemoteException

Invokes a specific operation using a synchronous request-response interaction mode.

Methods suchs as addParameter, setOperationName, setReturnType etc. are ignored if set as they don't apply here.

Parameters:

req - Element - This element is stuffed into the SOAP Body as-is without any wrapping and dispatched to the destination

Returns:

Return value as a Element or null

Throws:

java.rmi.RemoteException - if there is any error in the remote method invocation.

javax.xml.rpc.soap.SOAPFaultException - Indicates a SOAP fault

javax.xml.rpc.JAXRPCException - If there is an error in the configuration of the Call object

invokeOneWay

void invokeOneWay(javax.xml.namespace.QName operationName,
                org.w3c.dom.Element[] messageParts)

Invokes a remote method using the one-way interaction mode. The client thread does not block waiting for the completion of the server processing for this remote method invocation. This method must not throw any remote exceptions. This method may throw a javax.xml.rpc.JAXRPCException during the processing of the one-way remote call.

Methods suchs as addParameter, setOperationName, setReturnType etc. are ignored if set as they don't apply here.

Parameters:

operationName - QName of the operation

messageParts - Element[] - The child elements are stuffed into the SOAP Body within a wrapper and dispatched to the destination. The wrapper name is same as the operation name identified by operationName parameter.

Throws:

javax.xml.rpc.JAXRPCException - if there is an error in the configuration of the Call object (example: a non-void return type has been incorrectly specified for the one-way call) or if there is any error during the invocation of the one-way remote call

invoke

org.w3c.dom.Element invoke(javax.xml.namespace.QName operationName,
                         org.w3c.dom.Element[] messageParts)
                           throws java.rmi.RemoteException

Invokes a specific operation using a synchronous request-response interaction mode.

Methods suchs as addParameter, setOperationName, setReturnType etc. are ignored if set as they don't apply here.

Parameters:

operationName - QName of the operation

messageParts - Element[] - The child elements are stuffed into the SOAP Body within a wrapper and dispatched to the destination. The wrapper name is same as the operation name identified by operationName parameter

Returns:

Return value as a Element or null

Throws:

java.rmi.RemoteException - if there is any error in the remote method invocation.

javax.xml.rpc.soap.SOAPFaultException - Indicates a SOAP fault

javax.xml.rpc.JAXRPCException - If there is an error in the configuration of the Call object

invokeOneWay

void invokeOneWay(javax.xml.soap.SOAPMessage req)

Invokes a remote method using the one-way interaction mode. The client thread does not block waiting for the completion of the server processing for this remote method invocation. This method must not throw any remote exceptions. This method may throw a JAXRPCException during the processing of the one-way remote call.

Methods suchs as addParameter, setOperationName, setReturnType etc. are ignored if set as they don't apply here.

Parameters:

req - The SOAPMessage that is passed on as-is without any wrapping and dispatched to the destination

Throws:

javax.xml.rpc.JAXRPCException - if there is an error in the configuration of the Call object (example: a non-void return type has been incorrectly specified for the one-way call) or if there is any error during the invocation of the one-way remote call

invoke

javax.xml.soap.SOAPMessage invoke(javax.xml.soap.SOAPMessage req)
                                  throws java.rmi.RemoteException

Invokes a specific operation using a synchronous request-response interaction mode.

Methods suchs as addParameter, setOperationName, setReturnType etc. are ignored if set as they don't apply here.

Parameters:

req - The SOAPMessage that is passed on as-is without any wrapping and dispatched to the destination

Returns:

Return value as a SOAPMessage or null

Throws:

java.rmi.RemoteException - if there is any error in the remote method invocation.

javax.xml.rpc.soap.SOAPFaultException - Indicates a SOAP fault

javax.xml.rpc.JAXRPCException - If there is an error in the configuration of the Call object

setClientTransportFactory

void setClientTransportFactory(ClientTransportFactory clientTransportFactory)

Sets the ClientTransportFactory that will be used to create ClientTransport objects to send and receive SOAP messages.

Parameters:

clientTransportFactory - The ClientTransportFactory to be set

addHeader

void addHeader(org.w3c.dom.Element header)

Add a header which should be inserted into each outgoing message we generate. This was added as part of BPEL integration requirement. Note: Not part of JAX-RPC specification.

Parameters:

header - a DOM Element to be inserted into messages

getHeaders

java.util.Vector getHeaders()

Get the headers that were added with the above method. Note: Not part of JAX-RPC specification.

Returns:

Returns the headers in a Vector

getResponseHeaders

java.util.Vector getResponseHeaders()

Get the headers in SOAP response Note: Not part of JAX-RPC specification.

Returns:

Returns the SOAP response headers in a Vector, null if no header

addAttachment

void addAttachment(javax.activation.DataHandler dataHandler,
                 java.lang.String contentEncoding,
                 java.lang.String contentID)

Add an attachment to the SOAPMessage in a DII call. It is best to use this API when adding a binary attachment such as jpeg or Word document.

Parameters:

dataHandler - The DataHandler object created with the attachment.

contentEncoding - Content transfer encoding of the attachment MIME part, i.e. BASE64. This argument can be null, in which case the attachment will not be encoded.

contentID - Content ID of the attachment MIME part. This argument can be null, in which case the Content-ID header of the attachment MIME part will be absent.

Throws:

java.lang.IllegalArgumentException - if dataHandler is null.

setKeepSocketAlive

void setKeepSocketAlive(boolean keepAlive)

Sets the HTTP socket keep-alive flag. By default it's on, but there are use cases such as BPEL invocations that want the sockets closed after the invocation.

streamResponseAttachment

void streamResponseAttachment()

Deprecated.

Enables streaming of response attachment. By default it is off.

setStreamResponseAttachments

void setStreamResponseAttachments(boolean stream)

Enable/disable streaming of response attachment. By default it is off.

getStreamedResponseAttachments

Attachments getStreamedResponseAttachments()

Deprecated.

Returns the streamed attachments in response

Returns:

Streamed attachments in response

getResponseAttachmentsIterator

java.util.Iterator getResponseAttachmentsIterator()

Get an iterator of repsonse attachments. The iterator will return values of type: oracle.j2ee.ws.saaj.soap.StreamedAttachment

Returns:

The attachment iterator

setRequestAttachmentsIterator

void setRequestAttachmentsIterator(java.util.Iterator iterator)

Set an iterator of StreamedAttachments to send with the request.

Parameters:

iterator -

destroy

void destroy()

Destroys the call and releases any resouces that may be held by it.