com.ibm.cics.server

Class WebService

java.lang.Object

com.ibm.cics.server.API

com.ibm.cics.server.Resource

com.ibm.cics.server.WebService

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Service

public class WebService
extends Resource

This class provides the Java interface to CICS WebService resources. It is used in order to access the INVOKE WEBSERVICE API.

See Also:

com.ibm.cics.server.API for general restrictions on using the JCICS API., Serialized Form

Since CICS TS version:

3.1

Since package version:

1.0.0

Constructor Summary

Constructors

Constructor and Description
WebService() Construct a WebService bean.
WebService(java.lang.String name) Construct a WebService object with a specific name

Method Summary

Modifier and Type	Method and Description
void	invoke(Channel theChannel, java.lang.String operationName) Invoke the named operation on the WEBSERVICE.
void	invoke(Channel theChannel, java.lang.String operationName, java.lang.String uri) Invoke the named operation on the WEBSERVICE 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 com.ibm.cics.server.API

getCICSServerApiVersion

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebService

public WebService()

Construct a WebService bean.

Since CICS TS version:

3.1

Since package version:

1.0.0

WebService

public WebService(java.lang.String name)

Construct a WebService object with a specific name

Parameters:

name - The name of the new WebService object

Since CICS TS version:

6.1

Since package version:

2.0.0

Method Detail

invoke

public void invoke(Channel theChannel,
                   java.lang.String operationName)
            throws RecordNotFoundException,
                   InvalidRequestException,
                   TimedOutException,
                   LengthErrorException

Invoke the named operation on the WEBSERVICE. Any parameters that are too long are truncated to the appropriate length.

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.

Since CICS TS version:

3.1

Since package version:

1.0.0

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 WEBSERVICE using a specified URI. Any parameters that are too long are truncated to the appropriate length.

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.

Since CICS TS version:

3.1

Since package version:

1.0.0

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.

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.

Since CICS TS version:

3.1

Since package version:

1.0.0

setScope

public void setScope(java.lang.String scope)

Set the scope for the Service

Parameters:

scope - the scope

Since CICS TS version:

4.1

Since package version:

1.200.0