Package org.apache.axis2.client
Class Stub
java.lang.Object
org.apache.axis2.client.Stub
Base class for generated client stubs. This defines several client API
(
public) methods shared between all types of stubs, along with
some protected methods intended for use by the actual stub
implementation code. The client API method names start with a leading
underscore character to avoid conflicts with actual implementation methods.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AxisServiceprotected ServiceClientprotected ArrayList -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet service client implementation used by this stub.void_setServiceClient(ServiceClient _serviceClient) Set service client implementation used by this stub.protected voidprotected voidaddHeader(org.apache.axiom.om.OMElement omElementToadd, org.apache.axiom.soap.SOAPEnvelope envelop) protected voidaddHeader(org.apache.axiom.om.OMElement omElementToadd, org.apache.axiom.soap.SOAPEnvelope envelop, boolean mustUnderstand) protected voidaddHttpHeader(MessageContext messageContext, String name, String value) add an http header with name and value to message contextprotected voidaddPropertyToOperationClient(OperationClient operationClient, String propertyKey, boolean value) protected voidaddPropertyToOperationClient(OperationClient operationClient, String propertyKey, int value) protected voidaddPropertyToOperationClient(OperationClient operationClient, String propertyKey, Object propertyValue) sets the propertykey and propertyValue as a pair to operation clientvoidcleanup()Cleanup associated resources.protected static org.apache.axiom.soap.SOAPEnvelopecreateEnvelope(Options options) Create a SOAP message envelope using the supplied options.protected voidfinalize()Finalize method called by garbage collection.protected static org.apache.axiom.soap.SOAPFactorygetFactory(String soapVersionURI) Get Axiom factory appropriate to selected SOAP version.protected voidsetMustUnderstand(org.apache.axiom.om.OMElement headerElement, org.apache.axiom.om.OMNamespace omNamespace) protected voidsetServiceClientEPR(String address) sets the epr of the service client to given value
-
Field Details
-
_service
-
modules
-
_serviceClient
-
-
Constructor Details
-
Stub
public Stub()
-
-
Method Details
-
_getServiceClient
Get service client implementation used by this stub.- Returns:
- service client
-
_setServiceClient
Set service client implementation used by this stub. Once set, the service client is owned by this stub and will automatically be removed from the configuration when use of the stub is done.- Parameters:
_serviceClient-
-
createEnvelope
protected static org.apache.axiom.soap.SOAPEnvelope createEnvelope(Options options) throws org.apache.axiom.soap.SOAPProcessingException Create a SOAP message envelope using the supplied options. TODO generated stub code should use this method, or similar method taking an operation client- Parameters:
options-- Returns:
- generated
- Throws:
org.apache.axiom.soap.SOAPProcessingException
-
getFactory
Get Axiom factory appropriate to selected SOAP version.- Parameters:
soapVersionURI-- Returns:
- factory
-
finalize
Finalize method called by garbage collection. This is overridden to support cleanup of any associated resources. -
cleanup
Cleanup associated resources. This removes the axis service from the configuration.- Throws:
AxisFault
-
setServiceClientEPR
sets the epr of the service client to given value- Parameters:
address-
-
addHttpHeader
add an http header with name and value to message context- Parameters:
messageContext-name-value-
-
addPropertyToOperationClient
protected void addPropertyToOperationClient(OperationClient operationClient, String propertyKey, Object propertyValue) sets the propertykey and propertyValue as a pair to operation client- Parameters:
operationClient-propertyKey-propertyValue-
-
addPropertyToOperationClient
protected void addPropertyToOperationClient(OperationClient operationClient, String propertyKey, boolean value) -
addPropertyToOperationClient
protected void addPropertyToOperationClient(OperationClient operationClient, String propertyKey, int value) -
setMustUnderstand
protected void setMustUnderstand(org.apache.axiom.om.OMElement headerElement, org.apache.axiom.om.OMNamespace omNamespace) -
addHeader
protected void addHeader(org.apache.axiom.om.OMElement omElementToadd, org.apache.axiom.soap.SOAPEnvelope envelop, boolean mustUnderstand) -
addHeader
protected void addHeader(org.apache.axiom.om.OMElement omElementToadd, org.apache.axiom.soap.SOAPEnvelope envelop) -
addAnonymousOperations
protected void addAnonymousOperations()
-