SAP ABAP Class CL_ESH_INT_REMOTESEARCH_CONF (Remote Search configuration)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     S_ESH_ENG_INTEGRATION (Package) Backend Integration Services
Properties
Class CL_ESH_INT_REMOTESEARCH_CONF  
Short Description Remote Search configuration    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class ESH_INTEGRATION    
Program status     
Category 0   
Package S_ESH_ENG_INTEGRATION   Backend Integration Services 
Created 20130814   SAP 
Last change 20141121    
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
Class CL_ESH_INT_REMOTESEARCH_CONF has no interface implemented.
Friends
Class CL_ESH_INT_REMOTESEARCH_CONF has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 APPLOG Instance attribute Private Object reference (TYPE REF TO) IF_ESH_OM_APPLOG Application Log 20130814
2 R_BACKUP_LOCK Instance attribute Private Object reference (TYPE REF TO) CL_ESH_CO_LOCK Lock on a Database Table 20130814
3 S_CONNECTION Instance attribute Private Type reference (TYPE) ESH_S_ADM_RFC_CONN_USR Data for RFC connection including user data 20130814
Methods
# Method Level Visibility Method type Description Created on
1 BCK_DEL_BACKEND_PROPERTY Static method Private Method 20130819
2 BCK_REGISTER_PROXY Static method Private Method 20130819
3 BCK_SET_BACKEND_PROPERTY Static method Private Method 20130819
4 BCK_UNREGISTER_PROXY Static method Private Method 20130819
5 CONNECT_BACKEND Instance method Public Method PROXY: Disconnect backend 20130819
6 CONNECT_TO_PROXY Static method Public Method BACKEND: Reverse connect to proxy 20130819
7 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20130814
8 DB_CONNECTION_PING Static method Public Method PROXY: Test DB connection 20130821
9 DETACH_FROM_PROXY Static method Public Method BACKEND: Unilaterally detach backend 20130819
10 DISCONNECT_BACKEND Instance method Public Method PROXY: Disconnect backend 20130819
11 DISCONNECT_FROM_PROXY Static method Public Method BACKEND: Delete reverse connection to proxy 20130819
12 GET_BACKENDS Static method Public Method PROXY: Get all backend conenctions 20130819
13 PRX_CHECK_FOR_ERRORS Instance method Private Method 20130819
14 PRX_CONNECT_BACKEND Instance method Private Method 20130819
15 PRX_CREATE_USER Instance method Private Method 20130904
16 PRX_DEL_PROXY_PROPERTY Static method Private Method 20130819
17 PRX_DISCARD_CONNECTION Instance method Private Method 20130819
18 PRX_DISCARD_CONNECTION2 Instance method Private Method 20131014
19 PRX_DISCARD_RUNTIME_BUFFER Instance method Private Method 20130819
20 PRX_DISCONNECT_BACKEND Instance method Private Method 20130819
21 PRX_GENERATE_REVERSE_CONN_USER Instance method Private Method 20130819
22 PRX_GET_RUNTIME_BUFFER Instance method Private Method 20130819
23 PRX_PUT_MESSAGES_TO_LOG Instance method Private Method 20130819
24 PRX_SET_CONNECTION Instance method Private Method 20130830
25 PRX_SET_CONNECTION_DATA Instance method Private Method 20130819
26 PRX_SET_PROXY_PROPERTY Static method Private Method 20130819
27 PRX_UNLOCK Instance method Private Method 20130819
28 REGISTER_AS_BACKEND Static method Public Method BACKEND: Set system to act as backend 20130819
29 REGISTER_AS_PROXY Static method Public Method PROXY: Set system to act as proxy 20130819
30 UNREGISTER_AS_BACKEND Static method Public Method BACKEND: Set system not to act as backend 20130819
31 UNREGISTER_AS_PROXY Static method Public Method PROXY: Set system not to act as proxy 20130819
Events
# Event Type Visibility Description Created on
1 BACKEND_ADDED Static Event
(1)
Public
(2)
20130819
2 BACKEND_REMOVED Static Event
(1)
Public
(2)
20130819
3 PROXY_ADDED Static Event
(1)
Public
(2)
20130819
4 PROXY_REMOVED Static Event
(1)
Public
(2)
20130819
Types
Class CL_ESH_INT_REMOTESEARCH_CONF has no local type.
Method Signatures

Method BCK_DEL_BACKEND_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMMIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130819

Method BCK_DEL_BACKEND_PROPERTY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method BCK_REGISTER_PROXY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMMIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130819
2 Importing IV_PROXY_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819

Method BCK_REGISTER_PROXY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method BCK_SET_BACKEND_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMMIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130819

Method BCK_SET_BACKEND_PROPERTY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method BCK_UNREGISTER_PROXY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMMIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130819
2 Importing IV_PROXY_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819

Method BCK_UNREGISTER_PROXY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method CONNECT_BACKEND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CLIENT Call by reference Type reference (TYPE) ESH_CLIENT Client 20130823
2 Importing IV_DB_CONNECTION_BACKEND Call by reference Type reference (TYPE) RFCDEST Trex/HANA (prefixes :RFC:/ :DB:) 20130819
3 Importing IV_DESCRIPTION Call by reference Type reference (TYPE) ESH_E_OM_DESCRIPTION Description 20130819
4 Importing IV_PASSWORD Call by reference Type reference (TYPE) RFCAUTH Explicit password 20130823
5 Importing IV_SERVER_NAME Call by reference Type reference (TYPE) RFCHOST Name of target host 20130823
6 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) ESH_SYSYSID System ID 20130823
7 Importing IV_SYSTEM_NUMBER Call by reference Type reference (TYPE) RFCSERVICE Service used (TCP service, SAP System number) 20130823
8 Importing IV_USERNAME Call by reference Type reference (TYPE) RFCUSER Explicit user ID 20130823
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method CONNECT_TO_PROXY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_RETURN_CODES Value transfer Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20130830
2 Exporting EV_DB_SCHEMA Call by reference Type reference (TYPE) ESH_E_ADM_HDB_DBSCHEMA Database Schema 20130830
3 Importing IV_APPLSERVER Call by reference Type reference (TYPE) RFCHOST Name of target host 20130819
4 Importing IV_CLIENT Call by reference Type reference (TYPE) MANDT Client 20130819
5 Importing IV_LANGU Call by reference Type reference (TYPE) SYLANGU Language Key 20130819
6 Importing IV_LOGSYS Call by reference Type reference (TYPE) LOGSYS Logical system 20130819
7 Importing IV_PASSWORD Call by reference Type reference (TYPE) XUNCODE New password 20130819
8 Importing IV_STEXT Call by reference Type reference (TYPE) RFCDOC_D Description of RFC connection 20130819
9 Importing IV_SYSTEMID Call by reference Type reference (TYPE) SYSYSID Name of SAP System 20130819
10 Importing IV_SYSTEMNO Call by reference Type reference (TYPE) RSTSPREFIX Transfer structure prefix for a source system 20130819
11 Importing IV_USER_NAME Call by reference Type reference (TYPE) XUBNAME User Name in User Master Record 20130819

Method CONNECT_TO_PROXY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

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 20130814
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130814

Method DB_CONNECTION_PING 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 20130821
2 Importing IV_DB_CONNECTION_BACKEND Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130821
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130821

Method DETACH_FROM_PROXY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ALL_PROXIES Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130819
2 Importing IV_PROXY_DESTINATION Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819
3 Returning RT_RETURN_CODES Value transfer Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20130819

Method DETACH_FROM_PROXY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method DISCONNECT_BACKEND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONNECTION_GUID Call by reference Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20130826
2 Importing IV_FORCE_DISCONNECT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130819
3 Importing IV_RFCDEST_BACKEND Call by reference Type reference (TYPE) RFCDEST 20130819
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method DISCONNECT_FROM_PROXY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LOGSYS Call by reference Type reference (TYPE) LOGSYS Logical system 20130819
2 Returning RT_RETURN_CODES Value transfer Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20130819

Method DISCONNECT_FROM_PROXY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method GET_BACKENDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CONNECTIONS Call by reference Type reference (TYPE) ESH_T_ADM_RFC_CONN_USR Table type for structure ESH_S_ADM_RFC_CONN_USR 20130819
2 Exporting ET_DESCRIPTIONS Call by reference Type reference (TYPE) ESH_T_OM_LOGSYST_EXT Table Type for ESH_S_OM_LOGSYST_EXT 20130819

Method GET_BACKENDS on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method PRX_CHECK_FOR_ERRORS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RETURN_CODES Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20130819
2 Returning RV_ERROR Value transfer Type reference (TYPE) ABAP_BOOL 20130819

Method PRX_CHECK_FOR_ERRORS on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method PRX_CONNECT_BACKEND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DESCRIPTION Call by reference Type reference (TYPE) ESH_E_OM_DESCRIPTION Descriptions 20130819
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method PRX_CREATE_USER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_NAME Call by reference Type reference (TYPE) RFCUSER Explicit user ID 20130904
2 Exporting EV_PASSWORD Call by reference Type reference (TYPE) RFCAUTH Explicit password 20130904
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130904

Method PRX_DEL_PROXY_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMMIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130819

Method PRX_DEL_PROXY_PROPERTY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method PRX_DISCARD_CONNECTION Signature

Method PRX_DISCARD_CONNECTION on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method PRX_DISCARD_CONNECTION2 Signature

Method PRX_DISCARD_CONNECTION2 on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20131014

Method PRX_DISCARD_RUNTIME_BUFFER Signature

Method PRX_DISCARD_RUNTIME_BUFFER on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method PRX_DISCONNECT_BACKEND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_FORCE_DISCONNECT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130819
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method PRX_GENERATE_REVERSE_CONN_USER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_CONNECTION Value transfer Type reference (TYPE) ESH_S_ADM_RFC_CONN_USR Data for RFC connection including user data 20130819
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method PRX_GET_RUNTIME_BUFFER Signature

Method PRX_GET_RUNTIME_BUFFER on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method PRX_PUT_MESSAGES_TO_LOG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RETURN_CODES Call by reference Type reference (TYPE) BAPIRETTAB Table with BAPI Return Information 20130819
2 Importing IV_MSGID Call by reference Type reference (TYPE) SYMSGID Message Class 20130819
3 Importing IV_MSGNO Call by reference Type reference (TYPE) SYMSGNO Message Number 20130819
4 Importing IV_MSGTY Call by reference Type reference (TYPE) SYMSGTY Message Type 20130819
5 Importing IV_MSGV1 Call by reference Type reference (TYPE) SYMSGV Message Variable 20130819
6 Importing IV_MSGV2 Call by reference Type reference (TYPE) SYMSGV Message Variable 20130819
7 Importing IV_MSGV3 Call by reference Type reference (TYPE) SYMSGV Message Variable 20130819
8 Importing IV_MSGV4 Call by reference Type reference (TYPE) SYMSGV Message Variable 20130819

Method PRX_PUT_MESSAGES_TO_LOG on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method PRX_SET_CONNECTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_DESCRIPTION Call by reference Type reference (TYPE) ESH_E_OM_DESCRIPTION Descriptions 20130830
2 Importing IV_DESCRIPTION_ONLY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130920
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130830

Method PRX_SET_CONNECTION_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CLIENT Call by reference Type reference (TYPE) ESH_CLIENT Client 20130823
2 Importing IV_CONNECTION_GUID Call by reference Type reference (TYPE) ESH_E_ADM_CONNECTION_GUID Connection GUID 20130826
3 Importing IV_DB_CONNECTION_BACKEND Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819
4 Importing IV_NEW Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130819
5 Importing IV_PASSWORD Call by reference Type reference (TYPE) RFCAUTH Explicit password 20130823
6 Importing IV_RFCDEST_BACKEND Call by reference Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819
7 Importing IV_SERVER_NAME Call by reference Type reference (TYPE) RFCHOST Name of target host 20130823
8 Importing IV_SYSTEM_ID Call by reference Type reference (TYPE) ESH_SYSYSID System ID 20130823
9 Importing IV_SYSTEM_NUMBER Call by reference Type reference (TYPE) RFCSERVICE Service used (TCP service, SAP System number) 20130823
10 Importing IV_USERNAME Call by reference Type reference (TYPE) RFCUSER Explicit user ID 20130823
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method PRX_SET_PROXY_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_COMMIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130819

Method PRX_SET_PROXY_PROPERTY on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method PRX_UNLOCK Signature

Method PRX_UNLOCK on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
Method PRX_UNLOCK on class CL_ESH_INT_REMOTESEARCH_CONF has no exception.

Method REGISTER_AS_BACKEND Signature

Method REGISTER_AS_BACKEND on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method REGISTER_AS_PROXY Signature

Method REGISTER_AS_PROXY on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method UNREGISTER_AS_BACKEND Signature

Method UNREGISTER_AS_BACKEND on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819

Method UNREGISTER_AS_PROXY Signature

Method UNREGISTER_AS_PROXY on class CL_ESH_INT_REMOTESEARCH_CONF has no parameter.
# Exception Resumable Description Created on
1 CX_ESH_INT_ENGINE ESH Integration Exception 20130819
Event Signatures

Event BACKEND_ADDED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 RFC_DESTINATION Exporting Value transfer Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819

Event BACKEND_REMOVED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 RFC_DESTINATION Exporting Value transfer Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819

Event PROXY_ADDED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 RFC_DESTINATION Exporting Value transfer Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819

Event PROXY_REMOVED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 RFC_DESTINATION Exporting Value transfer Type reference (TYPE) RFCDEST Logical Destination (Specified in Function Call) 20130819
History
Last changed by/on SAP  20141121 
SAP Release Created in 740