Interface IWebService
-
- All Superinterfaces:
ICICSObject,ICICSResource,IInstalledCICSResource,com.ibm.cics.model.meta.ITypedObject
public interface IWebService extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIWebService.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIWebService.InstallAgentValueEnumeration type for field INSTALLAGENTstatic classIWebService.ProgramInterfaceValueEnumeration type for field PGMINTERFACEstatic classIWebService.StateValueEnumeration type for field STATEstatic classIWebService.ValidationStatusValueEnumeration type for field VALIDATIONSTstatic classIWebService.XOPDirectStatusValueEnumeration type for field XOPDIRECTSTstatic classIWebService.XOPSupportStatusValueEnumeration type for field XOPSUPPORTST
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetArchivefile()Getter for field ARCHIVEFILEjava.lang.LonggetBasdefinever()Getter for field BASDEFINEVERjava.lang.StringgetBinding()Getter for field BINDINGjava.lang.LonggetCcsid()Getter for field CCSIDIWebService.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTjava.lang.StringgetChangeAgentRelease()Getter for field CHANGEAGRELjava.util.DategetChangeTime()Getter for field CHANGETIMEjava.lang.StringgetChangeUserID()Getter for field CHANGEUSRIDIWebServiceReferencegetCICSObjectReference()java.lang.StringgetContainer()Getter for field CONTAINERjava.lang.StringgetDefineSource()Getter for field DEFINESOURCEjava.util.DategetDefineTime()Getter for field DEFINETIMEjava.lang.StringgetEndpoint()Getter for field ENDPOINTIWebService.InstallAgentValuegetInstallAgent()Getter for field INSTALLAGENTjava.util.DategetInstallTime()Getter for field INSTALLTIMEjava.lang.StringgetInstallUserID()Getter for field INSTALLUSRIDjava.lang.StringgetMappingLevel()Getter for field MAPPINGLEVELjava.lang.LonggetMappingRelease()Getter for field MAPPINGRNUMjava.lang.LonggetMappingVersion()Getter for field MAPPINGVNUMjava.lang.StringgetMinimumRuntimeLevel()Getter for field MINRUNLEVELjava.lang.LonggetMinimumRuntimeRelease()Getter for field MINRUNRNUMjava.lang.LonggetMinimumRuntimeVersion()Getter for field MINRUNVNUMjava.util.DategetModified()Getter for field LASTMODTIMEjava.lang.StringgetName()Getter for field NAMEICICSType<IWebService>getObjectType()java.lang.StringgetPipeline()Getter for field PIPELINEjava.lang.StringgetProgram()Getter for field PROGRAMIWebService.ProgramInterfaceValuegetProgramInterface()Getter for field PGMINTERFACEIWebService.StateValuegetState()Getter for field STATEjava.lang.StringgetURIMap()Getter for field URIMAPjava.lang.LonggetUseCount()Getter for field WEBUSECOUNTIWebService.ValidationStatusValuegetValidationStatus()Getter for field VALIDATIONSTjava.lang.StringgetWSBindFile()Getter for field WSBINDjava.lang.StringgetWSDLFile()Getter for field WSDLFILEIWebService.XOPDirectStatusValuegetXOPDirectStatus()Getter for field XOPDIRECTSTIWebService.XOPSupportStatusValuegetXOPSupportStatus()Getter for field XOPSUPPORTST-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IWebService> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMEName
The name of the web service.
- Specified by:
getNamein interfaceICICSObject
-
getWSBindFile
java.lang.String getWSBindFile()
Getter for field WSBINDFully-qualified WSBind file on zFS
The file name of the web service binding file associated with the web service resource.
-
getWSDLFile
java.lang.String getWSDLFile()
Getter for field WSDLFILEFully-qualified WSDL file on zFS
The file name of the web service description (WSDL) file associated with the web service resource.
-
getPipeline
java.lang.String getPipeline()
Getter for field PIPELINEPipeline 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 VALIDATIONSTPerform validation of SOAP messages against WSDL
Indicates whether full validation of SOAP messages against the corresponding schema in the web service description is specified.
- VALIDATION - Full validation is enabled.
- NOVALIDATION - Full validation is disabled.
-
getURIMap
java.lang.String getURIMap()
Getter for field URIMAPDynamically 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 PROGRAMApplication program to implement this web service
The name of the target application program.
-
getEndpoint
java.lang.String getEndpoint()
Getter for field ENDPOINTThe 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 BINDINGThe 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 PGMINTERFACEWhere 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 CONTAINERContainer 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 LASTMODTIMETime the WSBind file on zFS was last updated
The time, in milliseconds since 00:00 on January 1st 1900, that the deployed Web service binding file on zFS was last updated.
-
getState
IWebService.StateValue getState()
Getter for field STATEWeb 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
- There is a problem with the web service binding file (WSBIND) for the resource.
- Updating
- An update request for a WEBSERVICE is pending.
- Disabled
- This state is only available for WEBSERVICE resources that are defined in a CICS bundle. The web service has completed quiescing and is not accepting new work.
- Disabling
- This state is only available for WEBSERVICE resources that are defined in a CICS bundle. The web service is quiescing. It is not accepting new work, but is allowing currently-executing work to complete.
-
getUseCount
java.lang.Long getUseCount()
Getter for field WEBUSECOUNTNumber 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 CCSIDCoded 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 MAPPINGLEVELMapping level used in WSBind file
The mapping level that was used when the WSBind file file was produced.
-
getMappingVersion
java.lang.Long getMappingVersion()
Getter for field MAPPINGVNUMMapping version number part of MAPLEVEL
The version number for the mapping level that was used when the WSBind file was produced. The value of the version number is 1, 2, 3 or 4.
-
getMappingRelease
java.lang.Long getMappingRelease()
Getter for field MAPPINGRNUMMapping release number part of MAPLEVEL
The release number for the mapping level that was used when the WSBind file was produced. The value of the release number is 0, 1, or 2.
-
getMinimumRuntimeLevel
java.lang.String getMinimumRuntimeLevel()
Getter for field MINRUNLEVELMinimum runtime level required by WSBind file
The minimum runtime level that is required to install the WEBSERVICE in CICS.
-
getMinimumRuntimeVersion
java.lang.Long getMinimumRuntimeVersion()
Getter for field MINRUNVNUMMinimum runtime version number part of MINRUNLVL
The version number for the minimum runtime level that is required to install the WEBSERVICE in CICS.
-
getMinimumRuntimeRelease
java.lang.Long getMinimumRuntimeRelease()
Getter for field MINRUNRNUMMinimum runtime release number part of MINRUNLVL
The release number for the minimum runtime level that is required to install the WEBSERVICE in CICS.
-
getXOPSupportStatus
IWebService.XOPSupportStatusValue getXOPSupportStatus()
Getter for field XOPSUPPORTSTWeb service XOP capability
Indicates whether the web service implementation is capable of handling XOP documents and binary attachments in direct mode. The values are:
- NOXOPSUPPORT - The web service implementation does not support the direct handling of XOP documents and binary attachments.
- XOPSUPPORT - The web service implementation supports the direct handling of XOP documents and binary attachments. This is true for any web services that are generated and deployed using the web services assistant.
-
getXOPDirectStatus
IWebService.XOPDirectStatusValue getXOPDirectStatus()
Getter for field XOPDIRECTSTCurrent web service direct mode XOP status
Indicates whether the web service is currently able to handle XOP documents in direct mode. The values are:
- NOXOPDIRECT - The web service cannot currently handle XOP documents and binary attachments directly. This is true when the web service implementation does not support the direct handling of XOP documents and binary attachments, or web service validation is switched on.
- XOPDIRECT - The web service can currently handle XOP documents and binary attachments directly. This is true when the web service implementation supports the direct handling of XOP documents and web service validation is not switched.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getChangeAgent
IWebService.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
- DREPBATCH - The resource was last changed by a CICSPlex SM utility.
- DYNAMIC - The resource was last changed dynamically.
- CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
- NOTAPPLIC - This is not applicable for this resource.
- OVERRIDE - Resource was last changed by resource overrides.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getChangeAgentRelease
java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGRELLast 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 INSTALLAGENTInstallation agent
The install agent identifier that made the installation.
- CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CREATESPI - The resource was installed by an EXEC CICS CREATE command.
- DYNAMIC - The resource was installed dynamically.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
- BUNDLE - The resource was installed by a BUNDLE.
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
getDefineSource
java.lang.String getDefineSource()
Getter for field DEFINESOURCESource 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 DEFINETIMECreation 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 INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getInstallTime
java.util.Date getInstallTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed.
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS resource definition version
The BAS version number of this definition.
-
getArchivefile
java.lang.String getArchivefile()
Getter for field ARCHIVEFILEFully-qualified archive file on zFS
The archive file contains the wsdl document for this Web Service.
-
getCICSObjectReference
IWebServiceReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-