Use the INQUIRE WEBSERVICE command to retrieve information about
an installed WEBSERVICE.

INQUIRE WEBSERVICE
.----------------------------.
V |
>>-INQUIRE WEBSERVICE(name)----+------------------------+-+----><
+-BINDING(data-area)-----+
+-CONTAINER(data-area)---+
+-ENDPOINT(data-area)----+
+-LASTMODTIME(data-area)-+
+-PGMINTERFACE(cvda)-----+
+-PIPELINE(data-area)----+
+-PROGRAM(data-area)-----+
+-STATE(cvda)------------+
+-URIMAP(data-area)------+
+-VALIDATIONST(cvda)-----+
+-WSBIND(data-area)------+
'-WSDLFILE(data-area)----'
Conditions: NOTAUTH, NOTFND
Description
Use the INQUIRE
WEBSERVICE command to retrieve information about an installed WEBSERVICE.
Browsing
You can browse through all the WEBSERVICEs
installed in your system by using the browse options (START, NEXT, and END)
on INQUIRE WEBSERVICE commands. See Browsing resource definitions for general
information about browsing, including syntax, exception conditions, and examples.
Options
- BINDING(data-area)
- Returns
the WSDL binding represented by the WEBSERVICE. This binding is one of (potentially)
many that appear in the WSDL file. The name can be up to 255 characters long.
- CONTAINER(data-area)
- Returns
the name of the container used if PGMINTERFACE returns a value of CHANNEL.
The name can be up to 16 characters long.
- ENDPOINT(data-area)
- Returns
the endpoint URI of a remote WEBSERVICE. This is the endpoint URI specified
in the WSDL file for a remote Web service. If a CICS® application program is the service
provider, then the ENDPOINT will be empty. The URI can be up to 255 characters
long.
- LASTMODTIME(data-area)
-
Returns
the time, in milliseconds since 00:00 on January 1st 1900, that the deployed
WSBind file on HFS was last updated. This is a readonly value that CICS updates
when the WEBSERVICE resource is installed or updated. The last-modified-time
can be used to determine whether CICS has refreshed itself after an update
is made to a WSBind file in the pickup directory.
- For dynamically-installed WEBSERVICEs (those installed by the CICS scanning
mechanism), the value of LASTMODTIME is the timestamp of the HFS file pointed
to by the WSBind definition, at the time the WEBSERVICE definition was last
installed or updated.
- For statically-installed WEBSERVICEs (those installed from a CSD or by
CREATE WEBSERVICE), the value of LASTMODTIME is the timestamp of the WSBind
HFS file pointed to by the WEBSERVICE definition, at the time the WEBSERVICE
was installed.
If you issue an INQUIRE WEBSERVICE command before a newly-installed
or updated WEBSERVICE has fully initialized, the returned LASTMODTIME value
will be zero.
The value is returned in 8-byte packed-decimal form. You
can use the EXEC CICS FORMATTIME command to convert the LASTMODTIME value
to the date-and-time format that you prefer.
- PGMINTERFACE(cvda)
- Returns
a CVDA indicating whether the CICS program that implements the Web service
expects input in a channel or in a commarea:
- CHANNEL
- The program expects input in a channel.
- COMMAREA
- The program expects input in a commarea
- PIPELINE(data-area)
- Returns
the name of the PIPELINE in which the WEBSERVICE is installed; that is, the
name of the PIPELINE resource that contains this WEBSERVICE resource. The
name can be up to 8 characters long.
- PROGRAM(data-area)
- Returns
the name of a CICS program
that implements the Web service. If this WEBSERVICE represents a remote Web
service (that is, CICS is not the service provider), PROGRAM will be empty.
The name can be up to 8 characters long.
- STATE(cvda)
- Returns
a CVDA indicating the state of the WEBSERVICE:
- DISCARDING
- A DISCARD command has been issued for the WEBSERVICE. The WEBSERVICE is
quiescing before being discarded. It is not accepting new work, but is allowing
currently-executing work to complete.
- INITING
- The Web service binding file, and the WSDL file, are being copied to the
shelf.
- INSERVICE
- Resolution of the copy of the WSBIND file on the shelf has succeeded,
and the WEBSERVICE is usable.
- UNUSABLE
- Copying of the WSBIND file on the shelf has failed, and the WEBSERVICE
is unusable.
- URIMAP(data-area)
- Returns
the name of a dynamically installed URIMAP if there is one that is associated
with this WEBSERVICE. If the WEBSERVICE was not installed by performing the
SCAN function on a PIPELINE resource, or if the WEBSERVICE represents a remote
Web service, then the URIMAP will be empty. The name can be up to 8 characters
long.
- VALIDATIONST(cvda)
- Returns
a CVDA indicating whether full validation of SOAP messages is currently enabled
for this WEBSERVICE:
- VALIDATION
- Full validation is enabled.
- DISABLED
- Full validation is disabled.
- WEBSERVICE(name)
- Specifies
the name of the WEBSERVICE about which you are inquiring. The name can be
up to 32 characters long.
- WSBIND(data-area)
- Returns
the name of the Web service binding file. The name can be up to 255 characters
long.
- WSDLFILE(data-area)
- Returns
the name of the Web service description file associated with the WEBSERVICE
resource. The name can be up to 255 characters long.
Conditions
- NOTAUTH
- RESP2
values are:
- 100
- The user associated with the issuing task is not authorized to use this
command.
- NOTFND
- RESP2
values are:
- 3
- The WEBSERVICE cannot be found.
[[ Contents Previous Page | Next Page Index ]]