com.ibm.soa.parlayx21.terminal_status
Class TerminalStatusBindingStub

java.lang.Object
  extended by com.ibm.ws.webservices.engine.client.Stub
      extended by com.ibm.soa.parlayx21.terminal_status.TerminalStatusBindingStub
All Implemented Interfaces:
TerminalStatus, java.rmi.Remote, javax.xml.rpc.Stub

public class TerminalStatusBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements TerminalStatus


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
TerminalStatusBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 Status getStatus(java.net.URI address)
          This operation is intended to retrieve the status for a single terminal.
 StatusData[] getStatusForGroup(java.net.URI[] addresses)
          This operation initiates a retrieval activity, where one or more terminals, or groups of terminals, may have their status determined.
 
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

TerminalStatusBindingStub

public TerminalStatusBindingStub(java.net.URL endpointURL,
                                 javax.xml.rpc.Service service)
                          throws com.ibm.ws.webservices.engine.WebServicesFault
Throws:
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail

getStatus

public Status getStatus(java.net.URI address)
                 throws java.rmi.RemoteException,
                        PolicyException,
                        ServiceException
Description copied from interface: TerminalStatus

This operation is intended to retrieve the status for a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application.

Referenced faults

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.

Specified by:
getStatus in interface TerminalStatus
Parameters:
address - xsd:anyURI Terminal to request status for
Returns:
result Status Status for the terminal for which status was requested
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getStatusForGroup

public StatusData[] getStatusForGroup(java.net.URI[] addresses)
                               throws java.rmi.RemoteException,
                                      PolicyException,
                                      ServiceException
Description copied from interface: TerminalStatus

This operation initiates a retrieval activity, where one or more terminals, or groups of terminals, may have their status determined.

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, the addresses for which no attempt was made to provide data will be marked NotRetrieved in the result for each address this applies to.

Referenced faults

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.

Specified by:
getStatusForGroup in interface TerminalStatus
Parameters:
addresses - xsd:anyURI [1..unbounded] List of URIs to get status for, including group URIs
Returns:
result StatusData [1..unbounded] Set of results for the request
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.