|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axis2.client.Options
The proposal related for this is here : http://marc.theaimsgroup.com/?l=axis2-dev&m=113320384108037&w=2 Client can fill this options and give to any class extending from MEPClient. All those classes will be getting parameters using this.
Field Summary | |
static String |
COPY_PROPERTIES
|
static int |
DEFAULT_TIMEOUT_MILLISECONDS
|
protected TransportOutDescription |
transportOut
This is used for sending and receiving messages. |
Constructor Summary | |
Options()
Default constructor |
|
Options(Options parent)
In normal mode operation, this options will try to fullfil the request from its values. |
Method Summary | |
void |
addReferenceParameter(org.apache.axiom.om.OMElement referenceParameter)
|
void |
addRelatesTo(RelatesTo relatesTo)
|
String |
getAction()
|
EndpointReference |
getFaultTo()
|
EndpointReference |
getFrom()
|
TransportListener |
getListener()
|
String |
getMessageId()
|
Options |
getParent()
|
Map |
getProperties()
|
Object |
getProperty(String key)
|
RelatesTo |
getRelatesTo()
|
RelatesTo |
getRelatesTo(String type)
|
RelatesTo[] |
getRelationships()
|
EndpointReference |
getReplyTo()
|
String |
getSenderTransportProtocol()
|
String |
getSoapVersionURI()
|
long |
getTimeOutInMilliSeconds()
Gets the wait time after which a client times out in a blocking scenario. |
EndpointReference |
getTo()
|
TransportInDescription |
getTransportIn()
|
String |
getTransportInProtocol()
|
TransportOutDescription |
getTransportOut()
|
boolean |
isExceptionToBeThrownOnSOAPFault()
If there is a SOAP Fault in the body of the incoming SOAP Message, system can be configured to throw an exception with the details extracted from the information from the fault message. |
boolean |
isManageSession()
|
boolean |
isUseSeparateListener()
|
void |
setAction(String action)
|
void |
setExceptionToBeThrownOnSOAPFault(boolean exceptionToBeThrownOnSOAPFault)
If there is a SOAP Fault in the body of the incoming SOAP Message, system can be configured to throw an exception with the details extracted from the information from the fault message. |
void |
setFaultTo(EndpointReference faultTo)
|
void |
setFrom(EndpointReference from)
|
void |
setListener(TransportListener listener)
|
void |
setManageSession(boolean manageSession)
|
void |
setMessageId(String messageId)
|
void |
setParent(Options parent)
|
void |
setProperties(Map properties)
This will set the properties to the context. |
void |
setProperty(String propertyKey,
Object property)
Properties you need to pass in to the message context must be set via this. |
void |
setRelationships(RelatesTo[] list)
|
void |
setReplyTo(EndpointReference replyTo)
|
void |
setSenderTransport(String senderTransport,
AxisConfiguration axisConfiguration)
Sets the transport to be used for sending the SOAP Message |
void |
setSoapVersionURI(String soapVersionURI)
|
void |
setTimeOutInMilliSeconds(long timeOutInMilliSeconds)
This is used in blocking scenario. |
void |
setTo(EndpointReference to)
|
void |
setTransportIn(TransportInDescription transportIn)
|
void |
setTransportInfo(String senderTransport,
String listenerTransport,
boolean useSeparateListener)
Deprecated. Use setTransportInProtocol(String) and useSeparateListener(boolean) instead. You do not need to setSenderTransportProtocol(String) as sender transport can be inferred from the to EPR. But still you can setTransportOut(TransportOutDescription). |
void |
setTransportInProtocol(String transportInProtocol)
|
void |
setTransportOut(TransportOutDescription transportOut)
|
void |
setUseSeparateListener(boolean useSeparateListener)
Used to specify whether the two SOAP Messages are be sent over same channel or over separate channels.The value of this variable depends on the transport specified. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String COPY_PROPERTIES
public static final int DEFAULT_TIMEOUT_MILLISECONDS
protected TransportOutDescription transportOut
Constructor Detail |
public Options()
public Options(Options parent)
parent
- Method Detail |
public String getAction()
public EndpointReference getFaultTo()
public EndpointReference getFrom()
public TransportListener getListener()
public TransportInDescription getTransportIn()
public String getTransportInProtocol()
public String getMessageId()
public Map getProperties()
public Object getProperty(String key)
key
-
public RelatesTo getRelatesTo(String type)
public RelatesTo getRelatesTo()
public RelatesTo[] getRelationships()
public void setRelationships(RelatesTo[] list)
public EndpointReference getReplyTo()
public TransportOutDescription getTransportOut()
public String getSenderTransportProtocol()
public String getSoapVersionURI()
public long getTimeOutInMilliSeconds()
public EndpointReference getTo()
public boolean isExceptionToBeThrownOnSOAPFault()
public boolean isUseSeparateListener()
public Options getParent()
public void setParent(Options parent)
public void setAction(String action)
public void setExceptionToBeThrownOnSOAPFault(boolean exceptionToBeThrownOnSOAPFault)
exceptionToBeThrownOnSOAPFault
- public void setFaultTo(EndpointReference faultTo)
public void setFrom(EndpointReference from)
public void setListener(TransportListener listener)
public void setTransportIn(TransportInDescription transportIn)
public void setTransportInProtocol(String transportInProtocol)
public void setMessageId(String messageId)
public void setProperties(Map properties)
properties
- public void setProperty(String propertyKey, Object property)
propertyKey
- property
- public void addRelatesTo(RelatesTo relatesTo)
public void setReplyTo(EndpointReference replyTo)
public void setTransportOut(TransportOutDescription transportOut)
public void setSenderTransport(String senderTransport, AxisConfiguration axisConfiguration) throws AxisFault
senderTransport
-
AxisFault
- if the transport is not foundpublic void setSoapVersionURI(String soapVersionURI)
public void setTimeOutInMilliSeconds(long timeOutInMilliSeconds)
timeOutInMilliSeconds
- public void setTo(EndpointReference to)
public void setTransportInfo(String senderTransport, String listenerTransport, boolean useSeparateListener) throws AxisFault
[transportOut, transportIn, useSeparateListener] http, http, true http, http, false http,smtp,true smtp,http,true smtp,smtp,true
senderTransport
- listenerTransport
- useSeparateListener
-
AxisFault
public void setUseSeparateListener(boolean useSeparateListener)
useSeparateListener
- public void addReferenceParameter(org.apache.axiom.om.OMElement referenceParameter)
public boolean isManageSession()
public void setManageSession(boolean manageSession)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |