Package org.apache.axis.client
Class Stub
java.lang.Object
org.apache.axis.client.Stub
- All Implemented Interfaces:
Stub
This class is the base for all generated stubs.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Call
protected URL
protected String
protected QName
protected Properties
protected Integer
protected String
protected boolean
protected boolean
protected Service
Fields inherited from interface javax.xml.rpc.Stub
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreates a call from the service._getCall()
Returns last Call object associated with this stub._getProperty
(String name) Gets the value of a named property.Return the names of configurable properties for this stub class.Provide access to the service object.void
_setProperty
(String name, Object value) Sets the value for a named property.void
addAttachment
(Object handler) Add an attachmentvoid
This method clears the request attachments.void
This method clears both requestHeaders and responseHeaders hashtables.void
extractAttachments
(Call call) Extract attachmentsprotected boolean
Is this the first time the type mappings are being registered?Object[]
Get the array of attachments The attachment array is cleared after this, so it is a destructive operation.Get the header elementGet the array of header elementsGet the passwordGet the port name.getResponseHeader
(String namespace, String partName) Get a response header elementGet the array of response header elementsprotected void
getResponseHeaders
(Call call) Deprecated.This method has been changed to a no-op but remains in the code to keep compatibility with pre-1.1 generated stubs.int
Get the timeout value in milliseconds.Get the user nameremoveProperty
(String name) Remove a property from this instance of the Stub NOTE: This is NOT part of JAX-RPC and is an Axis extension.protected void
setAttachments
(Call call) copy the attachments from the stub to the call object.void
Set the headervoid
setHeader
(SOAPHeaderElement header) Set the headervoid
setMaintainSession
(boolean session) If set to true, session is maintained; if false, it is not.void
setPassword
(String password) Set the password.void
setPortName
(String portName) Set the port name.void
setPortName
(QName portName) Set the port QName.protected void
setRequestHeaders
(Call call) void
setTimeout
(int timeout) Set the timeout in milliseconds.void
setUsername
(String username) Set the username.
-
Field Details
-
service
-
maintainSessionSet
protected boolean maintainSessionSet -
maintainSession
protected boolean maintainSession -
cachedProperties
-
cachedUsername
-
cachedPassword
-
cachedEndpoint
-
cachedTimeout
-
cachedPortName
-
_call
-
-
Constructor Details
-
Stub
public Stub()
-
-
Method Details
-
firstCall
protected boolean firstCall()Is this the first time the type mappings are being registered? -
_setProperty
Sets the value for a named property. JAX-RPC 1.0 specification specifies a standard set of properties that may be passed to the Stub._setProperty method. These properties include:- javax.xml.rpc.security.auth.username: Username for the HTTP Basic Authentication
- javax.xml.rpc.security.auth.password: Password for the HTTP Basic Authentication
- javax.xml.rpc.service.endpoint.address: Target service endpoint address.
- [TBD: Additional properties]
- Specified by:
_setProperty
in interfaceStub
- Parameters:
name
- - Name of the propertyvalue
- - Value of the property
-
_getProperty
Gets the value of a named property.- Specified by:
_getProperty
in interfaceStub
- Parameters:
name
-- Returns:
- the value of a named property.
-
removeProperty
Remove a property from this instance of the Stub NOTE: This is NOT part of JAX-RPC and is an Axis extension.- Parameters:
name
- the name of the property to remove- Returns:
- the value to which the key had been mapped, or null if the key did not have a mapping.
-
_getPropertyNames
Return the names of configurable properties for this stub class.- Specified by:
_getPropertyNames
in interfaceStub
- Returns:
- Iterator for the property names of the type
java.lang.String
-
setUsername
Set the username. -
getUsername
Get the user name -
setPassword
Set the password. -
getPassword
Get the password -
getTimeout
public int getTimeout()Get the timeout value in milliseconds. 0 means no timeout. -
setTimeout
public void setTimeout(int timeout) Set the timeout in milliseconds. -
getPortName
Get the port name. -
setPortName
Set the port QName. -
setPortName
Set the port name. -
setMaintainSession
public void setMaintainSession(boolean session) If set to true, session is maintained; if false, it is not. -
setHeader
Set the header- Parameters:
namespace
-partName
- that uniquely identify a header object.headerValue
- Object that is sent in the request as a SOAPHeader
-
setHeader
Set the header -
extractAttachments
Extract attachments- Parameters:
call
-
-
addAttachment
Add an attachment- Parameters:
handler
-
-
getHeader
Get the header element -
getResponseHeader
Get a response header element -
getHeaders
Get the array of header elements -
getResponseHeaders
Get the array of response header elements -
getAttachments
Get the array of attachments The attachment array is cleared after this, so it is a destructive operation.- Returns:
- the array of attachments that was in the message, or an empty array if there were none
-
clearHeaders
public void clearHeaders()This method clears both requestHeaders and responseHeaders hashtables. -
clearAttachments
public void clearAttachments()This method clears the request attachments. -
setRequestHeaders
- Throws:
AxisFault
-
setAttachments
copy the attachments from the stub to the call object. After doing so, the local set of attachments are cleared.- Parameters:
call
- call object to configure- Throws:
AxisFault
-
_getService
Provide access to the service object. Not part of JAX-RPC- Returns:
- the service object for this stub
-
_createCall
Creates a call from the service.- Returns:
- Throws:
ServiceException
-
_getCall
Returns last Call object associated with this stub. -
getResponseHeaders
Deprecated.This method has been changed to a no-op but remains in the code to keep compatibility with pre-1.1 generated stubs.Helper method for updating headers from the response. Deprecated, since response headers should not be automatically reflected back into the stub list.- Throws:
AxisFault
-