com.ibm.cics.model
Interface IWebService

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource
All Known Subinterfaces:
IMutableWebService

public interface IWebService
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable WEBSERV


Nested Class Summary
static class IWebService.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IWebService.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IWebService.ProgramInterfaceValue
          Enumeration type for field PGMINTERFACE
static class IWebService.StateValue
          Enumeration type for field STATE
static class IWebService.ValidationStatusValue
          Enumeration type for field VALIDATIONST
static class IWebService.XOPDirectStatusValue
          Enumeration type for field XOPDIRECTST
static class IWebService.XOPSupportStatusValue
          Enumeration type for field XOPSUPPORTST
 
Method Summary
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 java.lang.String getBinding()
          Getter for field BINDING
 java.lang.Long getCcsid()
          Getter for field CCSID
 IWebService.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 java.lang.String getContainer()
          Getter for field CONTAINER
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 java.lang.String getEndpoint()
          Getter for field ENDPOINT
 IWebService.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.String getMappingLevel()
          Getter for field MAPPINGLEVEL
 java.lang.Long getMappingRelease()
          Getter for field MAPPINGRNUM
 java.lang.Long getMappingVersion()
          Getter for field MAPPINGVNUM
 java.lang.String getMinimumRuntimeLevel()
          Getter for field MINRUNLEVEL
 java.lang.Long getMinimumRuntimeRelease()
          Getter for field MINRUNRNUM
 java.lang.Long getMinimumRuntimeVersion()
          Getter for field MINRUNVNUM
 java.util.Date getModified()
          Getter for field LASTMODTIME
 java.lang.String getName()
          Getter for field NAME
 java.lang.String getPipeline()
          Getter for field PIPELINE
 java.lang.String getPolicyDirectory()
          Getter for field POLICYDIR
 java.lang.String getProgram()
          Getter for field PROGRAM
 IWebService.ProgramInterfaceValue getProgramInterface()
          Getter for field PGMINTERFACE
 IWebService.StateValue getState()
          Getter for field STATE
 java.lang.String getURIMap()
          Getter for field URIMAP
 java.lang.Long getUseCount()
          Getter for field WEBUSECOUNT
 IWebService.ValidationStatusValue getValidationStatus()
          Getter for field VALIDATIONST
 java.lang.String getWSBindFile()
          Getter for field WSBIND
 java.lang.String getWSDLFile()
          Getter for field WSDLFILE
 IWebService.XOPDirectStatusValue getXOPDirectStatus()
          Getter for field XOPDIRECTST
 IWebService.XOPSupportStatusValue getXOPSupportStatus()
          Getter for field XOPSUPPORTST
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 

Method Detail

getName

java.lang.String getName()
Getter for field NAME

Name

The name of the Web service.

Specified by:
getName in interface ICICSObject

getWSBindFile

java.lang.String getWSBindFile()
Getter for field WSBIND

Fully-qualified WSBind file on HFS

The file name of the Web service binding file associated with the Web service resource.


getWSDLFile

java.lang.String getWSDLFile()
Getter for field WSDLFILE

Fully-qualified WSDL file on HFS

The file name of the Web service description (WSDL) file associated with the Web service resource.


getPipeline

java.lang.String getPipeline()
Getter for field PIPELINE

Pipeline in which this web service is installed

The name of the PIPELINE resource that contains this web service resource.


getValidationStatus

IWebService.ValidationStatusValue getValidationStatus()
Getter for field VALIDATIONST

Perform validation of SOAP messages against WSDL

Indicates whether full validation of SOAP messages against the corresponding schema in the Web service description is specified.


getURIMap

java.lang.String getURIMap()
Getter for field URIMAP

Dynamically installed URI map for this web service

The name of a dynamically installed URIMAP resource definition, if there is one that is associated with this Web service.


getProgram

java.lang.String getProgram()
Getter for field PROGRAM

Application program to implement this web service

The name of the target application program.


getEndpoint

java.lang.String getEndpoint()
Getter for field ENDPOINT

The endpoint URI of a remote web service

The URI specifying the location on the network (or endpoint) of the Web service, as defined in the Web service description.


getBinding

java.lang.String getBinding()
Getter for field BINDING

The WSDL binding that this web service represents

The WSDL binding represented by the Web service. This binding is one of (potentially) many that appear in the WSDL file.


getProgramInterface

IWebService.ProgramInterfaceValue getProgramInterface()
Getter for field PGMINTERFACE

Where the specified program expects input

For a service provider, indicates whether CICS passes data to the target application program in a COMMAREA or a channel.


getContainer

java.lang.String getContainer()
Getter for field CONTAINER

Container used if the program input is CHANNEL

The name of the container that holds the top level data when CICS passes data to the target application program in a channel.


getModified

java.util.Date getModified()
Getter for field LASTMODTIME

Time the WSBind file on HFS was last updated

The time, in milliseconds since 00:00 on January 1st 1900, that the deployed Web service binding file on HFS was last updated.


getState

IWebService.StateValue getState()
Getter for field STATE

Web service status

The state of the Web service. Values are:

Discarding
A Discard command has been issued for the web service. The web service 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 web service is usable.
Unusable
Copying of the WSBind file on the shelf has failed, and the web service is unusable.


getUseCount

java.lang.Long getUseCount()
Getter for field WEBUSECOUNT

Number of times web service used

The number of times this Web service was used to process a Web service request.


getCcsid

java.lang.Long getCcsid()
Getter for field CCSID

Coded character set ID

The name of the CCSID that is used to encode data between the application and the Web service binding file at run time.


getMappingLevel

java.lang.String getMappingLevel()
Getter for field MAPPINGLEVEL

Mapping level used in WSBind file

The level of mapping that is used to convert data between language structures and the Web services description (WSDL) document. Values are 1.0, 1.1, 1.2, 2.0, 2.1 and 2.2.


getMappingVersion

java.lang.Long getMappingVersion()
Getter for field MAPPINGVNUM

Mapping version number part of MAPLEVEL

Returns a fullword binary value of the version number for the mapping level that is used to convert data between language structures and Web service description (WSDL) documents. The value of the version number is 1 or 2.


getMappingRelease

java.lang.Long getMappingRelease()
Getter for field MAPPINGRNUM

Mapping release number part of MAPLEVEL

Returns a fullword binary value of the release number for the mapping level that is used to convert data between language structures and Web service description (WSDL) documents. The value of the release number is 0, 1, or 2.


getMinimumRuntimeLevel

java.lang.String getMinimumRuntimeLevel()
Getter for field MINRUNLEVEL

Minimum runtime level required by WSBind file

The minimum runtime level that is required to run the Web service in CICS. Values are: 1.0, 1.1, 1.2, 2.0, 2.1, or 2.2.


getMinimumRuntimeVersion

java.lang.Long getMinimumRuntimeVersion()
Getter for field MINRUNVNUM

Minimum runtime version number part of MINRUNLVL

Returns a fullword binary value of the version number for the minimum runtime level that is required to run the Web service in CICS. The value of the version number is 1 or 2.


getMinimumRuntimeRelease

java.lang.Long getMinimumRuntimeRelease()
Getter for field MINRUNRNUM

Minimum runtime release number part of MINRUNLVL

Returns a fullword binary value of the release number for the minimum runtime level that is required to run the Web service in CICS. The value of the release number is 0, 1, or 2.


getXOPSupportStatus

IWebService.XOPSupportStatusValue getXOPSupportStatus()
Getter for field XOPSUPPORTST

Web service XOP capability

Indicates whether the web service implementation is capable of handling XOP documents and binary attachments in direct mode. The values are:


getXOPDirectStatus

IWebService.XOPDirectStatusValue getXOPDirectStatus()
Getter for field XOPDIRECTST

Current Web service direct mode XOP status

Indicates whether the web service is currently able to handle XOP documents in direct mode. The values are:


getPolicyDirectory

java.lang.String getPolicyDirectory()
Getter for field POLICYDIR

Reserved area

This field is not available for use yet but is reserved for future development.


getChangeUserID

java.lang.String getChangeUserID()
Getter for field CHANGEUSRID

Last modification user ID

The user ID that made the last modification to the resource definition.


getChangeAgent

IWebService.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


getChangeAgentRelease

java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGREL

Last modification agent release

The CICS release level of the agent that made the last modification to the resource definition.


getInstallAgent

IWebService.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENT

Installation agent

The change agent identifier that made the installation.


getChangeTime

java.util.Date getChangeTime()
Getter for field CHANGETIME

Last modification time

The local date and time when the definition was last changed.


getDefineSource

java.lang.String getDefineSource()
Getter for field DEFINESOURCE

Source of the resource definition

The source of the definition, depending on which agent made the last change.


getDefineTime

java.util.Date getDefineTime()
Getter for field DEFINETIME

Creation time

The local date and time when the resource definition record was created on DFHCSD or EYUDREP.


getInstallUserID

java.lang.String getInstallUserID()
Getter for field INSTALLUSRID

Installation user ID

The user ID that installed the resource definition.


getInstallTime

java.util.Date getInstallTime()
Getter for field INSTALLTIME

Installation time

The local date and time when the definition was installed.


getBasdefinever

java.lang.Long getBasdefinever()
Getter for field BASDEFINEVER

BAS resource definition version

The BAS version number of this definition.



Copyright © 2008-2009 IBM Corp. All Rights Reserved.