SAP ABAP Class CL_ESH_ADAPT_CONN_MGR_KM (Adapter Connectivity Mngr. for KM)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ADAPT_CONNECTIVITY_MGRS (Package) Adapter Connectivity Manager
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ADAPT_CONNECTIVITY_MGRS (Package) Adapter Connectivity ManagerMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ESH_ACM_DESCRIPTION | Connector Description Service | 20081111 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ESH_ACM_PRE_PROCESSING | Adapter Connectivity Mgr. Pre-Processing | 20081110 |
Properties
| Class | CL_ESH_ADAPT_CONN_MGR_KM | |
| Short Description | Adapter Connectivity Mngr. for KM | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ADAPT_CONNECTIVITY_MGRS | Adapter Connectivity Manager |
| Created | 20080919 | SAP |
| Last change | 20130531 | 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) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_ESH_ACM_DESCRIPTION | Connector Description Service | 20081111 | ||
| 2 | IF_ESH_ACM_PRE_PROCESSING | Adapter Connectivity Mgr. Pre-Processing | 20081110 |
Friends
Class CL_ESH_ADAPT_CONN_MGR_KM has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ADAPTER_TYPE |
Constant | Private | Type reference (TYPE) | STRING | 'KM' | Adapter type | 20081103 | |
| 2 | CG_KM_INDEX_MANAGER |
Constant | Private | Type reference (TYPE) | SRT_WSP_DT_OBJ_NAME | 'CO_KMCWS_INDEX_MANAGEMENT_WSVI' | Proxy class for KM Index Manager | 20080923 | |
| 3 | CG_KM_INDEX_SERVICE |
Constant | Private | Type reference (TYPE) | STRING | '/IndexManagementWS/Config1?style=document' | Prefix for KM Search Web Service | 20080923 | |
| 4 | GC_AUTH_METHOD |
Constant | Private | Type reference (TYPE) | STRING | 'AUTH_METH' | Authentification method | 20081014 | |
| 5 | GC_AUTH_METHODE |
Constant | Private | Type reference (TYPE) | STRING | 'AuthenticationMethod' | Auth. Method | 20081023 | |
| 6 | GC_AUTH_METH_ASSERT_TICKET |
Constant | Private | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | '2' | SAP authentication assertion ticket | 20081017 | |
| 7 | GC_AUTH_METH_NO_AUTH |
Constant | Private | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | '1' | No authentication | 20081017 | |
| 8 | GC_AUTH_METH_USER_PSW |
Constant | Private | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | '3' | User ID/password | 20081017 | |
| 9 | GC_AUTH_PASSW |
Constant | Private | Type reference (TYPE) | STRING | 'AuthenticationMethod.Basic.Password' | Auth-Method-passw | 20081023 | |
| 10 | GC_AUTH_USER |
Constant | Private | Type reference (TYPE) | STRING | 'AuthenticationMethod.Basic.Username' | Auth. Method-user | 20081023 | |
| 11 | GC_DESTINATION |
Constant | Private | Type reference (TYPE) | STRING | 'Destination' | HTTP destination | 20081104 | |
| 12 | GC_HOST |
Constant | Private | Type reference (TYPE) | STRING | 'HOST' | Target host | 20081014 | |
| 13 | GC_HTTP |
Constant | Private | Type reference (TYPE) | STRING | 'HTTP_DESTINATION' | HTTP-Destination | 20100303 | |
| 14 | GC_KM_INDEX |
Constant | Private | Type reference (TYPE) | STRING | 'KM_INDEX' | 20081014 | ||
| 15 | GC_KM_INDEX_MGR |
Constant | Public | Type reference (TYPE) | SEOCLSNAME | 'IF_KMC_INDEX_MGR' | KM Index Manager | 20081205 | |
| 16 | GC_KM_TEMPLATE_TYPE |
Constant | Private | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | 'KM' | KM template type | 20081014 | |
| 17 | GC_LPORT |
Constant | Private | Type reference (TYPE) | STRING | 'KM_LPORT' | Logical Port | 20081014 | |
| 18 | GC_MSGID_ESH_ADAPT_MSG |
Constant | Private | Type reference (TYPE) | SYMSGID | 'ESH_ADAPT_MSG' | Message class | 20081016 | |
| 19 | GC_MSGTY_E |
Constant | Private | Type reference (TYPE) | SYMSGTY | 'E' | Message type E | 20081016 | |
| 20 | GC_PORT |
Constant | Private | Type reference (TYPE) | STRING | 'PORT' | Number of port | 20081014 | |
| 21 | GC_PROTOCOL |
Constant | Private | Type reference (TYPE) | STRING | 'PROTOCOL' | Internet protocol | 20081014 | |
| 22 | GC_URL_HOST |
Constant | Private | Type reference (TYPE) | STRING | 'URLHost' | Host | 20081023 | |
| 23 | GC_URL_PORT |
Constant | Private | Type reference (TYPE) | STRING | 'URLPort' | Port | 20081023 | |
| 24 | GC_URL_PROTOCOL |
Constant | Private | Type reference (TYPE) | STRING | 'URLProtocol' | Protocol | 20081023 | |
| 25 | GC_USER |
Constant | Private | Type reference (TYPE) | STRING | 'USER' | User name | 20081014 | |
| 26 | GV_APPLOG |
Instance attribute | Private | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application log | 20081016 | ||
| 27 | GV_AUTH_METHOD |
Instance attribute | Private | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | ESH: Authentication settings | 20081014 | ||
| 28 | GV_HOST |
Instance attribute | Private | Type reference (TYPE) | RFCHOST_EXT | Name of target host | 20081014 | ||
| 29 | GV_HTTP |
Instance attribute | Private | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20100303 | ||
| 30 | GV_KM_INDEX |
Instance attribute | Private | Type reference (TYPE) | STRING | KM index | 20080919 | ||
| 31 | GV_LPORT |
Instance attribute | Private | Type reference (TYPE) | PRX_LOGICAL_PORT_NAME | Logical port name | 20080919 | ||
| 32 | GV_PORT |
Instance attribute | Private | Type reference (TYPE) | RFCSYSID | System ID | 20081014 | ||
| 33 | GV_PROTOCOL |
Instance attribute | Private | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PROTOCOL | Transfer log for online help | 20081014 | ||
| 34 | GV_USER |
Instance attribute | Private | Type reference (TYPE) | ESH_E_ADPT_KM_STRING | User name | 20081014 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20080919 |
| 2 | CONVERT_GEN_TO_KM |
Static method | Public | Method | Convert the general connectivity format into KM format | 20081014 |
| 3 | CREATE_LOGICAL_PORT |
Instance method | Private | Method | Create logical port to access KM server | 20080919 |
| 4 | DELETE_LOGICAL_PORT |
Static method | Public | Method | Delete logical port (by deleting the KM connector) | 20081017 |
| 5 | GET_GEN_AND_CONVERT_IN_LOGSYS |
Instance method | Public | Method | Convert the KM data into the general connectivity format | 20081023 |
| 6 | GET_INDEXES |
Static method | Public | Method | Get the indexes of the KM system | 20080919 |
| 7 | GET_LPORT |
Instance method | Public | Method | Get the new logical port | 20081013 |
| 8 | PING_DESTINATION |
Static method | Public | Method | Check if G destination is accessible | 20081103 |
| 9 | PING_WS |
Static method | Public | Method | Check if the KM WS is accessible | 20110705 |
| 10 | READ_INDEX |
Static method | Public | Method | Read the KM index from the common area (for searching) | 20080919 |
| 11 | READ_LPORT |
Static method | Public | Method | Read the logical port from the common area (for searching) | 20080919 |
| 12 | SET_INDEX |
Instance method | Public | Method | Set the selected index in the global attribute of the class | 20080919 |
Events
Class CL_ESH_ADAPT_CONN_MGR_KM has no event.
Types
Class CL_ESH_ADAPT_CONN_MGR_KM has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20081016 | ||
| 2 | Importing |
IV_AUTH_METHOD | Call by reference | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20081007 | ||
| 3 | Importing |
IV_HOST | Call by reference | Type reference (TYPE) | RFCHOST_EXT | Name of Target Host | 20080923 | ||
| 4 | Importing |
IV_LPORT | Call by reference | Type reference (TYPE) | SRT_LP_NAME | Logical Port Name | 20081016 | ||
| 5 | Importing |
IV_PASSWORD | Call by reference | Type reference (TYPE) | ESH_BI_USER_PSW | passw. for user in KM | 20080919 | ||
| 6 | Importing |
IV_PORT | Call by reference | Type reference (TYPE) | RFCSYSID | Nr. of the port | 20080923 | ||
| 7 | Importing |
IV_PROTOCOL | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PROTOCOL | Internet Protocol | 20080923 | ||
| 8 | Importing |
IV_USERNAME | Call by reference | Type reference (TYPE) | ESH_E_ADPT_KM_STRING | user in KM | 20080923 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20080923 |
Method CONVERT_GEN_TO_KM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_KM_CONNECTIONS | Call by reference | Type reference (TYPE) | ESH_T_ADAPT_CONN_KM_CONN | Multiple Connections in KM format | 20081014 | ||
| 2 | Importing |
IT_GEN_CONNECTIONS | Call by reference | Type reference (TYPE) | ESH_T_ADM_GEN_CONNECTION | Multiple Connections in gen format | 20081014 |
Method CONVERT_GEN_TO_KM on class CL_ESH_ADAPT_CONN_MGR_KM has no exception.
Method CREATE_LOGICAL_PORT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_AUTH_METHOD | Call by reference | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20081007 | ||
| 2 | Importing |
IV_HOST | Call by reference | Type reference (TYPE) | RFCHOST_EXT | Name of Target Host | 20080923 | ||
| 3 | Importing |
IV_PASSWORD | Call by reference | Type reference (TYPE) | ESH_BI_USER_PSW | Pasword for KM user | 20080923 | ||
| 4 | Importing |
IV_PORT | Call by reference | Type reference (TYPE) | RFCSYSID | Nr. of port | 20080923 | ||
| 5 | Importing |
IV_PROTOCOL | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PROTOCOL | Internet Protocol | 20080923 | ||
| 6 | Importing |
IV_USERNAME | Call by reference | Type reference (TYPE) | ESH_E_ADPT_KM_STRING | User name | 20080923 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20080923 |
Method DELETE_LOGICAL_PORT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20081017 | ||
| 2 | Importing |
IV_LPORT | Call by reference | Type reference (TYPE) | SRT_LP_NAME | Logical Port Name | 20081017 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081017 |
Method GET_GEN_AND_CONVERT_IN_LOGSYS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_LOGSYS_EXT | Value transfer | Type reference (TYPE) | ESH_T_OM_LOGSYS_EXT | Table Type for ESH_S_OM_LOGSYS_EXT | 20081023 | ||
| 2 | Importing |
IV_CONNECTION_GUID | Call by reference | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20081023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081023 |
Method GET_INDEXES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_INDEX | Value transfer | Type reference (TYPE) | SXES_T_OBJECT_TYPE_DESCRS | Object type descriptions | 20080924 | ||
| 2 | Importing |
IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20081016 | ||
| 3 | Importing |
IV_LPORT | Call by reference | Type reference (TYPE) | SRT_LP_NAME | Logical Port Name | 20081016 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20080924 |
Method GET_LPORT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_LPORT | Value transfer | Type reference (TYPE) | SRT_LP_NAME | Logical Port Name | 20081013 |
Method GET_LPORT on class CL_ESH_ADAPT_CONN_MGR_KM has no exception.
Method PING_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | HTTP destination | 20100303 | ||
| 2 | Importing |
IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20081104 | ||
| 3 | Importing |
IV_LPORT | Call by reference | Type reference (TYPE) | PRX_LOGICAL_PORT_NAME | Logical Port Name | 20081103 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081104 |
Method PING_WS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20110705 | ||
| 2 | Importing |
IV_CONSUMER_PROXY | Call by reference | Type reference (TYPE) | SRT_WSP_DT_OBJ_NAME | WSP Name of Interface Object | 20110705 | ||
| 3 | Importing |
IV_LPORT | Call by reference | Type reference (TYPE) | PRX_LOGICAL_PORT_NAME | Logical Port Name | 20110705 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20110705 |
Method READ_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_INDEX | Value transfer | Type reference (TYPE) | STRING | KM index | 20080925 | ||
| 2 | Importing |
IV_CONNECTION_GUID | Call by reference | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Connection GUID | 20081008 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20080925 |
Method READ_LPORT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_LPORT | Value transfer | Type reference (TYPE) | PRX_LOGICAL_PORT_NAME | Logical port of the KM system | 20080925 | ||
| 2 | Importing |
IV_CONNECTION_GUID | Call by reference | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Connection GUID | 20081008 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20080925 |
Method SET_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_INDEX | Value transfer | Type reference (TYPE) | SXES_D_OBJECT_TYPE_DISP_NAME | selected KM index | 20080924 |
Method SET_INDEX on class CL_ESH_ADAPT_CONN_MGR_KM has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 720 |
