|
||||||||||
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_status.TerminalStatusNotificationManagerBindingStub
public class TerminalStatusNotificationManagerBindingStub
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 | |
---|---|
TerminalStatusNotificationManagerBindingStub(java.net.URL endpointURL,
javax.xml.rpc.Service service)
|
Method Summary | |
---|---|
void |
endNotification(java.lang.String correlator)
The application may end a notification using this operation. |
void |
startNotification(SimpleReference reference,
java.net.URI[] addresses,
Status[] criteria,
boolean checkImmediate,
TimeMetric frequency,
TimeMetric duration,
java.lang.Integer count)
Notifications of status changes are made available to applications. |
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 TerminalStatusNotificationManagerBindingStub(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 void startNotification(SimpleReference reference, java.net.URI[] addresses, Status[] criteria, boolean checkImmediate, TimeMetric frequency, TimeMetric duration, java.lang.Integer count) throws java.rmi.RemoteException, PolicyException, ServiceException
TerminalStatusNotificationManager
Notifications of status changes are made available to applications. The number and duration of notifications may be requested as part of the setup of the notification or may be governed by service policies, or a combination of the two.
If checkImmediate is set to true, then the notification will be set up, and then the current value of the terminal status will be checked. If the terminal status meets the criteria provided, a notification will be sent to the application. This notification will count against the count requested. This addresses the case where the status of the device changes during the time the notification is being set up, which may be appropriate in some applications.
The correlator provided in the reference must be unique for this Web Service at the time the notification is initiated, otherwise a ServiceException (SVC0005) will be returned to the application.
If the frequency requested is more often than allowed by the service policy, then the value in the service policy will be used. If the duration requested exceeds the time allowed in the service policy, then the value in the service policy will be used. If the notification period (duration) ends before all of the notifications (count) have been delivered, then the notification terminates. In all cases, when the notifications have run their course (by duration or count), an end of notifications message will be provided to the application.
Service policies may govern what count values can be requested, including maximum number of notifications allowed and whether unlimited notifications can be requested (for example, either by not specifying the optional count message part or by specifying it with a count value of zero). If the count value provided requested is not in policy, a PolicyException (POL0004 or POL0005 as appropriate) will be returned.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
* SVC0004: No valid addresses.
* SVC0005: Duplicate correlator.
* SVC0006: Invalid group.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
* POL0003: Too many addresses.
* POL0004: Unlimited notifications not supported.
* POL0005: Too many notifications requested.
* POL0006: Groups not allowed.
* POL0007: Nested groups not allowed.
* POL0009: Invalid frequency requested.
* POL0200: Busy criteria not supported.
startNotification
in interface TerminalStatusNotificationManager
reference
- common:SimpleReference
Notification endpoint definitionaddresses
- xsd:anyURI [0..unbounded]
Addresses of terminals to monitorcriteria
- Status [0..unbounded]
List of status values to generate notifications for (these apply to all addresses specified)checkImmediate
- xsd:boolean
Check status immediately after establishing notificationfrequency
- common:TimeMetric
Maximum frequency of notifications (can also be considered minimum time between notifications)duration
- common:TimeMetric
Length of time notifications occur for. Do not specify to use default notification time defined by service policycount
- xsd:integer
Maximum number of notifications., do not specify if For no maximum, either do not specify this part or specify a value of zero.
java.rmi.RemoteException
PolicyException
ServiceException
public void endNotification(java.lang.String correlator) throws java.rmi.RemoteException, PolicyException, ServiceException
TerminalStatusNotificationManager
The application may end a notification using this operation. Until this operation completes, notifications may continue to be received by the application.
An end of notification (statusEnd) operation will not be invoked on the application for a notification ended using the endNotification operation.
ServiceException from ES 202 391-1 [2]:
* SVC0001: Service error.
* SVC0002: Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001: Policy error.
endNotification
in interface TerminalStatusNotificationManager
correlator
- xsd:string
Correlator of request to end
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |