Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-01

oracle.adfnmc.dc.ws
Class WebServiceTransportLayer

java.lang.Object
  extended by oracle.adfnmc.dc.JavaBeanOperation
      extended by oracle.adfnmc.dc.ws.WebServiceTransportLayer
All Implemented Interfaces:
OperationDelegate
Direct Known Subclasses:
WebServiceOperation

public class WebServiceTransportLayer
extends JavaBeanOperation


Field Summary
protected  java.lang.String action
           
protected static java.lang.String AMPERSAND
           
protected  boolean debug
           
protected  boolean dotnet
           
protected  java.lang.String endpoint
           
protected static java.lang.String EQUAL
           
protected  java.lang.Exception error
           
protected  org.ksoap2.SoapFault fault
           
protected  java.lang.String password
           
protected static java.lang.String QUESTION_MARK
           
static int REQUEST_HTTP_GET
          Execute the web service via HTTP / GET request
static int REQUEST_HTTP_POST
          Execute the web service via HTTP / POST request
static int REQUEST_SOAP_1_0
          Execute the web service via SOAP 1.1 request
static int REQUEST_SOAP_1_1
          Execute the web service via SOAP 1.1 request
static int REQUEST_SOAP_1_2
          Execute the web service via SOAP 1.2 request
protected static java.lang.String SLASH
           
protected  int status
           
protected  java.lang.String username
           
protected  int version
           
protected  java.lang.String wsdl
           
 
Fields inherited from class oracle.adfnmc.dc.JavaBeanOperation
input, name, namespace, operation, output, parameters, result, returnNodeName, returnPrimitive, returnType
 
Constructor Summary
WebServiceTransportLayer(java.lang.String namespace, java.lang.String name, java.lang.String operation)
          Default constructor.
 
Method Summary
protected  java.lang.String dumpSoapObject(int indent, java.lang.String name, org.ksoap2.serialization.SoapObject so)
           
protected  java.lang.String dumpSoapObject(java.lang.String header, org.ksoap2.serialization.SoapObject so)
           
protected  java.lang.String getEndpoint()
           
protected  java.lang.String getIndent(int indent)
           
protected  java.lang.String getParametersAsString()
          INTERNAL METHOD: Helper method used to convert the operation's parameters as a string.
protected  java.lang.String getSoapAction()
           
protected  org.ksoap2.SoapFault getSoapFault()
           
protected  org.ksoap2.serialization.SoapObject getSoapMethod()
          INTERNAL METHOD: Helper method used to convert the operation's parameters as a string.
protected  org.ksoap2.serialization.SoapObject getSoapObject(java.lang.String ns, java.lang.String name, HashMap p)
           
static int getSoapVersionFlag(java.lang.String sv)
           
protected  int getStatus()
           
protected  java.lang.String getWsdl()
           
protected  java.lang.String getXMLRequest(org.ksoap2.SoapEnvelope envelope)
           
protected  java.lang.Object invoke(int requestMethod, int timeout)
          Inovke the web service operation.
protected  java.lang.String invokeHttpRequest(int requestMethod, int timeout)
          Invoke a HTTP request.
protected  java.lang.Object invokeSoapRequest(int soapVersion, int timeout)
          Invoke a request as a SOAP request.
protected  java.lang.Object invokeSoapRequest(org.ksoap2.serialization.SoapSerializationEnvelope envelope)
          Invoke the SOAP request (envelope)
protected  java.lang.String sendReceive(java.lang.String requestMethod, java.lang.String request, java.lang.String payload, int timeout)
          INTERNAL METHOD: Helper method used to send the request.
protected  void setDebug(boolean yn)
          set the debug flag
protected  void setDotNet(boolean yn)
          set the dotNet flag
protected  void setEndPoint(java.lang.String endpoint)
          set the service endpoint
 void setPassword(java.lang.String password)
           
protected  void setSoapAction(java.lang.String action)
           
protected  void setSoapVersion(int version)
          Provides the web service object with the desired SOAP version information.
 void setUsername(java.lang.String username)
           
protected  void setWsdl(java.lang.String wsdl)
          set the current WSDL location
 
Methods inherited from class oracle.adfnmc.dc.JavaBeanOperation
addInputParameter, clearParameters, execute, getInputObject, getName, getNamespace, getOperation, getOutput, getParameters, getParamter, getReturnType, invoke, isReturnPrmitive, log, log, setInput, setName, setNamespace, setOperation, setParameter, setParameters, setReturnIsPrimitive, setReturnPropertyName, setReturnType, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

REQUEST_HTTP_GET

public static final int REQUEST_HTTP_GET
Execute the web service via HTTP / GET request

See Also:
Constant Field Values

REQUEST_HTTP_POST

public static final int REQUEST_HTTP_POST
Execute the web service via HTTP / POST request

See Also:
Constant Field Values

REQUEST_SOAP_1_0

public static final int REQUEST_SOAP_1_0
Execute the web service via SOAP 1.1 request

See Also:
Constant Field Values

REQUEST_SOAP_1_1

public static final int REQUEST_SOAP_1_1
Execute the web service via SOAP 1.1 request

See Also:
Constant Field Values

REQUEST_SOAP_1_2

public static final int REQUEST_SOAP_1_2
Execute the web service via SOAP 1.2 request

See Also:
Constant Field Values

SLASH

protected static final java.lang.String SLASH
See Also:
Constant Field Values

AMPERSAND

protected static final java.lang.String AMPERSAND
See Also:
Constant Field Values

EQUAL

protected static final java.lang.String EQUAL
See Also:
Constant Field Values

QUESTION_MARK

protected static final java.lang.String QUESTION_MARK
See Also:
Constant Field Values

error

protected java.lang.Exception error

fault

protected org.ksoap2.SoapFault fault

action

protected java.lang.String action

endpoint

protected java.lang.String endpoint

wsdl

protected java.lang.String wsdl

username

protected java.lang.String username

password

protected java.lang.String password

dotnet

protected boolean dotnet

debug

protected boolean debug

version

protected int version

status

protected int status
Constructor Detail

WebServiceTransportLayer

public WebServiceTransportLayer(java.lang.String namespace,
                                java.lang.String name,
                                java.lang.String operation)
Default constructor.

Method Detail

getSoapVersionFlag

public static int getSoapVersionFlag(java.lang.String sv)

invoke

protected java.lang.Object invoke(int requestMethod,
                                  int timeout)
                           throws java.lang.Exception
Inovke the web service operation.

Parameters:
requestMethod - invoke as a HTTP (GET/POST), or as a SOAP (1.1/1.2) request
timeout - milliseconds before the underlying request times out
Returns:
the (XML) response
Throws:
java.io.IOException
java.lang.Exception

getEndpoint

protected java.lang.String getEndpoint()
Returns:
the current endpoint information

getSoapFault

protected org.ksoap2.SoapFault getSoapFault()

getStatus

protected int getStatus()
Returns:
the current status

getWsdl

protected java.lang.String getWsdl()
Returns:
the WSDL location

setDebug

protected void setDebug(boolean yn)
set the debug flag

Parameters:
yn -

setDotNet

protected void setDotNet(boolean yn)
set the dotNet flag

Parameters:
yn -

setEndPoint

protected void setEndPoint(java.lang.String endpoint)
set the service endpoint

Parameters:
endpoint -

setSoapVersion

protected void setSoapVersion(int version)
Provides the web service object with the desired SOAP version information.

Parameters:
version -
See Also:
REQUEST_SOAP_1_0, REQUEST_SOAP_1_1, REQUEST_SOAP_1_2

setWsdl

protected void setWsdl(java.lang.String wsdl)
set the current WSDL location

Parameters:
wsdl -

getParametersAsString

protected java.lang.String getParametersAsString()
INTERNAL METHOD: Helper method used to convert the operation's parameters as a string.

Returns:

invokeHttpRequest

protected java.lang.String invokeHttpRequest(int requestMethod,
                                             int timeout)
                                      throws java.lang.Exception
Invoke a HTTP request.

Parameters:
requestMethod - used to determine if a GET or POST HTTP request should be made
timeout - in milliseconds
Returns:
response as a string
Throws:
java.lang.Exception - on any errors
See Also:
REQUEST_HTTP_GET, REQUEST_HTTP_POST

invokeSoapRequest

protected java.lang.Object invokeSoapRequest(int soapVersion,
                                             int timeout)
                                      throws java.lang.Exception
Invoke a request as a SOAP request. This routine is used to build up the SOAP envelope and the invoke the request via invokeSoapRequest(SoapSerializationEnvelope)

Parameters:
soapVersion -
timeout -
Returns:
the SOAP response
Throws:
java.lang.Exception - for anything that could go wrong

sendReceive

protected java.lang.String sendReceive(java.lang.String requestMethod,
                                       java.lang.String request,
                                       java.lang.String payload,
                                       int timeout)
                                throws java.lang.Exception
INTERNAL METHOD: Helper method used to send the request.

Parameters:
requestMethod -
request -
payload -
timeout -
Returns:
Throws:
ProtocolException
java.lang.Exception

invokeSoapRequest

protected java.lang.Object invokeSoapRequest(org.ksoap2.serialization.SoapSerializationEnvelope envelope)
                                      throws java.lang.Exception
Invoke the SOAP request (envelope)

Parameters:
envelope -
Returns:
the SOAP response
Throws:
java.lang.Exception - for anything that could go wrong

setUsername

public void setUsername(java.lang.String username)

setPassword

public void setPassword(java.lang.String password)

getSoapMethod

protected org.ksoap2.serialization.SoapObject getSoapMethod()
INTERNAL METHOD: Helper method used to convert the operation's parameters as a string.

Returns:

getSoapObject

protected org.ksoap2.serialization.SoapObject getSoapObject(java.lang.String ns,
                                                            java.lang.String name,
                                                            HashMap p)

getSoapAction

protected java.lang.String getSoapAction()

setSoapAction

protected void setSoapAction(java.lang.String action)

getXMLRequest

protected java.lang.String getXMLRequest(org.ksoap2.SoapEnvelope envelope)
                                  throws java.io.IOException
Throws:
java.io.IOException

getIndent

protected java.lang.String getIndent(int indent)

dumpSoapObject

protected java.lang.String dumpSoapObject(int indent,
                                          java.lang.String name,
                                          org.ksoap2.serialization.SoapObject so)

dumpSoapObject

protected java.lang.String dumpSoapObject(java.lang.String header,
                                          org.ksoap2.serialization.SoapObject so)

Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-01

Copyright © 2011, Oracle and/or its affiliates. All rights reserved.