|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axis2.client.ServiceClient
A ServiceClient class is used to create a client for a service. More details need to be explained here.
Field Summary | |
static QName |
ANON_OUT_IN_OP
|
static QName |
ANON_OUT_ONLY_OP
|
static QName |
ANON_ROBUST_OUT_ONLY_OP
|
static String |
ANON_SERVICE
|
Constructor Summary | |
ServiceClient()
Create a service client by assuming an anonymous service and any other necessary information. |
|
ServiceClient(ConfigurationContext configContext,
AxisService axisService)
Create a service client configured to work with a specific AxisService. |
|
ServiceClient(ConfigurationContext configContext,
URL wsdlURL,
QName wsdlServiceName,
String portName)
Create a service client for WSDL service identified by the QName of the wsdl:service element in a WSDL document. |
|
ServiceClient(ConfigurationContext configContext,
org.apache.wsdl.WSDLDescription wsdldesc,
QName wsdlServiceName,
String portName)
This is WOM based constructor to configure the Service Client/ We are going to make this policy aware |
Method Summary | |
void |
addHeader(org.apache.ws.commons.om.OMElement header)
Add an XML element as a header to be sent with interactions. |
void |
addStringHeader(QName headerName,
String headerText)
Add a simple header consisting of some text (and a header name; duh) to be sent with interactions. |
OperationClient |
createClient(QName operation)
Create a MEP client for a specific operation. |
void |
disEngageModule(QName moduleName)
|
void |
engageModule(QName moduleName)
Engage a module for this service client. |
void |
finalizeInvoke()
This will close the out put stream or , and remove entry from waiting queue of the transport Listener queue |
void |
fireAndForget(org.apache.ws.commons.om.OMElement elem)
Send a bit of XML and forget about it. |
void |
fireAndForget(QName operation,
org.apache.ws.commons.om.OMElement elem)
Send a bit of XML and forget about it under the guise of a specific operation. |
AxisService |
getAxisService()
Return the AxisService this is a client for. |
EndpointReference |
getMyEPR(String transport)
To get the EPR that the service is running transport : can be null , if it is null then epr will be craetd using any available transports |
Options |
getOptions()
Get the client configuration from this service interaction. |
Options |
getOverrideOptions()
Get the client configuration from this service interaction which have been used to overide operation client options as well. |
EndpointReference |
getTargetEPR()
To get the Targert EPR if any in service conetext and reference paramters in TEPR can send back , in the same time this epr can use to manage session across mutiple ServiceClient |
void |
removeHeaders()
To remove all the headers in ServiceClient |
org.apache.ws.commons.om.OMElement |
sendReceive(org.apache.ws.commons.om.OMElement elem)
|
org.apache.ws.commons.om.OMElement |
sendReceive(QName operation,
org.apache.ws.commons.om.OMElement elem)
|
void |
sendReceiveNonBlocking(org.apache.ws.commons.om.OMElement elem,
Callback callback)
|
void |
sendReceiveNonBlocking(QName operation,
org.apache.ws.commons.om.OMElement elem,
Callback callback)
|
void |
sendRobust(org.apache.ws.commons.om.OMElement elem)
This is a simple client API to invoke a service operation who's MEP is Robust In-Only. |
void |
sendRobust(QName operation,
org.apache.ws.commons.om.OMElement elem)
This is a simple client API to invoke a service operation who's MEP is Robust In-Only. |
void |
setOptions(Options options)
Set the client configuration related to this service interaction. |
void |
setOverrideOptions(Options overrideOptions)
Set the client configuration related to this service interaction to override any options that the underlying operation client may have. |
void |
setTargetEPR(EndpointReference targetEpr)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String ANON_SERVICE
public static final QName ANON_OUT_ONLY_OP
public static final QName ANON_ROBUST_OUT_ONLY_OP
public static final QName ANON_OUT_IN_OP
Constructor Detail |
public ServiceClient(ConfigurationContext configContext, AxisService axisService) throws AxisFault
configContext
- The configuration context under which this service lives (may
be null, in which case a new local one will be created)axisService
- The service for which this is the client.
AxisFault
- if something goes wrong while creating a config context (if
needed)public ServiceClient(ConfigurationContext configContext, org.apache.wsdl.WSDLDescription wsdldesc, QName wsdlServiceName, String portName) throws AxisFault
configContext
- wsdldesc
- wsdlServiceName
- portName
-
AxisFault
public ServiceClient(ConfigurationContext configContext, URL wsdlURL, QName wsdlServiceName, String portName) throws AxisFault
configContext
- The configuration context under which this service lives (may
be null, in which case a new local one will be created) *wsdlURL
- The URL of the WSDL document to readwsdlServiceName
- The QName of the WSDL service in the WSDL document to create a
client forportName
- The name of the WSDL 1.1 port to create a client for. May be
null (if WSDL 2.0 is used or if only one port is there). .
AxisFault
- if something goes wrong while creating a config context (if
needed)public ServiceClient() throws AxisFault
Method Detail |
public AxisService getAxisService()
public void setOptions(Options options)
public Options getOptions()
public void setOverrideOptions(Options overrideOptions)
public Options getOverrideOptions()
public void engageModule(QName moduleName) throws AxisFault
moduleName
- Name of the module to engage
AxisFault
- if something goes wrongpublic void disEngageModule(QName moduleName)
public void addHeader(org.apache.ws.commons.om.OMElement header)
header
- The header to be added for interactions. Must not be null.public void removeHeaders()
public void addStringHeader(QName headerName, String headerText)
headerName
- headerText
- public void sendRobust(org.apache.ws.commons.om.OMElement elem) throws AxisFault
elem
- The XML to send
AxisFault
- if something goes wrong while sending it or if a fault is
received in response (per the Robust In-Only MEP).public void sendRobust(QName operation, org.apache.ws.commons.om.OMElement elem) throws AxisFault
operation
- The name of the operation to use. Must NOT be null.elem
- The XML to send
AxisFault
- if something goes wrong while sending it or if a fault is
received in response (per the Robust In-Only MEP).public void fireAndForget(org.apache.ws.commons.om.OMElement elem) throws AxisFault
elem
- The XML element to send to the service
AxisFault
- If something goes wrong trying to send the XMLpublic void fireAndForget(QName operation, org.apache.ws.commons.om.OMElement elem) throws AxisFault
operation
- The operation to send fire the message underelem
- The XML element to send to the service
AxisFault
- If something goes wrong trying to send the XMLpublic org.apache.ws.commons.om.OMElement sendReceive(org.apache.ws.commons.om.OMElement elem) throws AxisFault
AxisFault
public org.apache.ws.commons.om.OMElement sendReceive(QName operation, org.apache.ws.commons.om.OMElement elem) throws AxisFault
AxisFault
public void sendReceiveNonBlocking(org.apache.ws.commons.om.OMElement elem, Callback callback) throws AxisFault
AxisFault
public void sendReceiveNonBlocking(QName operation, org.apache.ws.commons.om.OMElement elem, Callback callback) throws AxisFault
AxisFault
public OperationClient createClient(QName operation) throws AxisFault
operation
- The QName of the operation to create a client for.
AxisFault
- if the operation is not found or something else goes wrongpublic void finalizeInvoke() throws AxisFault
AxisFault
public EndpointReference getMyEPR(String transport) throws AxisFault
AxisFault
public EndpointReference getTargetEPR()
EndpointReference
public void setTargetEPR(EndpointReference targetEpr)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |