com.ibm.cics.model
Interface IPipeline

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface IPipeline
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable PIPELINE


Nested Class Summary
static class IPipeline.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IPipeline.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IPipeline.MTOMStatusValue
          Enumeration type for field MTOMST
static class IPipeline.OperationModeValue
          Enumeration type for field PIPEMODE
static class IPipeline.SendMTOMStatusValue
          Enumeration type for field SENDMTOMST
static class IPipeline.StatusValue
          Enumeration type for field ENABLESTATUS
static class IPipeline.XOPDirectStatusValue
          Enumeration type for field XOPDIRECTST
static class IPipeline.XOPSupportStatusValue
          Enumeration type for field XOPSUPPORTST
 
Method Summary
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 IPipeline.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 getConfigurationFile()
          Getter for field CONFIGFILE
 java.lang.String getContentIDDomain()
          Getter for field CIDDOMAIN
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 IPipeline.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 ICICSEnums.YesNoValue getMTOMNoXOPStatus()
          Getter for field MTOMNOXOPST
 IPipeline.MTOMStatusValue getMTOMStatus()
          Getter for field MTOMST
 java.lang.String getName()
          Getter for field NAME
 IPipeline.OperationModeValue getOperationMode()
          Getter for field PIPEMODE
 java.lang.Long getResponseWaitTime()
          Getter for field RESPWAIT
 IPipeline.SendMTOMStatusValue getSendMTOMStatus()
          Getter for field SENDMTOMST
 java.lang.String getShelf()
          Getter for field SHELF
 java.lang.String getSOAPLevel()
          Getter for field SOAPLEVEL
 java.lang.Long getSOAPRelease()
          Getter for field SOAPRNUM
 java.lang.Long getSOAPVersion()
          Getter for field SOAPVNUM
 IPipeline.StatusValue getStatus()
          Getter for field ENABLESTATUS
 java.lang.Long getUseCount()
          Getter for field PIPEUSECOUNT
 java.lang.String getWSDirectory()
          Getter for field WSDIR
 IPipeline.XOPDirectStatusValue getXOPDirectStatus()
          Getter for field XOPDIRECTST
 IPipeline.XOPSupportStatusValue getXOPSupportStatus()
          Getter for field XOPSUPPORTST
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getObjectType
 

Method Detail

getName

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

Name

Specifies the name of this PIPELINE. The name can be up to eight characters in length.

Specified by:
getName in interface ICICSObject

getStatus

IPipeline.StatusValue getStatus()
Getter for field ENABLESTATUS

Status

Specifies the initial status of the PIPELINE when it is installed:


getUseCount

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

Number of times pipeline has been used

Specifies the number of times pipeline has been used


getConfigurationFile

java.lang.String getConfigurationFile()
Getter for field CONFIGFILE

Configuration file name on HFS for this pipeline

Specifies the name of an HFS file that contains information about the processing nodes that will act on a service request, and on the response.


getShelf

java.lang.String getShelf()
Getter for field SHELF

Name of a directory (shelf) for WSBind files

Specifies the 1 to 255 character fully-qualified name of a directory (a shelf, primarily for Web service binding files) on HFS.


getWSDirectory

java.lang.String getWSDirectory()
Getter for field WSDIR

Name of the WSBind (pickup) directory on HFS

Specifies the 1 to 255 character fully-qualified name of the Web service binding directory (also known as the pickup directory) on HFS.


getOperationMode

IPipeline.OperationModeValue getOperationMode()
Getter for field PIPEMODE

Pipeline operation mode

The mode that that pipeline is operating in.


getResponseWaitTime

java.lang.Long getResponseWaitTime()
Getter for field RESPWAIT

Response wait time for Requester Pipelines

Specifies a time control, in seconds, on the wait time for an application program to wait for an optional reponse message from a remote web service. The value can range from 0 to 9999 seconds, or will have the standard null value of -1 if RESPWAIT(DEFT) is specified on the PIPELINE definition. If RESPWAIT(DEFT) was specified for this attribute, the default timeout value of the transport protocol is used:

Note that the value of this attribute may not be reset to -1 (DEFT) - only 0 to 9999 may be applied. If you need to reset the RESPWAIT value to -1, you will have to delete the current PIPELINE object, and INSTALL another instance of it, where the RESPWAIT value specifies DEFT.


getSOAPVersion

java.lang.Long getSOAPVersion()
Getter for field SOAPVNUM

SOAP version number part of SOAPLEVEL

Returns a fullword binary value of the version number for the SOAP level that is used in the PIPELINE.


getSOAPRelease

java.lang.Long getSOAPRelease()
Getter for field SOAPRNUM

SOAP release number part of SOAPLEVEL

Returns a fullword binary value of the release number for the SOAP level that is used in the PIPELINE.


getSOAPLevel

java.lang.String getSOAPLevel()
Getter for field SOAPLEVEL

SOAP level supported by the pipeline

Specifies the version of SOAP that is supported in the pipeline. Values can be blank, 1.1 or 1.2.


getContentIDDomain

java.lang.String getContentIDDomain()
Getter for field CIDDOMAIN

MIME content id domain name

Displays the name of the domain that is used to generate MIME content-ID values that identify binary attachments.


getMTOMStatus

IPipeline.MTOMStatusValue getMTOMStatus()
Getter for field MTOMST

SOAP MTOM status

Returns a value that indicates whether support for MTOM has been enabled in the pipeline. The values are: SUPPORTED : MTOM support has been enabled in the pipeline. NOTSUPPORT : MTOM support has not been enabled in the pipeline.


getSendMTOMStatus

IPipeline.SendMTOMStatusValue getSendMTOMStatus()
Getter for field SENDMTOMST

Outbound SOAP message MTOM status

Returns a value that indicates when MTOM should be used for outbound SOAP messages. The values are: YES : Always use MTOM for outbound SOAP messages. NO : Do not use MTOM for outbound SOAP messages. SAME : Use MTOM for outbound SOAP message responses when the inbound message is received in MTOM format.


getMTOMNoXOPStatus

ICICSEnums.YesNoValue getMTOMNoXOPStatus()
Getter for field MTOMNOXOPST

Use MTOM even when no XOP attachments are present

Returns a value that indicates whether MTOM should be used for outbound SOAP messages when there are no binary attachments present. The values are: YES : Use MTOM, even when there are no binary attachments present. NO : Do not use MTOM unless there are binary attachments present.


getXOPSupportStatus

IPipeline.XOPSupportStatusValue getXOPSupportStatus()
Getter for field XOPSUPPORTST

Pipeline application handler XOP capability

Returns a value that indicates whether the application handler for the pipeline supports the processing of XOP documents and binary attachments.


getXOPDirectStatus

IPipeline.XOPDirectStatusValue getXOPDirectStatus()
Getter for field XOPDIRECTST

Pipeline direct mode XOP status

Returns a value that indicates whether the pipeline can currently handle XOP documents in direct mode.


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

IPipeline.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

IPipeline.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENT

Installation agent

The install 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.