SAP ABAP Class CL_ESH_ADAPT_CONN_MGR_OS (Adapter Connectivity Mgr. for Open Search)
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_OS | |
| Short Description | Adapter Connectivity Mgr. for Open Search | |
| 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 | 20081031 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_ESH_ADAPT_CONN_MGR_OS has no forward declaration.
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_OS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_ADAPTER_OPEN_SEARCH |
Constant | Private | Type reference (TYPE) | STRING | 'Open Search' | OpenSearch name | 20081112 | |
| 2 | CV_CONN_PARAM_AUTH_METHOD |
Constant | Private | Type reference (TYPE) | STRING | 'AUTH_METHOD' | Authentication method | 20081031 | |
| 3 | CV_CONN_PARAM_DESCRIPTION |
Constant | Private | Type reference (TYPE) | STRING | 'DESCRIPTION' | Description | 20081111 | |
| 4 | CV_CONN_PARAM_HTTP_DESTINATION |
Constant | Private | Type reference (TYPE) | STRING | 'HTTP_DEST' | HTTP destination | 20081031 | |
| 5 | CV_CONN_PARAM_PATH_TEMPLATE |
Constant | Private | Type reference (TYPE) | STRING | 'PATH_TEMPLATE' | Path template | 20081031 | |
| 6 | CV_CONN_PARAM_URL_TEMPLATE |
Constant | Private | Type reference (TYPE) | STRING | 'TEMPLATE' | Search URL template | 20081103 | |
| 7 | CV_CONN_PARAM_USER |
Constant | Private | Type reference (TYPE) | STRING | 'USER' | User | 20081031 | |
| 8 | CV_CONN_PARAM_XML_TYPE |
Constant | Private | Type reference (TYPE) | STRING | 'XML_TYPE' | XML response type | 20081104 | |
| 9 | CV_HTTP_DEST_CREATE |
Constant | Private | Type reference (TYPE) | RFCDISPLAY-RFCTRACE | 'I' | Http destination creation | 20081031 | |
| 10 | CV_HTTP_DEST_DELETE |
Constant | Private | Type reference (TYPE) | RFCDISPLAY-RFCTRACE | 'D' | Trace? | 20081031 | |
| 11 | CV_HTTP_DEST_UPDATE |
Constant | Private | Type reference (TYPE) | RFCDISPLAY-RFCTRACE | 'M' | Trace? | 20081031 | |
| 12 | CV_HTTP_LOGON_METHOD_BASIC |
Constant | Private | Type reference (TYPE) | RFCDISPLAZ-RFCSLOGIN | 'B' | Logon procedure | 20081031 | |
| 13 | CV_HTTP_LOGON_METHOD_NONE |
Constant | Private | Type reference (TYPE) | RFCDISPLAZ-RFCSLOGIN | 'A' | Logon method none | 20081031 | |
| 14 | CV_LOGON_METHOD_NO |
Constant | Private | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | '1' | ESH: Authentication settings | 20081031 | |
| 15 | CV_LOGON_METHOD_TICKET |
Constant | Private | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | '2' | ESH: Authentication settings | 20081031 | |
| 16 | CV_LOGON_METHOD_USER |
Constant | Private | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | '3' | ESH: Authentication settings | 20081031 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_HTTP_DESTINATION |
Static method | Private | Method | Create HTTP dest. | 20081031 |
| 2 | DELETE_HTTP_DESTINATION |
Static method | Private | Method | Create HTTP dest. | 20081031 |
| 3 | GET_GEN_CONNECTIVITY |
Static method | Public | Method | Build and return a new connectivity | 20081031 |
| 4 | GET_URL_DETAILS |
Static method | Private | Method | Get URL details | 20081031 |
| 5 | READ_DESCRIPTION |
Static method | Private | Method | Read OpenSearch description | 20081031 |
| 6 | READ_OS_CONNECTIVITY |
Static method | Public | Method | Get OpenSearch connectivity information | 20081104 |
| 7 | REMOVE_DESTINATION |
Static method | Public | Method | Remove HTTP dest. by connectivity | 20081103 |
| 8 | RETRIEVE_SEARCH_SERVICE |
Static method | Public | Method | Retrieve the OpenSearch search URL | 20081031 |
Events
Class CL_ESH_ADAPT_CONN_MGR_OS has no event.
Types
Class CL_ESH_ADAPT_CONN_MGR_OS has no local type.
Method Signatures
Method CREATE_HTTP_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_DESTINATION_NAME | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_DEST | HTTP Destination | 20081031 | ||
| 2 | Importing |
IV_HOST | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_HOST | HTTP Host | 20081031 | ||
| 3 | Importing |
IV_LOGON_METHOD | Call by reference | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | Authentication Settings | 20081031 | ||
| 4 | Importing |
IV_PATH | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PATH | HTTP Relative Path | 20081031 | ||
| 5 | Importing |
IV_PORT | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PORT | '80' | HTTP Port | 20081031 | |
| 6 | Importing |
IV_USERNAME | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_USER_NAME | User Name | 20081031 | ||
| 7 | Importing |
IV_USERPASS | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_PASSWORD | Password | 20081031 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081103 |
Method DELETE_HTTP_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DESTINATION_NAME | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_DEST | HTTP Destination | 20081031 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081103 |
Method GET_GEN_CONNECTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_GEN_CONNECTION | Call by reference | Type reference (TYPE) | ESH_S_ADM_GEN_CONNECTION | Connection Parameters | 20081031 | ||
| 2 | Importing |
IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20081031 | ||
| 3 | Importing |
IV_AUTH_METHOD | Call by reference | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20081031 | ||
| 4 | Importing |
IV_CONNECTION_GUID | Call by reference | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Connection GUID | 20081031 | ||
| 5 | Importing |
IV_DESCRIPTION | Call by reference | Type reference (TYPE) | ESH_E_IF_NAME | Readable Name | 20081111 | ||
| 6 | Importing |
IV_PASSWORD | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_PASSWORD | Pasword for KM user | 20081031 | ||
| 7 | Importing |
IV_SEARCH_URL_TEMPLATE | Call by reference | Type reference (TYPE) | ESH_E_IF_URL | Search Url Template | 20081031 | ||
| 8 | Importing |
IV_TEMPLATE_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | Template Type | 20081103 | ||
| 9 | Importing |
IV_USERNAME | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_USER_NAME | User name | 20081031 | ||
| 10 | Importing |
IV_XML_TYPE | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_XML_TYPE | XML Open Search Response Type | 20081104 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081103 |
Method GET_URL_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_HOST | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_HOST | HTTP Host | 20081031 | ||
| 2 | Exporting |
EV_PATH | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PATH | HTTP Relative Path | 20081031 | ||
| 3 | Exporting |
EV_PORT | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PORT | HTTP Port | 20081031 | ||
| 4 | Exporting |
EV_PROTOCOL | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_PROTOCOL | HTTP Protocol | 20081031 | ||
| 5 | Importing |
IV_URL | Call by reference | Type reference (TYPE) | ESH_E_IF_URL | URL in Enterprise Search | 20081031 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081103 |
Method READ_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_DESCRIPTION | Call by reference | Type reference (TYPE) | ESH_S_ADPT_OS_DESCRIPTION | Open Search Description | 20081031 | ||
| 2 | Importing |
IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20090210 | ||
| 3 | Importing |
IV_DESTINATION | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_HTTP_DEST | HTTP Destination | 20081031 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20090206 |
Method READ_OS_CONNECTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_OS_CONNECTION | Call by reference | Type reference (TYPE) | ESH_S_ADAPT_CONN_OS_CONN | ESH: connectivity data for Open Search | 20081104 | ||
| 2 | Importing |
IV_CONNECTION_GUID | Call by reference | Type reference (TYPE) | ESH_E_ADM_CONNECTION_GUID | Connection GUID | 20081104 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081104 |
Method REMOVE_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_GEN_CONNECTION | Call by reference | Type reference (TYPE) | ESH_S_ADM_GEN_CONNECTION | Connection Parameters | 20081103 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081103 |
Method RETRIEVE_SEARCH_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_DESCRIPTION | Call by reference | Type reference (TYPE) | ESH_E_IF_NAME | Readable Name | 20081031 | ||
| 2 | Exporting |
EV_SEARCH_URL_TEMPLATE | Call by reference | Type reference (TYPE) | ESH_E_IF_URL | URL in Enterprise Search (optional) | 20081111 | ||
| 3 | Exporting |
EV_XML_TYPE | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_XML_TYPE | XML Open Search Response Type | 20081104 | ||
| 4 | Importing |
IR_APPLOG | Call by reference | Object reference (TYPE REF TO) | IF_ESH_OM_APPLOG | Application Log | 20081031 | ||
| 5 | Importing |
IV_AUTH_METHOD | Call by reference | Type reference (TYPE) | ESH_ADAPT_CONN_AUTH_METHOD | '1' | ESH: Authentication Settings 1=no 2=logon ticket 3=basic | 20081031 | |
| 6 | Importing |
IV_DESCRIPTION_URL | Call by reference | Type reference (TYPE) | ESH_E_IF_URL | Description URL | 20081031 | ||
| 7 | Importing |
IV_PASSWORD | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_PASSWORD | Pasword for KM user | 20081031 | ||
| 8 | Importing |
IV_USERNAME | Call by reference | Type reference (TYPE) | ESH_E_ADAPT_CONN_USER_NAME | User name | 20081031 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_ADAPT_CONN_MGR_ERROR |
Error in Connectivity Manager | 20081103 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 720 |
