|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServiceControl
Provides simplified access to web services. A service control provides an interface between an application and a web service, which allows an application to invoke the service's operations. Using a web service control, you can connect to any web service for which a WSDL file is available.
Typically, a service control is used by creating the control from a WSDL file. Then, the target web service's operations are exposed as methods of the control.
Nested Class Summary | |
---|---|
static interface |
ServiceControl.Location
Location URL for target service. |
static interface |
ServiceControl.OperationName
OperationName is only used when the target WSDL defines operations with names that are invalid as Java Method names. |
static interface |
ServiceControl.WSDL
Path to WSDL - required annotation. |
Method Summary | |
---|---|
URL |
getEndPoint()
Gets the URL that the Service control instance will use as the base URL. |
Element[] |
getInputHeaders()
Retrieves the SOAP headers that were included in the most recent arriving callback from this Service control. |
String |
getPassword()
Retrieves the password string that was set by the most recent call to the setPassword method. |
int |
getTimeout()
Gets the timeout that has been set by setTimeout() for the underlying HttpURLConnection (returned in millisecs, a value of 0 means no timeout). |
String |
getUsername()
Retrieves the username string that was set by the most recent call to setUsername. |
QName |
getWsdlPort()
Returns the QName of the port that will be used by the Service Control to call the webservice. |
void |
reset()
Clears all parameters that were set by previous calls to the setOutputHeaders, setPassword, or setUsername methods. |
void |
setEndPoint(URL url)
Manual control over URL of the target service. |
void |
setOutputHeaders(Element[] headers)
Sets the SOAP headers that will be included in the next outgoing method invocation message to the Service control. |
void |
setPassword(String password)
Sets the password that will be sent with the next outgoing Service control method invocation. |
void |
setTimeout(int timeout)
Sets the timeout for the underlying HttpURLConnection (in millisecs, default is 0 which means no timeout, negative values are converted to 0). |
void |
setUsername(String username)
Sets the username that will be sent with the next outgoing Service control method invocation. |
void |
setWsdlPort(QName wsdlPortName)
Specifies the QName for the port within the WSDL which the Service Control should use. |
Method Detail |
---|
void setEndPoint(URL url)
url
- The new destination for callbacks.URL getEndPoint()
void setWsdlPort(QName wsdlPortName)
wsdlPortName
- The QName of the port to use.QName getWsdlPort()
void setUsername(String username)
username
- The username to send for authentication.String getUsername()
void setPassword(String password)
password
- The password to send for authentication.String getPassword()
Element[] getInputHeaders()
void setOutputHeaders(Element[] headers)
headers
- An array of the new SOAP output header elements.void setTimeout(int timeout)
int getTimeout()
void reset()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |