|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.axis.client.ServiceClient
Allows an Axis service to be invoked from the client side. Contains message and session state which may be reused across multiple invocations on the same ServiceClient.
Call
Constructor Summary | |
ServiceClient()
Deprecated. Basic, no-argument constructor. |
|
ServiceClient(AxisEngine engine)
Deprecated. Construct a ServiceClient with just an AxisEngine. |
|
ServiceClient(java.lang.String endpointURL)
Deprecated. Construct a ServiceClient with a given endpoint URL |
|
ServiceClient(java.lang.String endpointURL,
AxisEngine engine)
Deprecated. Construct a ServiceClient with a given endpoint URL & engine |
|
ServiceClient(Transport transport)
Deprecated. Construct a ServiceClient with the given Transport. |
|
ServiceClient(Transport transport,
AxisEngine engine)
Deprecated. Construct a ServiceClient with the given Transport & engine. |
Method Summary | |
void |
addDeserializerFactory(QName qName,
java.lang.Class _class,
DeserializerFactory deserializerFactory)
Deprecated. Map a type for deserialization. |
void |
addHeader(SOAPHeader header)
Deprecated. Add a header which should be inserted into each outgoing message we generate. |
void |
addOption(java.lang.String name,
java.lang.Object value)
Deprecated. Set engine option. |
void |
addSerializer(java.lang.Class _class,
QName qName,
Serializer serializer)
Deprecated. Map a type for serialization. |
static void |
addTransportPackage(java.lang.String packageName)
Deprecated. Add a package to the system protocol handler search path. |
void |
clearHeaders()
Deprecated. Clear the list of headers which we insert into each message |
java.lang.Object |
get(java.lang.String name)
Deprecated. Get a property from our list of persistent ones. |
MessageContext |
getMessageContext()
Deprecated. Obtain a reference to our MessageContext. |
java.util.Vector |
getOutputParams()
Deprecated. Get the output parameters (if any) from the last invocation. |
Message |
getResponseMessage()
Deprecated. Directly get the response message in our MessageContext. |
int |
getTimeout()
Deprecated. Get timeout from our MessageContext. |
Transport |
getTransportForProtocol(java.lang.String protocol)
Deprecated. Get the Transport registered for the given protocol. |
java.lang.String |
getURL()
Deprecated. Returns the URL of the transport |
static void |
initialize()
Deprecated. Set up the default transport URL mappings. |
void |
invoke()
Deprecated. Invoke this ServiceClient with its established MessageContext (perhaps because you called this.setRequestMessage()) |
java.lang.Object |
invoke(RPCElement body)
Deprecated. Invoke an RPC service with a pre-constructed RPCElement. |
SOAPEnvelope |
invoke(SOAPEnvelope env)
Deprecated. Invoke the service with a custom SOAPEnvelope. |
java.lang.Object |
invoke(java.lang.String method,
java.lang.Object[] args)
Deprecated. Convenience method to invoke a method with a default (empty) namespace. |
java.lang.Object |
invoke(java.lang.String namespace,
java.lang.String method,
java.lang.Object[] args)
Deprecated. Invoke an RPC service with a method name and arguments. |
void |
remove(java.lang.String name)
Deprecated. Removes the named property from our list of persistent ones. |
void |
set(java.lang.String name,
java.lang.Object value)
Deprecated. Set a property which should be carried through our MessageContexts into the engine. |
void |
setMaintainSession(boolean yesno)
Deprecated. Determine whether we'd like to track sessions or not. |
void |
setRequestMessage(Message msg)
Deprecated. Directly set the request message in our MessageContext. |
void |
setServiceDescription(ServiceDescription serviceDesc)
Deprecated. Set the ServiceDescription associated with this ServiceClient. |
void |
setTimeout(int value)
Deprecated. Set timeout in our MessageContext. |
void |
setTransport(Transport transport)
Deprecated. Set the Transport for this ServiceClient. |
static void |
setTransportForProtocol(java.lang.String protocol,
java.lang.Class transportClass)
Deprecated. Register a Transport that should be used for URLs of the specified protocol. |
void |
setURL(java.lang.String endpointURL)
Deprecated. Set the URL (and the transport state). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ServiceClient() throws java.lang.Exception
public ServiceClient(AxisEngine engine) throws java.lang.Exception
public ServiceClient(java.lang.String endpointURL) throws AxisFault, java.lang.Exception
endpointURL
- a string containing the transport endpoint for this
service.public ServiceClient(java.lang.String endpointURL, AxisEngine engine) throws AxisFault, java.lang.Exception
public ServiceClient(Transport transport) throws java.lang.Exception
transport
- a pre-constructed Transport object which will be used
to set up the MessageContext appropriately for each
requestpublic ServiceClient(Transport transport, AxisEngine engine) throws java.lang.Exception
Method Detail |
public static void setTransportForProtocol(java.lang.String protocol, java.lang.Class transportClass)
protocol
- the URL protocol (i.e. "tcp" for "tcp://" urls)transportClass
- the class of a Transport type which will be used
for matching URLs.public static void initialize()
public static void addTransportPackage(java.lang.String packageName)
packageName
- the package in which to search for protocol names.public void setTransport(Transport transport)
transport
- the Transport object we'll use to set up
MessageContext properties.public void setURL(java.lang.String endpointURL) throws AxisFault
public java.lang.String getURL()
public Transport getTransportForProtocol(java.lang.String protocol)
protocol
- a protocol such as "http" or "local" which may
have a Transport object associated with it.public void set(java.lang.String name, java.lang.Object value)
name
- the property name to set.value
- the value of the property.public java.lang.Object get(java.lang.String name)
name
- the property name to retrieve.public void remove(java.lang.String name)
name
- the property name to removepublic void setTimeout(int value)
value
- the maximum amount of time, in millisecondspublic int getTimeout()
public void setRequestMessage(Message msg)
msg
- the new request message.public Message getResponseMessage()
public void setMaintainSession(boolean yesno)
yesno
- true if session state is desired, false if not.public MessageContext getMessageContext()
public void setServiceDescription(ServiceDescription serviceDesc)
serviceDesc
- a ServiceDescription.public java.util.Vector getOutputParams()
public void addHeader(SOAPHeader header)
header
- a SOAPHeader to be inserted into messagespublic void clearHeaders()
public void addSerializer(java.lang.Class _class, QName qName, Serializer serializer)
_class
- the Java class of the data type.qName
- the xsi:type QName of the associated XML type.serializer
- a Serializer which will be used to write the XML.public void addDeserializerFactory(QName qName, java.lang.Class _class, DeserializerFactory deserializerFactory)
qName
- the xsi:type QName of an XML Schema type._class
- the class of the associated Java data type.deserializerFactory
- a factory which can create deserializer
instances for this type.public SOAPEnvelope invoke(SOAPEnvelope env) throws AxisFault
env
- a SOAPEnvelope to send.AxisFault
- public java.lang.Object invoke(java.lang.String namespace, java.lang.String method, java.lang.Object[] args) throws AxisFault
namespace
- the desired namespace URI of the method elementmethod
- the method nameargs
- an array of Objects representing the arguments to the
invoked method. If any of these objects are RPCParams,
Axis will use the embedded name of the RPCParam as the
name of the parameter. Otherwise, we will serialize
each argument as an XML element called "argAxisFault
- public java.lang.Object invoke(java.lang.String method, java.lang.Object[] args) throws AxisFault
method
- the method nameargs
- an array of Objects representing the arguments to the
invoked method. If any of these objects are RPCParams,
Axis will use the embedded name of the RPCParam as the
name of the parameter. Otherwise, we will serialize
each argument as an XML element called "argAxisFault
- public java.lang.Object invoke(RPCElement body) throws AxisFault
body
- an RPCElement containing all the information about
this call.AxisFault
- public void addOption(java.lang.String name, java.lang.Object value)
public void invoke() throws AxisFault
AxisFault
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |