com.ibm.cics.server
Class Service

java.lang.Object
  extended by com.ibm.cics.server.API
      extended by com.ibm.cics.server.Resource
          extended by com.ibm.cics.server.WebService
              extended by com.ibm.cics.server.Service
All Implemented Interfaces:
java.io.Serializable

public class Service
extends WebService

This class provides the Java interface to CICS Service API. It is used in order to access the INVOKE SERVICE command.

Version:
1.0
Author:
Paul Cooper
See Also:
Serialized Form

Constructor Summary
Service()
          Construct a Service bean.
 
Method Summary
 void invoke(Channel theChannel, java.lang.String operationName)
          Invoke the named operation on the Service.
 void invoke(Channel theChannel, java.lang.String operationName, java.lang.String uri)
          Invoke the named operation on the Service using a specified URI.
 void invoke(Channel theChannel, java.lang.String operationName, URIMap urimap)
          Invoke the named operation on the Service using a specified URIMAP.
 void setScope(java.lang.String scope)
          Set the scope for the Service.
 
Methods inherited from class com.ibm.cics.server.Resource
getDescription, getName, setDescription, setName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Service

public Service()
Construct a Service bean.

Method Detail

setScope

public void setScope(java.lang.String scope)
Set the scope for the Service.

Overrides:
setScope in class WebService
Parameters:
scope - The scope.

invoke

public void invoke(Channel theChannel,
                   java.lang.String operationName)
            throws RecordNotFoundException,
                   InvalidRequestException,
                   TimedOutException,
                   LengthErrorException
Invoke the named operation on the Service. Any parameters that are too long are truncated to the appropriate length.

Overrides:
invoke in class WebService
Parameters:
theChannel - the channel containing the input container
operationName - the name of the operation to invoke
Throws:
RecordNotFoundException - a NOTFOUND occurred.
InvalidRequestException - an INVREQ occurred.
TimedOutException - a TIMOUT occurred.
LengthErrorException - a LENGERR occurred.

invoke

public void invoke(Channel theChannel,
                   java.lang.String operationName,
                   java.lang.String uri)
            throws RecordNotFoundException,
                   InvalidRequestException,
                   TimedOutException,
                   LengthErrorException
Invoke the named operation on the Service using a specified URI. Any parameters that are too long are truncated to the appropriate length.

Overrides:
invoke in class WebService
Parameters:
theChannel - the channel containing the input container
operationName - the name of the operation to invoke
uri - the URI to use to locate the remote service
Throws:
RecordNotFoundException - A NOTFOUND occurred.
InvalidRequestException - An INVREQ occurred.
TimedOutException - a TIMOUT occurred.
LengthErrorException - a LENGERR occurred.

invoke

public void invoke(Channel theChannel,
                   java.lang.String operationName,
                   URIMap urimap)
            throws RecordNotFoundException,
                   InvalidRequestException,
                   TimedOutException,
                   LengthErrorException
Invoke the named operation on the Service using a specified URIMAP. Any parameters that are too long are truncated to the appropriate length.

Overrides:
invoke in class WebService
Parameters:
theChannel - the channel containing the input container
operationName - the name of the operation to invoke
urimap - the URIMAP to use to locate the remote service
Throws:
RecordNotFoundException - A NOTFOUND occurred.
InvalidRequestException - An INVREQ occurred.
TimedOutException - a TIMOUT occurred.
LengthErrorException - a LENGERR occurred.