com.ibm.cics.gen.api
Interface IAssistantParameters


public interface IAssistantParameters

The parameters passed to the CICS Web services assistant


Field Summary
static int CHAR_VARYING_NO
          The FIXED length character array code.
static int CHAR_VARYING_NULL
          The NULL terminated character array code.
static int CHAR_VARYING_YES
          The Variable length character array code.
static java.lang.String COPYRIGHT
           
static int LANG_C
          The C language code.
static int LANG_COBOL
          The COBOL language code.
static int LANG_CPP
          The CPP language code.
static int LANG_PLI_ENTERPRISE
          The PLI-ENTERPRISE language code.
static int LANG_PLI_OTHER
          The PLI-OTHER language code.
static int MAPPING_LEVEL_1
          The Mapping level 1 code.
static int MAPPING_LEVEL_1_1
          The Mapping level 1.1 code.
static int MAPPING_LEVEL_1_2
          The Mapping level 1.2 code.
static int MAPPING_LEVEL_2
          The Mapping level 2 code.
static int MINIMUM_RUNTIME_LEVEL_CURRENT
          The 'current' MINIMUM-RUNTIME-LEVEL code
static int MINIMUM_RUNTIME_LEVEL_MINIMUM
          The 'minimum' MINIMUM-RUNTIME-LEVEL code
static int PGMINT_CHANNEL
          The CHANNEL program interface code.
static int PGMINT_COMMAREA
          The COMMAREA program interface code.
static java.lang.String SCCSID
          CICS SCCSID String
 
Method Summary
 java.lang.String getParamBINDING()
          Get the value of the BINDING parameter (DFHWS2LS only).
 java.lang.String getParamCCSID()
          Get the value of the CCSID parameter.
 java.lang.String getParamCHAR_MULTIPLIER()
          Get the value of the CHAR-MULTIPLIER parameter.
 java.lang.String getParamCHAR_VARYING_LIMIT()
          Get the value of the CHAR-VARYING-LIMIT parameter.
 java.lang.String getParamCHAR_VARYING()
          Get the value of the CHAR-VARYING parameter.
 java.lang.String getParamCONTID()
          Get the value of the CONTID parameter.
 java.lang.String getParamDEFAULT_CHAR_MAXLENGTH()
          Get the value of the DEFAULT-CHAR-MAXLENGTH parameter.
 java.lang.String getParamHTTPPROXY()
          Get the value of the HTTPPROXY parameter (DFHWS2LS only).
 java.lang.String getParamLANG()
          Get the value of the LANG parameter.
 java.lang.String getParamLOGFILE()
          Get the value of the LOGFILE parameter.
 java.lang.String getParamMAPPING_LEVEL()
          Get the value of the MAPPING-LEVEL parameter.
 java.lang.String getParamMINIMUM_RUNTIME_LEVEL()
          Get the value of the MINIMUM-RUNTIME-LEVEL parameter.
 java.lang.String getParamPDSCP()
          Get the value of the PDSCP parameter.
 java.lang.String getParamPDSLIB()
          Get the value of the PDSLIB parameter.
 java.lang.String getParamPGMINT()
          Get the value of the PGMINT parameter.
 java.lang.String getParamPGMNAME()
          Get the value of the PGMNAME parameter.
 java.lang.String getParamREQMEM()
          Get the value of the REQMEM parameter.
 java.lang.String getParamRESPMEM()
          Get the value of the RESPMEM parameter.
 java.lang.String getParamSERVICE()
          Get the value of the SERVICE parameter.
 java.lang.String getParamSTRUCTURE()
          Get the value of the STRUCTURE parameter.
 java.lang.String getParamTRANSACTION()
          Get the value of the TRANSACTION parameter.
 java.lang.String getParamURI()
          Get the value of the URI parameter.
 java.lang.String getParamUSERID()
          Get the value of the USERID parameter.
 java.lang.String getParamWSBIND()
          Get the value of the WSBIND parameter.
 java.lang.String getParamWSDL()
          Get the value of the WSDL parameter.
 int getVendorConverterApplicationInterfaceLength()
          Get the length of the vendor converter program interface.
 java.lang.String getVendorConverterName()
          Get the value of the vendor converter program name.
 byte[] getVendorMetaData()
          Get the vendor meta-data.
 void setParamBINDING(java.lang.String paramBINDING)
          Set the value of the BINDING parameter (DFHWS2LS only).
 void setParamCCSID(java.lang.String paramCCSID)
          Set the value of the CCSID parameter.
 void setParamCHAR_MULTIPLIER(int paramCHAR_MULTIPLIER)
          Set the value of the CHAR-MULTIPLIER parameter.
 void setParamCHAR_MULTIPLIER(java.lang.String paramCHAR_MULTIPLIER)
          Set the value of the CHAR-MULTIPLIER parameter.
 void setParamCHAR_VARYING_LIMIT(int paramCHAR_VARYING_LIMIT)
          Set the value of the CHAR-VARYING-LIMIT parameter.
 void setParamCHAR_VARYING_LIMIT(java.lang.String paramCHAR_VARYING_LIMIT)
          Set the value of the CHAR-VARYING-LIMIT parameter.
 void setParamCHAR_VARYING(int paramCHAR_VARYING)
          Set the value of the CHAR-VARYING parameter.
 void setParamCHAR_VARYING(java.lang.String paramCHAR_VARYING)
          Set the value of the CHAR-VARYING parameter.
 void setParamCONTID(java.lang.String paramCONTID)
          Set the value of the CONTID parameter.
 void setParamDEFAULT_CHAR_MAXLENGTH(int paramDEFAULT_CHAR_MAXLENGTH)
          Set the value of the DEFAULT-CHAR-MAXLENGTH parameter.
 void setParamDEFAULT_CHAR_MAXLENGTH(java.lang.String paramDEFAULT_CHAR_MAXLENGTH)
          Set the value of the DEFAULT-CHAR-MAXLENGTH parameter.
 void setParamHTTPPROXY(java.lang.String paramHTTPPROXY)
          Set the value of the HTTPPROXY parameter (DFHWS2LS only).
 void setParamLANG(int paramLANG)
          Set the value of the LANG parameter.
 void setParamLANG(java.lang.String paramLANG)
          Set the value of the LANG parameter.
 void setParamLOGFILE(java.lang.String paramLOGFILE)
          Set the value of the LOGFILE parameter.
 void setParamMAPPING_LEVEL(int paramMAPPING_LEVEL)
          Set the value of the MAPPING-LEVEL parameter.
 void setParamMAPPING_LEVEL(java.lang.String paramMAPPING_LEVEL)
          Set the value of the MAPPING-LEVEL parameter.
 void setParamMINIMUM_RUNTIME_LEVEL(int paramMINIMUM_RUNTIME_LEVEL)
          Set the value of the MINIMUM-RUNTIME-LEVEL parameter.
 void setParamMINIMUM_RUNTIME_LEVEL(java.lang.String paramMINIMUM_RUNTIME_LEVEL)
          Set the value of the MINIMUM-RUNTIME-LEVEL parameter.
 void setParamPDSCP(java.lang.String paramPDSCP)
          Set the value of the PDSCP parameter.
 void setParamPDSLIB(java.lang.String paramPDSLIB)
          Set the value of the PDSLIB parameter.
 void setParamPGMINT(int paramPGMINT)
          Set the value of the PGMINT parameter.
 void setParamPGMINT(java.lang.String paramPGMINT)
          Set the value of the PGMINT parameter.
 void setParamPGMNAME(java.lang.String paramPGMNAME)
          Set the value of the PGMNAME parameter.
 void setParamREQMEM(java.lang.String paramREQMEM)
          Set the value of the REQMEM parameter.
 void setParamRESPMEM(java.lang.String paramRESPMEM)
          Set the value of the RESPMEM parameter.
 void setParamSERVICE(java.lang.String paramSERVICE)
          Set the value of the SERVICE parameter.
 void setParamSTRUCTURE(java.lang.String paramSTRUCTURE)
          Set the value of the STRUCTURE parameter.
 void setParamTRANSACTION(java.lang.String paramTRANSACTION)
          Set the value of the TRANSACTION parameter.
 void setParamURI(java.lang.String paramURI)
          Set the value of the URI parameter.
 void setParamUSERID(java.lang.String paramUSERID)
          Set the value of the USERID parameter.
 void setParamWSBIND(java.lang.String paramWSBIND)
          Set the value of the WSBIND parameter.
 void setParamWSDL(java.lang.String paramWSDL)
          Set the value of the WSDL parameter.
 void setVendorConverterApplicationInterfaceLength(int length)
          Set the length of the commarea or container used to pass data to the target CICS application when a vendor style WSBind file is generated.
 void setVendorConverterName(java.lang.String vendorConverterName)
          Set the name of the converter program to use when building a vendor style WSBind file.
 void setVendorMetaData(byte[] metaData)
          Sets the vendor meta-data for use with vendor style WSBind files.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

SCCSID

public static final java.lang.String SCCSID
CICS SCCSID String

See Also:
Constant Field Values

LANG_COBOL

public static final int LANG_COBOL
The COBOL language code. This programming language to use is COBOL.

See Also:
Constant Field Values

LANG_PLI_ENTERPRISE

public static final int LANG_PLI_ENTERPRISE
The PLI-ENTERPRISE language code. This programming language to use is PL/I. The compiler version is at least Enterprise level PL/I.

See Also:
Constant Field Values

LANG_PLI_OTHER

public static final int LANG_PLI_OTHER
The PLI-OTHER language code. This programming language to use is PL/I. The compiler version is pre-Enterprise level PL/I.

See Also:
Constant Field Values

LANG_C

public static final int LANG_C
The C language code. This programming language to use is C.

See Also:
Constant Field Values

LANG_CPP

public static final int LANG_CPP
The CPP language code. This programming language to use is C++.

See Also:
Constant Field Values

MAPPING_LEVEL_1

public static final int MAPPING_LEVEL_1
The Mapping level 1 code.

See Also:
Constant Field Values

MAPPING_LEVEL_1_1

public static final int MAPPING_LEVEL_1_1
The Mapping level 1.1 code.

See Also:
Constant Field Values

MAPPING_LEVEL_1_2

public static final int MAPPING_LEVEL_1_2
The Mapping level 1.2 code.

See Also:
Constant Field Values

MAPPING_LEVEL_2

public static final int MAPPING_LEVEL_2
The Mapping level 2 code.

See Also:
Constant Field Values

MINIMUM_RUNTIME_LEVEL_CURRENT

public static final int MINIMUM_RUNTIME_LEVEL_CURRENT
The 'current' MINIMUM-RUNTIME-LEVEL code

See Also:
Constant Field Values

MINIMUM_RUNTIME_LEVEL_MINIMUM

public static final int MINIMUM_RUNTIME_LEVEL_MINIMUM
The 'minimum' MINIMUM-RUNTIME-LEVEL code

See Also:
Constant Field Values

PGMINT_COMMAREA

public static final int PGMINT_COMMAREA
The COMMAREA program interface code. This target CICS Program resource expects to communicate using a Commarea.

See Also:
Constant Field Values

PGMINT_CHANNEL

public static final int PGMINT_CHANNEL
The CHANNEL program interface code. This target CICS Program resource expects to communicate using a Channel.

See Also:
Constant Field Values

CHAR_VARYING_NULL

public static final int CHAR_VARYING_NULL
The NULL terminated character array code.

See Also:
Constant Field Values

CHAR_VARYING_NO

public static final int CHAR_VARYING_NO
The FIXED length character array code.

See Also:
Constant Field Values

CHAR_VARYING_YES

public static final int CHAR_VARYING_YES
The Variable length character array code.

See Also:
Constant Field Values
Method Detail

getParamBINDING

public java.lang.String getParamBINDING()
Get the value of the BINDING parameter (DFHWS2LS only).

Returns:
The current value of the BINDING parameter.

setParamBINDING

public void setParamBINDING(java.lang.String paramBINDING)
Set the value of the BINDING parameter (DFHWS2LS only).

Parameters:
paramBINDING - ,

DFHLS2WS()
Not Applicable.

DFHWS2LS()
If the Web service description contains more than one <binding> element, use this parameter to specify which one is to be used to generate the language structure and Web service binding file. Specify the value of the name attribute that is used on the <binding> element in the Web service description


getParamCONTID

public java.lang.String getParamCONTID()
Get the value of the CONTID parameter.

Returns:
The current value of the CONTID parameter.

setParamCONTID

public void setParamCONTID(java.lang.String paramCONTID)
Set the value of the CONTID parameter.

Parameters:
paramCONTID -

DFHLS2WS()
Specifies the name of the container that holds the top level data structure used to represent a SOAP message.

DFHWS2LS()
Specifies the name of the container that holds the top level data structure used to represent a SOAP message.


getParamHTTPPROXY

public java.lang.String getParamHTTPPROXY()
Get the value of the HTTPPROXY parameter (DFHWS2LS only).

Returns:
The current value of the HTTPPROXY parameter.

setParamHTTPPROXY

public void setParamHTTPPROXY(java.lang.String paramHTTPPROXY)
Set the value of the HTTPPROXY parameter (DFHWS2LS only).

Parameters:
paramHTTPPROXY -

DFHLS2WS()
Not Applicable.

DFHWS2LS()
If your WSDL contains references to other WSDL files that are located on the internet, and the system on which you are running DFHWS2LS uses a proxy server to access the internet, specify the domain name or IP address, and port number, of the proxy server. For example: HTTPPROXY=proxy.example.com:8080 In other cases, this parameter is not required.


getParamLANG

public java.lang.String getParamLANG()
Get the value of the LANG parameter.

Returns:
The current value of the LANG parameter.

setParamLANG

public void setParamLANG(java.lang.String paramLANG)
Set the value of the LANG parameter.

Parameters:
paramLANG -

DFHLS2WS()
Specifies that the programming language of the high level language structure. {'COBOL', 'PLI-ENTERPRISE', 'PLI-OTHER', 'C', 'CPP'}

DFHWS2LS()
Specifies that the programming language of the high level language structure. {'COBOL', 'PLI-ENTERPRISE', 'PLI-OTHER', 'C', 'CPP'}


setParamLANG

public void setParamLANG(int paramLANG)
Set the value of the LANG parameter.

Parameters:
paramLANG -

DFHLS2WS()
Specifies that the programming language of the high level language structures. {IAssistantParameters.COBOL, IAssistantParameters.PLI_ENTERPRISE, IAssistantParameters.PLI_OTHER, IAssistantParameters.C, IAssistantParameters.CPP}

DFHWS2LS()
Specifies that the programming language of the high level language structures. {IAssistantParameters.COBOL, IAssistantParameters.PLI_ENTERPRISE, IAssistantParameters.PLI_OTHER, IAssistantParameters.C, IAssistantParameters.CPP}


getParamLOGFILE

public java.lang.String getParamLOGFILE()
Get the value of the LOGFILE parameter.

Returns:
The current value of the LOGFILE parameter.

setParamLOGFILE

public void setParamLOGFILE(java.lang.String paramLOGFILE)
Set the value of the LOGFILE parameter.

Parameters:
paramLOGFILE -

DFHLS2WS()
The fully qualified name of the file into which DFHLS2WS writes its activity log and trace information. DFHLS2WS creates the file (but not the directory structure) if it does not already exist.

DFHWS2LS()
The fully qualified name of the file into which DFHLS2WS writes its activity log and trace information. DFHWS2LS creates the file (but not the directory structure) if it does not already exist.


setParamMAPPING_LEVEL

public void setParamMAPPING_LEVEL(java.lang.String paramMAPPING_LEVEL)
Set the value of the MAPPING-LEVEL parameter.

Parameters:
paramMAPPING_LEVEL - Specifies the desired mapping level used when reading and generating language structures. If this value is not set then it defaults to mapping level 1.

setParamMAPPING_LEVEL

public void setParamMAPPING_LEVEL(int paramMAPPING_LEVEL)
Set the value of the MAPPING-LEVEL parameter.

Parameters:
paramMAPPING_LEVEL - Specifies the desired mapping level used when reading and generating language structures. If this value is not set then it defaults to mapping level 1. { IAssistantParameters.MAPPING_LEVEL_1, IAssistantParameters.MAPPING_LEVEL_1_1, IAssistantParameters.MAPPING_LEVEL_1_2, IAssistantParameters.MAPPING_LEVEL_2}

setParamMINIMUM_RUNTIME_LEVEL

public void setParamMINIMUM_RUNTIME_LEVEL(java.lang.String paramMINIMUM_RUNTIME_LEVEL)
Set the value of the MINIMUM-RUNTIME-LEVEL parameter.

Parameters:
paramMINIMUM_RUNTIME_LEVEL - Specifies the required minimum level of support needed at runtime in order to install the WSBind file. This parameter usually defaults to the same value as the MAPPING-LEVEL parameter.

setParamMINIMUM_RUNTIME_LEVEL

public void setParamMINIMUM_RUNTIME_LEVEL(int paramMINIMUM_RUNTIME_LEVEL)
Set the value of the MINIMUM-RUNTIME-LEVEL parameter.

Parameters:
paramMINIMUM_RUNTIME_LEVEL - Specifies the required minimum level of support needed at runtime in order to install the WSBind file. This parameter usually defaults to the same value as the MAPPING-LEVEL parameter. { IAssistantParameters.MAPPING_LEVEL_1, IAssistantParameters.MAPPING_LEVEL_1_1, IAssistantParameters.MAPPING_LEVEL_1_2, IAssistantParameters.MAPPING_LEVEL_2, IAssistantParameters.MINIMUM_RUNTIME_LEVEL_MINIMUM, IAssistantParameters.MINIMUM_RUNTIME_LEVEL_CURRENT}

getParamPDSLIB

public java.lang.String getParamPDSLIB()
Get the value of the PDSLIB parameter.

Returns:
The current value of the PDSLIB parameter.

setParamPDSLIB

public void setParamPDSLIB(java.lang.String paramPDSLIB)
Set the value of the PDSLIB parameter.

Parameters:
paramPDSLIB -

DFHLS2WS() on z/OS
Specifies the name of the partitioned data set that contains the high level language data structures to be processed. The data set members used for the request and response are specified in the REQMEM and RESPMEM parameters respectively.

DFHLS2WS() on Windows
Specifies the name of the directory that contains the high level language data structures to be processed. The files used for the request and response are specified in the REQMEM and RESPMEM parameters respectively.

DFHWS2LS() on z/OS
Specifies the name of the partitioned data set that contains the generated high level language structures. The data set members used for the request and response structures are specified in the REQMEM and RESPMEM parameters respectively.

DFHWS2LS() on Windows
Specifies the name of the directory that contains the generated high level language structures. The file names used for the request and response structures are specified in the REQMEM and RESPMEM parameters respectively.


getParamPGMINT

public java.lang.String getParamPGMINT()
Get the value of the PGMINT parameter.

Returns:
The current value of the PGMINT parameter.

setParamPGMINT

public void setParamPGMINT(java.lang.String paramPGMINT)
Set the value of the PGMINT parameter.

Parameters:
paramPGMINT -

DFHLS2WS()
For a service provider, specifies how CICS passes data to the target application program: 'CHANNEL' CICS uses a channel interface to pass data to the target application program. 'COMMAREA' CICS uses a communication area to pass data to the target application program.
This parameter is ignored when the output from DFHLS2WS is used in a service requester.

DFHWS2LS()
For a service provider, specifies how CICS passes data to the target application program: 'CHANNEL' CICS uses a channel interface to pass data to the target application program. 'COMMAREA' CICS uses a communication area to pass data to the target application program.
This parameter is ignored when the output from DFHWS2LS is used in a service requester.


setParamPGMINT

public void setParamPGMINT(int paramPGMINT)
Set the value of the PGMINT parameter.

Parameters:
paramPGMINT -

DFHLS2WS()
For a service provider, specifies how CICS passes data to the target application program: IAssistantParameters.CHANNEL CICS uses a channel interface to pass data to the target application program. IAssistantParameters.COMMAREA CICS uses a communication area to pass data to the target application program.
This parameter is ignored when the output from DFHLS2WS is used in a service requester.

DFHWS2LS()
For a service provider, specifies how CICS passes data to the target application program: IAssistantParameters.CHANNEL CICS uses a channel interface to pass data to the target application program. IAssistantParameters.COMMAREA CICS uses a communication area to pass data to the target application program.
This parameter is ignored when the output from DFHWS2LS is used in a service requester.


getParamPGMNAME

public java.lang.String getParamPGMNAME()
Get the value of the PGMNAME parameter.

Returns:
The current value of the PGMNAME parameter.

setParamPGMNAME

public void setParamPGMNAME(java.lang.String paramPGMNAME)
Set the value of the PGMNAME parameter.

Parameters:
paramPGMNAME -

DFHLS2WS()
Specifies the name of the target CICS application program that will be exposed as a Web service. This is the program that the CICS Web service support will link to.

DFHWS2LS()
This parameter specifies the name of a CICS program. When DFHWS2LS is being used to generate a Web service binding file that will be used in a service provider, this parameter must be supplied. It specifies the name of the application program that is being exposed as a Web service. When DFHWS2LS is being used to generate a Web service binding file that will be used in a service requester, this parameter must be omitted.


getParamREQMEM

public java.lang.String getParamREQMEM()
Get the value of the REQMEM parameter.

Returns:
The current value of the REQMEM parameter.

setParamREQMEM

public void setParamREQMEM(java.lang.String paramREQMEM)
Set the value of the REQMEM parameter.

Parameters:
paramREQMEM -

DFHLS2WS() on z/OS
Specifies the name of the partitioned data set member which contains the high level language structure for the Web service request: For a service provider, the Web service request is the input to the application program For a service requester, the Web service request is the output from the application program.

DFHLS2WS() on Windows
Specifies the name of the file within the PDSLIB directory which contains the high level language structure for the Web service request: For a service provider, the Web service request is the input to the application program For a service requester, the Web service request is the output from the application program.

DFHWS2LS() on z/OS
Specifies a 1 - 6 character prefix that DFHWS2LS uses to generate the names of the partitioned data set members that will contain the high level language structures for the Web service request: For a service provider, the Web service request is the input to the application program For a service requester, the Web service request is the output from the application program. DFHWS2LS generates a partitioned data set member for each operation. It generates the member name by appending a two digit number to the prefix. Although this parameter is optional, you must specify it if the Web service description contains a definition of a request.

DFHWS2LS() on Windows
Specifies a 1 - 6 character prefix followed by an optional extension that DFHWS2LS uses to generate the names of the files within the PDSLIB directory that will contain the high level language structures for the Web service request: For a service provider, the Web service request is the input to the application program For a service requester, the Web service request is the output from the application program. DFHWS2LS generates a high level language structure file for each operation. It generates the file name by appending a two digit number to the prefix and adding the specified extension. For example, a REQMEM of ABCDEF.cpy may result in the following files being generated: ABCDEF01.cpy ABCDEF02.cpy . Although this parameter is optional, you must specify it if the Web service description contains a definition of a request.


getParamRESPMEM

public java.lang.String getParamRESPMEM()
Get the value of the RESPMEM parameter.

Returns:
The current value of the RESPMEM parameter.

setParamRESPMEM

public void setParamRESPMEM(java.lang.String paramRESPMEM)
Set the value of the RESPMEM parameter.

Parameters:
paramRESPMEM -

DFHLS2WS() on z/OS
Specifies the name of the partitioned data set member which contains the high level language structure for the Web service response: For a service provider, the Web service response is the output from the application program For a service requester, the Web service response is the input to the application program If there is no response (that is, for one way messages) omit this parameter.

DFHLS2WS() on Windows
Specifies the name of the file within the PDSLIB directory which contains the high level language structure for the Web service response: For a service provider, the Web service response is the output from the application program For a service requester, the Web service response is the input to the application program If there is no response (that is, for one way messages) omit this parameter.

DFHWS2LS() on z/OS
Specifies a 1 - 6 character prefix that DFHWS2LS uses to generate the names of the partitioned data set members that will contain the high level language structures for the Web service response: For a service provider, the Web service response is the output from the application program For a service requester, the Web service response is the input to the application program DFHWS2LS generates a partitioned data set member for each operation. It generates the member name by appending a two digit number to the prefix. If there is no response (that is, for one way messages) omit this parameter.

DFHWS2LS() on Windows
Specifies a 1 - 6 character prefix followed by an optional extension that DFHWS2LS uses to generate the names of the files within the PDSLIB directory that will contain the high level language structures for the Web service response: For a service provider, the Web service response is the output from the application program For a service requester, the Web service response is the input to the application program DFHWS2LS generates a high level language structure file for each operation. It generates the file name by appending a two digit number to the prefix and adding the specified extension. For example, a REQMEM of ABCDEF.cpy may result in the following files being generated: ABCDEF01.cpy ABCDEF02.cpy . If there is no response (that is, for one way messages) omit this parameter.


getParamSERVICE

public java.lang.String getParamSERVICE()
Get the value of the SERVICE parameter.

Returns:
The current value of the SERVICE parameter.

setParamSERVICE

public void setParamSERVICE(java.lang.String paramSERVICE)
Set the value of the SERVICE parameter.

Parameters:
paramSERVICE -

DFHLS2WS() Use this parameter only when directed to do so by IBM support.

DFHWS2LS() Use this parameter only when directed to do so by IBM support.


getParamSTRUCTURE

public java.lang.String getParamSTRUCTURE()
Get the value of the STRUCTURE parameter.

Returns:
The current value of the STRUCTURE parameter.

setParamSTRUCTURE

public void setParamSTRUCTURE(java.lang.String paramSTRUCTURE)
Set the value of the STRUCTURE parameter.

Parameters:
paramSTRUCTURE -

DFHLS2WS()
For C and C++ only, specifies the names of the high level structures contained in the partitioned data set members (or files) specified in the REQMEM and RESPMEM parameters: request, specifies the name of the high level structure containing the request when the REQMEM parameter is specified. The default value is DFHREQUEST. The partitioned data set member (or file) must contain a high level structure with the name that you specify (or a structure named DFHREQUEST if you do not specify a name). response, specifies the name of the high level structure containing the response when the RESPMEM parameter is specified. The default value is DFHRESPONSE. If you specify a value, the partitioned data set member (or file) must contain a high level structure with the name that you specify (or a structure named DFHRESPONSE if you do not specify a name).

DFHWS2LS()
For C and C++ only, specifies how the names of the request and response structures are generated. The generated request and response structures are given names of requestnn and responsenn where nn is a numeric suffix that is generated to distinguish the structures for each operation. If one or both names is omitted, the structures have the same name as the partitioned data set member (or file) names generated from the REQMEM and RESPMEM parameters that you specify.


getParamURI

public java.lang.String getParamURI()
Get the value of the URI parameter.

Returns:
The current value of the URI parameter.

setParamURI

public void setParamURI(java.lang.String paramURI)
Set the value of the URI parameter.

Parameters:
paramURI -

DFHLS2WS()
In a service provider, this parameter specifies the relative URI that a client will to use to access the Web service. CICS uses the value specified when it generates a URIMAP resource from the Web service binding file created by DFHLS2WS: the parameter specifies the path component of the URI to which the URIMAP definition applies.

DFHWS2LS()
In a service provider, this parameter specifies the relative URI that a client will use to access the Web service. CICS uses the value specified when it generates a URIMAP resource from the Web service binding file created by DFHWS2LS: the parameter specifies the path component of the URI to which the URIMAP definition applies. In a service requester, the URI of the target Web service is not specified with this parameter: the URI specified in the Web service description is used, although you can override that with the URI option on the EXEC CICS INVOKE WEBSERVICE command.


getParamWSBIND

public java.lang.String getParamWSBIND()
Get the value of the WSBIND parameter.

Returns:
The current value of the WSBIND parameter.

setParamWSBIND

public void setParamWSBIND(java.lang.String paramWSBIND)
Set the value of the WSBIND parameter.

Parameters:
paramWSBIND -

DFHLS2WS()
The fully qualified name of the Web service binding file. DFHLS2WS creates the file (but not the directory structure) if it does not already exist.

DFHWS2LS()
The fully qualified name of the Web service binding file. DFHWS2LS creates the file (but not the directory structure) if it does not already exist.


getParamWSDL

public java.lang.String getParamWSDL()
Get the value of the WSDL parameter.

Returns:
The current value of the WSDL parameter.

setParamWSDL

public void setParamWSDL(java.lang.String paramWSDL)
Set the value of the WSDL parameter.

Parameters:
paramWSDL -

DFHLS2WS()
The fully qualified name of the file into which the Web service description is written. DFHLS2WS creates the file (but not the directory structure) if it does not already exist.

DFHWS2LS()
The fully qualified name of the file that contains the Web service description.


getParamPDSCP

public java.lang.String getParamPDSCP()
Get the value of the PDSCP parameter.

Returns:
The current value of the PDSCP parameter.

setParamPDSCP

public void setParamPDSCP(java.lang.String paramPDSCP)
Set the value of the PDSCP parameter.

Parameters:
paramPDSCP -

DFHLS2WS()
The code page to use when reading the language structures.

DFHWS2LS()
The code page to use when writing the language structures.


getParamMAPPING_LEVEL

public java.lang.String getParamMAPPING_LEVEL()
Get the value of the MAPPING-LEVEL parameter.

Returns:
The current value of the MAPPING-LEVEL parameter.

getParamMINIMUM_RUNTIME_LEVEL

public java.lang.String getParamMINIMUM_RUNTIME_LEVEL()
Get the value of the MINIMUM-RUNTIME-LEVEL parameter.

Returns:
The current value of the MINIMUM-RUNTIME-LEVEL parameter.

setParamCCSID

public void setParamCCSID(java.lang.String paramCCSID)
Set the value of the CCSID parameter. The use of this parameter requires a minimum runtime level of 1.2.

Parameters:
paramCCSID -

DFHLS2WS()
The CCSID (code page) used for text fragments within the commarea at runtime. The CCSID specified should indicate an EBCDIC code page.

DFHWS2LS()
The CCSID (code page) used for text fragments within the commarea or containers at runtime. The CCSID specified should indicate an EBCDIC code page.


getParamCCSID

public java.lang.String getParamCCSID()
Get the value of the CCSID parameter.

Returns:
The current value of the CCSID parameter.

setParamCHAR_VARYING

public void setParamCHAR_VARYING(java.lang.String paramCHAR_VARYING)
Set the value of the CHAR-VARYING parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramCHAR_VARYING -

DFHLS2WS()
This parameter indicates whether to assume null terminated character arrays or fixed length character arrays for languages where this is not indicated in the language structure.

DFHWS2LS()
This parameter indicates the preferred form of mapping for variable length values.


setParamCHAR_VARYING

public void setParamCHAR_VARYING(int paramCHAR_VARYING)
Set the value of the CHAR-VARYING parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramCHAR_VARYING -

DFHLS2WS()
This parameter indicates whether to assume null terminated character arrays or fixed length character arrays for languages where this is not indicated in the language structure. { IAssistantParameters.CHAR_VARYING_NULL, IAssistantParameters.CHAR_VARYING_NO}

DFHWS2LS()
This parameter indicates whether to create null terminated character arrays, fixed length character arrays or variable length strings for unknown length character data. { IAssistantParameters.CHAR_VARYING_NULL, IAssistantParameters.CHAR_VARYING_NO, IAssistantParameters.CHAR_VARYING_YES}


getParamCHAR_VARYING

public java.lang.String getParamCHAR_VARYING()
Get the value of the CHAR-VARYING parameter. This parameter is only valid at mapping level 1.2 and above.

Returns:
The current value of the CHAR-VARYING parameter.

setParamCHAR_VARYING_LIMIT

public void setParamCHAR_VARYING_LIMIT(java.lang.String paramCHAR_VARYING_LIMIT)
Set the value of the CHAR-VARYING-LIMIT parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramCHAR_VARYING_LIMIT -

DFHWS2LS()
This parameter indicates the limit to apply to variable length values before mapping the value to a separate container.


setParamCHAR_VARYING_LIMIT

public void setParamCHAR_VARYING_LIMIT(int paramCHAR_VARYING_LIMIT)
Set the value of the CHAR-VARYING-LIMIT parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramCHAR_VARYING_LIMIT -

DFHWS2LS()
This parameter indicates the limit to apply to variable length values before mapping the value to a separate container.


getParamCHAR_VARYING_LIMIT

public java.lang.String getParamCHAR_VARYING_LIMIT()
Get the value of the CHAR-VARYING-LIMIT parameter. This parameter is only valid at mapping level 1.2 and above.

Returns:
The current value of the CHAR-VARYING-LIMIT parameter.

setParamDEFAULT_CHAR_MAXLENGTH

public void setParamDEFAULT_CHAR_MAXLENGTH(java.lang.String paramDEFAULT_CHAR_MAXLENGTH)
Set the value of the DEFAULT-CHAR-MAXLENGTH parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramDEFAULT_CHAR_MAXLENGTH -

DFHWS2LS()
This parameter indicates the default length to use for character based fields where no length has been specified in the Web service description. The default value is 255.


setParamDEFAULT_CHAR_MAXLENGTH

public void setParamDEFAULT_CHAR_MAXLENGTH(int paramDEFAULT_CHAR_MAXLENGTH)
Set the value of the DEFAULT-CHAR-MAXLENGTH parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramDEFAULT_CHAR_MAXLENGTH -

DFHWS2LS()
This parameter indicates the default length to use for character based fields where no length has been specified in the Web service description. The default value is 255.


getParamDEFAULT_CHAR_MAXLENGTH

public java.lang.String getParamDEFAULT_CHAR_MAXLENGTH()
Get the value of the DEFAULT-CHAR-MAXLENGTH parameter. This parameter is only valid at mapping level 1.2 and above.

Returns:
The current value of the DEFAULT-CHAR-MAXLENGTH parameter.

setParamCHAR_MULTIPLIER

public void setParamCHAR_MULTIPLIER(java.lang.String paramCHAR_MULTIPLIER)
Set the value of the CHAR-MULTIPLIER parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramCHAR_MULTIPLIER -

DFHWS2LS()
This parameter indicates the number of bytes to allow per character when creating a language structure. The default value is 1.


setParamCHAR_MULTIPLIER

public void setParamCHAR_MULTIPLIER(int paramCHAR_MULTIPLIER)
Set the value of the CHAR-MULTIPLIER parameter. This parameter is only valid at mapping level 1.2 and above.

Parameters:
paramCHAR_MULTIPLIER -

DFHWS2LS()
This parameter indicates the number of bytes to allow per character when creating a language structure. The default value is 1.


getParamCHAR_MULTIPLIER

public java.lang.String getParamCHAR_MULTIPLIER()
Get the value of the CHAR-MULTIPLIER parameter. This parameter is only valid at mapping level 1.2 and above.

Returns:
The current value of the CHAR-MULTIPLIER parameter.

setParamTRANSACTION

public void setParamTRANSACTION(java.lang.String paramTRANSACTION)
Set the value of the TRANSACTION parameter.

Parameters:
paramTRANSACTION -

DFHWS2LS()
This parameter indicates the CICS TRANSACTION to specify on the URIMAP created for the WEBSERVICE during a PIPELINE SCAN.

DFHLS2WS()
This parameter indicates the CICS TRANSACTION to specify on the URIMAP created for the WEBSERVICE during a PIPELINE SCAN.


getParamTRANSACTION

public java.lang.String getParamTRANSACTION()
Get the value of the TRANSACTION parameter.

Returns:
The current value of the TRANSACTION parameter.

setParamUSERID

public void setParamUSERID(java.lang.String paramUSERID)
Set the value of the USERID parameter.

Parameters:
paramUSERID -

DFHWS2LS()
This parameter indicates the USERID to specify on the URIMAP created for the WEBSERVICE during a PIPELINE SCAN.

DFHLS2WS()
This parameter indicates the USERID to specify on the URIMAP created for the WEBSERVICE during a PIPELINE SCAN.


getParamUSERID

public java.lang.String getParamUSERID()
Get the value of the USERID parameter.

Returns:
The current value of the USERID parameter.

setVendorConverterName

public void setVendorConverterName(java.lang.String vendorConverterName)
Set the name of the converter program to use when building a vendor style WSBind file. The vendor style of WSBind file opts out of the CICS supplied XML transformation process, instead CICS links to a converter program which is responsible for handling the XML to commarea conversion. This method is used to set the name of the converter program.

Do not attempt to use this method unless you wish to build a WSBind file that does not use the CICS supplied XML transformation service. If a vendor style WSBind file is required then some of the other input options are not needed such as the PDSLIB and the REQMEM and RESPMEM options.

If a vendor converter program name is supplied then CICS will link to this program whenever an XML transformation is required. Raw XML is stored in the DFH-BODY container and the application data is in the DFH-DATA container. The converter program is responsible for reading and writing to these containers as required by the directionality of the Web service - provider mode or requester mode. Meta-data may be stored in the WSBind file and passed to the vendor converter in the DFH-METADATA container.

In provider mode, the vendor converter is called twice, once to convert the SOAP request message to a binary equivalent and once to turn the binary data into a SOAP response. In either case, the converter program may make use of the CICS SOAPFAULT API to trigger fault processing. If the vendor program needs to indicate that a response message should not be sent then the DFH-NORESPONSE container must be put onto the Channel whilst the request is being converted.

In requester mode, the vendor converter is called twice, once to convert binary data into a SOAP request message and once to turn the SOAP response into binary data suitable for use by the application. The converter is responsible for handling any SOAP Fault messages received. It can indicate to CICS that a Fault was returned by placing the DFH-SOAPFAULT container onto the Channel. This will cause CICS to return the appropriate RESP2 value to the caller of the INVOKE WEBSERVICE API.

Parameters:
vendorConverterName -

DFHWS2LS()
The name of the converter program to link to.

DFHLS2WS()
This parameter is not available under DFHLS2WS


getVendorConverterName

public java.lang.String getVendorConverterName()
Get the value of the vendor converter program name.

Returns:
The name of the vendor converter program.

setVendorConverterApplicationInterfaceLength

public void setVendorConverterApplicationInterfaceLength(int length)
Set the length of the commarea or container used to pass data to the target CICS application when a vendor style WSBind file is generated. This method may only be used in conjunction with the setVendorConverterName method.

Do not attempt to use this method unless you wish to build a WSBind file that does not use the CICS supplied XML transformation service.

Parameters:
length -

DFHWS2LS()
The length of the commarea to be populated and passed to the target application, or, the length of data in the named container.

DFHLS2WS()
This parameter is not available under DFHLS2WS


getVendorConverterApplicationInterfaceLength

public int getVendorConverterApplicationInterfaceLength()
Get the length of the vendor converter program interface.

Returns:
The length of data.

setVendorMetaData

public void setVendorMetaData(byte[] metaData)
Sets the vendor meta-data for use with vendor style WSBind files. This meta-data is presented to the vendor converters at runtime in a container called DFH-METADATA. The use of this parameter requires a minimum runtime level of 1.2 or above.

Do not attempt to use this method unless you wish to build a WSBind file that does not use the CICS supplied XML transformation service.

Parameters:
metaData -

DFHWS2LS()
The optional vendor specific meta-data.

DFHLS2WS()
This parameter is not available under DFHLS2WS


getVendorMetaData

public byte[] getVendorMetaData()
Get the vendor meta-data.

Returns:
The meta-data.