|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ws.webservices.engine.client.Stub
com.ibm.soa.parlayx21.terminal_location.TerminalLocationBindingStub
public class TerminalLocationBindingStub
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
com.ibm.ws.webservices.engine.client.Stub.Invoke |
Field Summary |
---|
Fields inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
cachedEndpoint, cachedhttpProxyHost, cachedhttpProxyPassword, cachedhttpProxyPort, cachedhttpProxyUser, cachedhttpRedirectEnabled, cachedhttpsProxyHost, cachedhttpsProxyPassword, cachedhttpsProxyPort, cachedhttpsProxyUser, cachedPassword, cachedPortName, cachedProperties, cachedRequestSoapHeaders, cachedRequestTransportHeaders, cachedResponseSoapHeaders, cachedResponseSoapHeaderTemplates, cachedResponseTransportHeaders, cachedResponseTransportHeadersTemplate, cachedSessionContext, cachedsslCfgName, cachedTimeout, cachedUsername, cachedWriteTimeout, connection, engine, maintainSession, maintainSessionSet, messageContexts, service |
Fields inherited from interface javax.xml.rpc.Stub |
---|
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY |
Constructor Summary | |
---|---|
TerminalLocationBindingStub(java.net.URL endpointURL,
javax.xml.rpc.Service service)
|
Method Summary | |
---|---|
LocationInfo |
getLocation(java.net.URI address,
int requestedAccuracy,
int acceptableAccuracy,
TimeMetric maximumAge,
TimeMetric responseTime,
DelayTolerance tolerance)
This operation is intended to retrieve the location for a single terminal. |
LocationData[] |
getLocationForGroup(java.net.URI[] addresses,
int requestedAccuracy,
int acceptableAccuracy,
TimeMetric maximumAge,
TimeMetric responseTime,
DelayTolerance tolerance)
The getLocationForGroup operation initiates a retrieval activity, where one or more terminals, or groups of terminals, may have their locations determined. |
int |
getTerminalDistance(java.net.URI address,
float latitude,
float longitude)
This operation is intended to determine the distance of a terminal from a location. |
Methods inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
_getProperty, _getPropertyNames, _setProperty, convert, getPassword, getPortName, getTimeout, getTypeMapping, getUsername, primeMessageContext, setMaintainSession, setPassword, setPortName, setPortName, setTimeout, setUsername, setWriteTimeout, validateSoapHeadersHashMap, validateTransportPropertiesHashMap |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TerminalLocationBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service) throws com.ibm.ws.webservices.engine.WebServicesFault
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail |
---|
public LocationInfo getLocation(java.net.URI address, int requestedAccuracy, int acceptableAccuracy, TimeMetric maximumAge, TimeMetric responseTime, DelayTolerance tolerance) throws java.rmi.RemoteException, PolicyException, ServiceException
TerminalLocation
This operation is intended to retrieve the location for a single terminal. The accuracy requested is the desired accuracy for the response. The acceptable accuracy is the limit acceptable to the requester. If the accuracy requested cannot be supported, a fault (POL0230) will be returned to the application. If the accuracy of the location is not within the acceptable accuracy limit, then the location will not be returned, instead a fault (SVC0200) will be returned. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a fault will be returned to the application.
If tolerance is indicated this affects the priority of accuracy, response time and maximum acceptable age.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
* SVC0200: Accuracy out of limit.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
* POL0002: Privacy error.
* POL0006: Groups not allowed.
* POL0230: Requested accuracy not supported.
getLocation
in interface TerminalLocation
address
- xsd:anyURI
Address of the terminal device for which the location information is requestedrequestedAccuracy
- xsd:int
Accuracy of location information requestedacceptableAccuracy
- xsd:int
Accuracy that is acceptable for a responsemaximumAge
- common:TimeMetric
Maximum acceptable age of the location information that is returnedresponseTime
- common:TimeMetric
Indicates the maximum time that the application can accept to wait for a responsetolerance
- DelayTolerance
Indicates the priority of response time versus accuracy
java.rmi.RemoteException
PolicyException
ServiceException
public int getTerminalDistance(java.net.URI address, float latitude, float longitude) throws java.rmi.RemoteException, PolicyException, ServiceException
TerminalLocation
This operation is intended to determine the distance of a terminal from a location. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a fault will be returned to the application.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
* POL0002: Privacy error.
* POL0006: Groups not allowed.
getTerminalDistance
in interface TerminalLocation
address
- xsd:anyURI
Address of terminal to checklatitude
- xsd:float
Latitude of the location to measure fromlongitude
- xsd:float
Longitude of the location to measure from
java.rmi.RemoteException
PolicyException
ServiceException
public LocationData[] getLocationForGroup(java.net.URI[] addresses, int requestedAccuracy, int acceptableAccuracy, TimeMetric maximumAge, TimeMetric responseTime, DelayTolerance tolerance) throws java.rmi.RemoteException, PolicyException, ServiceException
TerminalLocation
The getLocationForGroup operation initiates a retrieval activity, where one or more terminals, or groups of terminals, may have their locations determined. The accuracy requested is the desired accuracy for the response. If the accuracy requested is not supported, a fault (POL0230) will be returned to the application. If the location retrieved is not within the acceptable accuracy limit, then the location data will contain a ServiceError (SVC0200).
If tolerance is indicated this affects the priority of accuracy, response time and maximum acceptable age.
The Web Service may return a result set that does not include complete information, allowing the Web Service implementation to choose to deliver a partial set of results to accommodate other conditions, such as avoiding timeouts. In this case, a result will be marked NotRetrieved for each address for which a location retrieval was not attempted.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
* SVC0004: No valid addresses.
* SVC0006: Invalid group.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
* POL0003: Too many addresses.
* POL0006: Groups not allowed.
* POL0007: Nested groups not allowed.
* POL0230: Requested accuracy not supported.
getLocationForGroup
in interface TerminalLocation
addresses
- xsd:anyURI [1..unbounded]
List of URIs to get location for, including group URIsrequestedAccuracy
- xsd:int
Accuracy of location requested in metersacceptableAccuracy
- xsd:int
Accuracy that is acceptable for a response in metersmaximumAge
- common:TimeMetric
Maximum acceptable age of the location information that is returnedresponseTime
- common:TimeMetric
Indicates the maximum time that the application can accept to wait for a responsetolerance
- DelayTolerance
Indicates the priority of response time versus accuracy
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |