SAP ABAP Class CL_WCF_WSC_PROXY_API (API for creating proxies)
Hierarchy
☛
WEBCUIF (Software Component) SAP Web UI Framework
⤷
CA-WUI-WST (Application Component) Web Services Tool
⤷
CRM_GENIL_WSC (Package) GenIL Component for Web Service Consumption
WEBCUIF (Software Component) SAP Web UI Framework⤷
CA-WUI-WST (Application Component) Web Services Tool⤷
CRM_GENIL_WSC (Package) GenIL Component for Web Service ConsumptionProperties
| Class | CL_WCF_WSC_PROXY_API | |
| Short Description | API for creating proxies | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CRM_GENIL_WSC | GenIL Component for Web Service Consumption |
| Created | 20090216 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | CL_PROXY_QUERY |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 3 | SPRX |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 4 | TSRTP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_WCF_WSC_PROXY_API has no interface implemented.
Friends
Class CL_WCF_WSC_PROXY_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROXY |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_PROXY | created proxy | 20090331 | ||
| 2 | PROXY_TYPE_CONSUMER |
Constant | Public | Type reference (TYPE) | SRT_WSP_CONFIG_TYPE | 'CR' | Consumer Proxies | 20090317 | |
| 3 | PROXY_TYPE_SERVER_RUNTIME |
Constant | Public | Type reference (TYPE) | SRT_WSP_CONFIG_TYPE | 'SR' | Server runtime Proxies | 20090317 | |
| 4 | TRANSPORT_ID |
Static Attribute | Private | Type reference (TYPE) | TRKORR | Request/Task to use for transport | 20090331 | ||
| 5 | WSDL_TYPE_FILE |
Constant | Public | Type reference (TYPE) | WS_WB_TYPE | 'DATA' | use a (local) file as WSDL source | 20090311 | |
| 6 | WSDL_TYPE_HTTP |
Constant | Public | Type reference (TYPE) | WS_WB_TYPE | 'HTTP' | use the HTTP protocol to retrieve a WSDL file from internet | 20090311 | |
| 7 | WSDL_TYPE_UDDI |
Constant | Public | Type reference (TYPE) | WS_WB_TYPE | 'UDDI' | use UDDI repository as WSDL source | 20090311 | |
| 8 | WSDL_TYPE_URL |
Constant | Public | Type reference (TYPE) | WS_WB_TYPE | 'URL' | use URL as WSDL source | 20090311 | |
| 9 | WSDL_TYPE_XI |
Constant | Public | Type reference (TYPE) | WS_WB_TYPE | 'XI' | use XI as WSDL source | 20090311 | |
| 10 | WSDL_TYPE_XSTR |
Constant | Public | Type reference (TYPE) | WS_WB_TYPE | 'DATA' | use xstring as WSDL source | 20090311 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_URL |
Instance method | Public | Method | Checks reacheability of given URL | 20090527 |
| 2 | CREATE_LOGICAL_PORT |
Static method | Public | Method | Set the logical Port from the given local WSDL file | 20090316 |
| 3 | CREATE_PROXY_FROM_LOCAL_FILE |
Static method | Public | Method | Generate a Proxy from the given WSDL source | 20090311 |
| 4 | CREATE_PROXY_FROM_URL |
Static method | Public | Method | Generate a Proxy from the given WSDL source | 20090310 |
| 5 | GENERATE_PROXY |
Static method | Private | Method | Try to generate a Proxy from WSDL source | 20090310 |
| 6 | GET_PROXYNAMES |
Static method | Public | Method | list existing proxies in the system from PROXYNAMES table | 20090302 |
| 7 | GET_PROXY_METHODS |
Static method | Public | Method | Get lis of proxy methods and their metadata | 20090619 |
| 8 | GET_SP_METHOD_INFOS |
Static method | Public | Method | Delivers method meta data of Service Provider Proxies | 20090226 |
Events
Class CL_WCF_WSC_PROXY_API has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | LY_SEL_META_INFO | Public | See coding | 20090226 | BEGIN OF ly_sel_meta_info,
abap_method TYPE string,
attr TYPE string,
val TYPE string,
END OF ly_sel_meta_info
|
||
| 2 | TY_ATTR_VAL | Public | See coding | attribute (name) - value pairs | 20090226 | ty_attr_val TYPE STANDARD TABLE OF ly_sel_meta_info
|
Method Signatures
Method CHECK_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_HTTP_ERR | Call by reference | Type reference (TYPE) | CHAR11 | HTTP Error number or text | 20090716 | ||
| 2 | Exporting |
EV_HTTP_STATUS | Call by reference | Type reference (TYPE) | INT2 | Status code of URL check | 20090527 | ||
| 3 |  Importing |
IV_HTTP_PROXY | Call by reference | Type reference (TYPE) | STRING | Client web proxy name | 20090716 | ||
| 4 | Importing |
IV_HTTP_PROXY_PORT | Call by reference | Type reference (TYPE) | STRING | Client web proxy port number | 20090716 | ||
| 5 | Importing |
IV_URL | Value transfer | Type reference (TYPE) | STRING | URL to check | 20090527 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_CRM_WSC_FAULT |
Static exception class for web service consumption | 20090826 |
Method CREATE_LOGICAL_PORT Signature
Method CREATE_LOGICAL_PORT on class CL_WCF_WSC_PROXY_API has no parameter.
Method CREATE_LOGICAL_PORT on class CL_WCF_WSC_PROXY_API has no exception.
Method CREATE_PROXY_FROM_LOCAL_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_GENERATED_PROXIES | Call by reference | Type reference (TYPE) | SPROXNAMES | Proxy Generation: Table with Names of Generated Objects | 20090311 | ||
| 2 | Exporting |
ET_PROPOSED_NAMES | Call by reference | Type reference (TYPE) | PRX_PRPS_PROXIES | Proposed Names (Proxies) | 20090311 | ||
| 3 | Exporting |
EV_LOG_HANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | Application Log: Log Handle | 20090311 | ||
| 4 | Exporting |
EV_PROXY_CHANGED | Call by reference | Type reference (TYPE) | BOOLEAN | Set to true, if proxy was changed | 20090311 | ||
| 5 | Exporting |
EV_WORST_MSG_TYPE | Call by reference | Type reference (TYPE) | SY-MSGTY | Message Type | 20090311 | ||
| 6 | Importing |
IV_ACTIVATE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100121 | |||
| 7 | Importing |
IV_DEV_CLASS | Call by reference | Type reference (TYPE) | DEVCLASS | Development package to use - '$TMP' is possible | 20090311 | ||
| 8 | Importing |
IV_PERSIST_LOG | Call by reference | Type reference (TYPE) | BOOLEAN | Set to true, the generation log will be written to database | 20090311 | ||
| 9 | Importing |
IV_PROXY_NAMESPACE | Call by reference | Type reference (TYPE) | PRX_NSPCE | Namespace of generated Proxy | 20090311 | ||
| 10 | Importing |
IV_PROXY_PREFIX | Call by reference | Type reference (TYPE) | PRX_PREFIX | Prefix of generated Proxy | 20090311 | ||
| 11 | Importing |
IV_PROXY_TYPE | Call by reference | Type reference (TYPE) | PRX_TYPE | 'ifmmessif' | values see domain PRX_TYPE | 20090311 | |
| 12 | Importing |
IV_TRANSPORT_REQUEST | Call by reference | Type reference (TYPE) | KORRNUM | Existing transport/change request | 20090311 | ||
| 13 | Importing |
IV_WSDL_CONTENT | Call by reference | Type reference (TYPE) | XSTRING | Instead of giving file path u can extract the files XSTING | 20090311 | ||
| 14 | Importing |
IV_WSDL_FILE_PATH | Call by reference | Type reference (TYPE) | STRING | URL of WSDL | 20090311 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_AXT_OPERATION_FAILED |
Operation error | 20090511 | |
| 2 | CX_CRM_WSC_FAULT |
Static exception class for web service consumption | 20090511 |
Method CREATE_PROXY_FROM_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_GENERATED_PROXIES | Call by reference | Type reference (TYPE) | SPROXNAMES | Proxy Generation: Table with Names of Generated Objects | 20090310 | ||
| 2 | Exporting |
ET_PROPOSED_NAMES | Call by reference | Type reference (TYPE) | PRX_PRPS_PROXIES | Proposed Names (Proxies) | 20090310 | ||
| 3 | Exporting |
EV_LOG_HANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | Application Log: Log Handle | 20090310 | ||
| 4 | Exporting |
EV_PROXY_CHANGED | Call by reference | Type reference (TYPE) | BOOLEAN | Set to true, if proxy was changed | 20090310 | ||
| 5 | Exporting |
EV_WORST_MSG_TYPE | Call by reference | Type reference (TYPE) | SY-MSGTY | Message Type | 20090310 | ||
| 6 | Importing |
IT_PROPOSED_PROXY_NAMES | Call by reference | Type reference (TYPE) | PRX_PRPS_PROXIES | Proposed Names (Proxies) | 20090312 | ||
| 7 | Importing |
IV_ACTIVATE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100121 | |||
| 8 | Importing |
IV_CHECK_URL | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_TRUE | Boolean Variable (X=True, -=False, Space=Unknown) | 20090513 | |
| 9 | Importing |
IV_DEV_CLASS | Call by reference | Type reference (TYPE) | DEVCLASS | Development package to use - '$TMP' is possible | 20090310 | ||
| 10 | Importing |
IV_PERSIST_LOG | Call by reference | Type reference (TYPE) | BOOLEAN | Set to true, the generation log will be written to database | 20090310 | ||
| 11 | Importing |
IV_PROXY_NAMESPACE | Call by reference | Type reference (TYPE) | PRX_NSPCE | Namespace of generated Proxy | 20090310 | ||
| 12 | Importing |
IV_PROXY_PREFIX | Call by reference | Type reference (TYPE) | PRX_PREFIX | Prefix of generated Proxy | 20090310 | ||
| 13 | Importing |
IV_PROXY_TYPE | Call by reference | Type reference (TYPE) | PRX_TYPE | 'ifmmessif' | values see domain PRX_TYPE | 20090310 | |
| 14 | Importing |
IV_TRANSPORT_REQUEST | Call by reference | Type reference (TYPE) | KORRNUM | Existing transport/change request | 20090310 | ||
| 15 | Importing |
IV_WEB_PROXY_CLIENT | Call by reference | Type reference (TYPE) | SYMANDT | SY-MANDT | System client for web proxy to use for checking iv_wsdl_url | 20090513 | |
| 16 | Importing |
IV_WEB_PROXY_NAME | Call by reference | Type reference (TYPE) | STRING | 'PrOxY' | Name of system web proxy to use for checking iv_wsdl_url | 20090513 | |
| 17 | Importing |
IV_WEB_PROXY_PORT | Call by reference | Type reference (TYPE) | STRING | '8080' | Port number system web proxy to use for checking iv_wsdl_url | 20090513 | |
| 18 | Importing |
IV_WEB_PROXY_USER_NAME | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | System user of web proxy to use for checking iv_wsdl_url | 20090513 | |
| 19 | Importing |
IV_WSDL_URL | Call by reference | Type reference (TYPE) | STRING | URL of WSDL | 20090310 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_AXT_OPERATION_FAILED |
Operation error | 20090511 | |
| 2 | CX_CRM_WSC_FAULT |
Static exception class for web service consumption | 20090511 |
Method GENERATE_PROXY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_GEN_PROXIES | Call by reference | Type reference (TYPE) | SPROXNAMES | 20090310 | |||
| 2 | Exporting |
EV_CHANGED | Call by reference | Type reference (TYPE) | BOOLEAN | 20090310 | |||
| 3 | Exporting |
EV_LOG_HANDLE | Call by reference | Type reference (TYPE) | BALLOGHNDL | 20090310 | |||
| 4 | Exporting |
EV_MAX_ESCALATION | Call by reference | Type reference (TYPE) | SY-MSGTY | 20090310 | |||
| 5 | Exporting |
EV_NAME_PROPOSAL | Call by reference | Type reference (TYPE) | PRX_PRPS_PROXIES | 20090310 | |||
| 6 | Importing |
IT_PROPOSED_PROXY_NAME | Call by reference | Type reference (TYPE) | PRX_PRPS_PROXIES | 20090310 | |||
| 7 | Importing |
IV_ACTIVATE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100121 | |||
| 8 | Importing |
IV_CMP_NAME | Call by reference | Type reference (TYPE) | STRING | Component Name in table CVERS | 20090310 | ||
| 9 | Importing |
IV_CMP_VERS | Call by reference | Type reference (TYPE) | STRING | Component Version in table CVERS | 20090310 | ||
| 10 | Importing |
IV_DEV_CLASS | Call by reference | Type reference (TYPE) | DEVCLASS | Development package to use - '$TMP' is possible | 20090310 | ||
| 11 | Importing |
IV_NO_DLG | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_TRUE | Set to true as to not show any pop ups | 20090310 | |
| 12 | Importing |
IV_PERSIST_LOG | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | Persist generation log to database | 20090310 | |
| 13 | Importing |
IV_PROPOSED_BADI_NAME | Call by reference | Object reference (TYPE REF TO) | IF_PROXY_BADI_NAMEPROPOSAL | 20090310 | |||
| 14 | Importing |
IV_PROXY_NAMESPACE | Call by reference | Type reference (TYPE) | PRX_NSPCE | Namespace of generated Proxy | 20090310 | ||
| 15 | Importing |
IV_PROXY_PREFIX | Call by reference | Type reference (TYPE) | PRX_PREFIX | Prefix of generated Proxy | 20090310 | ||
| 16 | Importing |
IV_PROXY_TYPE | Call by reference | Type reference (TYPE) | PRX_TYPE | 'ifmmessif' | Type of generated Proxy, possible values see domain PRX_TYPE | 20090310 | |
| 17 | Importing |
IV_SHOW_LOG | Call by reference | Type reference (TYPE) | BOOLEAN | Set to true to show the log after generation in a pop up | 20090310 | ||
| 18 | Importing |
IV_TRANSPORT_REQ | Call by reference | Type reference (TYPE) | KORRNUM | Existing change request | 20090310 | ||
| 19 | Importing |
IV_WSDL | Call by reference | Type reference (TYPE) | XSTRING | (Binary) content of the WSDL file | 20090310 | ||
| 20 | Importing |
IV_WSDL_SUFFIX | Call by reference | Type reference (TYPE) | STRING | Suffix of WSDL file | 20090310 | ||
| 21 | Importing |
IV_WSDL_TYPE | Call by reference | Type reference (TYPE) | WS_WB_TYPE | Type of WSDL source. Use this class' attributes | 20090310 | ||
| 22 | Importing |
IV_WSDL_URL | Call by reference | Type reference (TYPE) | STRING | URI of the WSDL file | 20090310 |
Method GENERATE_PROXY on class CL_WCF_WSC_PROXY_API has no exception.
Method GET_PROXYNAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_PROXIES | Call by reference | Type reference (TYPE) | CL_PROXY_QUERY=>T_NAMESPACE_OBJECTS | Inquiry Results Row | 20090302 | ||
| 2 | Importing |
IV_METHOD | Call by reference | Type reference (TYPE) | STRING | Name of ABAP Method | 20090512 | ||
| 3 | Importing |
IV_OBJECT_NAME | Call by reference | Type reference (TYPE) | STRING | Name of proxy, wildcards allowed (Proxy Object Name) | 20090302 | ||
| 4 | Importing |
IV_WSDL_NAME | Call by reference | Type reference (TYPE) | STRING | Name of proxy. Wildcards allowed | 20090302 | ||
| 5 | Importing |
IV_WSDL_NAMESPACE | Call by reference | Type reference (TYPE) | PRX_R_NSPCE_T | Namespace (URI) of proxy. Wildcards allowed | 20090302 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NOTHING_FOUND |
no records were found that meet your criteria | 20090302 |
Method GET_PROXY_METHODS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PROXY_CLASS | Call by reference | Type reference (TYPE) | WSC_PROXY_NAME | Proxy Name | 20090619 | ||
| 2 |  Returning |
RT_METHODS_METADATA | Value transfer | Type reference (TYPE) | WSCT_METHOD_METADATA | List of methods with metadata | 20090619 |
Method GET_PROXY_METHODS on class CL_WCF_WSC_PROXY_API has no exception.
Method GET_SP_METHOD_INFOS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_METH_INFOS | Value transfer | Type reference (TYPE) | TY_ATTR_VAL | attribute (name) - value pairs | 20090226 | ||
| 2 | Importing |
IV_ATTRIB | Call by reference | Type reference (TYPE) | STRING | If you are interested in only one attribute, specify it here | 20090226 | ||
| 3 | Importing |
IV_ITERATIVE | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | Boolean Variable (X=True, -=False, Space=Unknown) | 20090226 | |
| 4 | Importing |
IV_METHOD | Call by reference | Type reference (TYPE) | PRX_R3NAME | Proxy Generation: Name of an Object in R/3 | 20090226 | ||
| 5 | Importing |
IV_PROXY_OBJ | Call by reference | Type reference (TYPE) | PRX_R3OBJ | 'CLAS' | Proxy Generation: Object Type in R3 (DTEL, TABL,...) | 20090226 | |
| 6 | Importing |
IV_PROXY_OBJ_NAME | Value transfer | Type reference (TYPE) | PRX_R3NAME | Proxy Generation: Name of an Object in R/3 | 20090226 |
Method GET_SP_METHOD_INFOS on class CL_WCF_WSC_PROXY_API has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 701 |
