SAP ABAP Class CL_ESH_IF_DATA_PROVIDER_REMOTE (Data Provider for Remote Connections)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_INTERFACE (Package) Interface
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_INTERFACE (Package) InterfaceMeta Relationship - Using
Properties
| Class | CL_ESH_IF_DATA_PROVIDER_REMOTE | |
| Short Description | Data Provider for Remote Connections | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_INTERFACE | Interface |
| Created | 20081117 | 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) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_ESH_IF_DATA_PROVIDER_MULTI | Data provider with dest. handling and mass enabl. | 20081117 | ||
| 2 | IF_ESH_IF_DATA_PROVIDER_MULT_I | Instances of included interfaces of data provider multi | 20081117 | ||
| 3 | IF_ESH_IF_NODE_DESCRIPTOR | Node type descriptor | 20090817 | ||
| 4 | IF_ESH_IF_OBJECT_DATA_BY_ID | Object data by list of object ids | 20081117 | ||
| 5 | IF_ESH_IF_OBJECT_DESCRIPTOR | Object type descriptor | 20090817 | ||
| 6 | IF_ESH_IF_OBJECT_EXTR_PR_MULTI | Object data extraction preparation (internal!) | 20100809 | ||
| 7 | IF_ESH_IF_OBJECT_ITERATOR | Object data iterator by last object id | 20081117 | ||
| 8 | IF_ESH_IF_OBJECT_ITERATOR_TIME | Object data iterator by last timestamp | 20081117 | ||
| 9 | IF_ESH_IF_SW_COMP_DESCRIPTOR | Software Component Descriptor | 20090817 |
Friends
Class CL_ESH_IF_DATA_PROVIDER_REMOTE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MT_OBJECT_TYPE_DETAILS |
Instance attribute | Protected | Type reference (TYPE) | ESH_T_INT_CLUSTER | Data cluster container | 20081117 | ||
| 2 | MV_HOME_SOFTWARE_COMPONENT |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_OM_SYSREL | System/release | 20090125 | ||
| 3 | MV_NODE_DESCRIPTOR |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | 20090818 | |||
| 4 | MV_NODE_TYPE_BACKEND_NAME |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Back-end name | 20090903 | ||
| 5 | MV_NODE_TYPE_ID |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_OM_NODE_NAME | Node name | 20090818 | ||
| 6 | MV_OBJECT_DATA_BY_ID |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 7 | MV_OBJECT_DESCRIPTOR |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 8 | MV_OBJECT_EXTR_PREP |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | 20100809 | |||
| 9 | MV_OBJECT_ITERATOR |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 10 | MV_OBJECT_ITERATOR_TIME |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 11 | MV_OBJECT_TYPE_BACKEND_NAME |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Back-end name | 20081117 | ||
| 12 | MV_OBJECT_TYPE_ID |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object type | 20081117 | ||
| 13 | MV_PROVIDER_ID |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_IF_PROVIDER_ID | Provider ID | 20081117 | ||
| 14 | MV_RFC_DESTINATION |
Instance attribute | Protected | Type reference (TYPE) | RFCDEST | Logical destination (specified in function call) | 20081117 | ||
| 15 | MV_SW_COMP_DESCRIPTOR |
Instance attribute | Protected | Type reference (TYPE) | ABAP_BOOL | 20090818 | |||
| 16 | MV_SW_COMP_ID |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Back-end name | 20090818 | ||
| 17 | SC_OWN_CLASS |
Constant | Protected | Type reference (TYPE) | CHAR30 | 'CL_ESH_IF_DATA_PROVIDER_REMOTE' | Own class name | 20100809 | |
| 18 | ST_CHECKED_RFC_DEST |
Static Attribute | Protected | Type reference (TYPE) | LTT_CHECKED_RFC_DEST | 20081117 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_RFC_DESTINATION |
Static method | Protected | Method | Check if RFC destination can be used for common runtime | 20081117 |
| 2 | CONSTRUCTOR |
Instance method | Protected | Constructor | Constructor | 20081117 |
| 3 | GET_DATA |
Instance method | Protected | Method | Get data | 20081117 |
| 4 | GET_EXCEPTION_BY_FAILURE |
Static method | Private | Method | Get a provider exception with detail messages by RFC failure | 20090302 |
| 5 | GET_INSTANCE |
Static method | Protected | Method | Get instance (internal) | 20081117 |
| 6 | GET_RFC_DESTINATION |
Static method | Protected | Method | Get RFC destination from connectivity | 20081117 |
Events
Class CL_ESH_IF_DATA_PROVIDER_REMOTE has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | LST_CHECKED_RFC_DEST | Protected | See coding | 20081117 | begin of lst_checked_rfc_dest,
rfc_destination type rfcdest,
system_reachable type abap_bool,
has_common_runtime type abap_bool,
END OF lst_checked_rfc_dest
|
||
| 2 | LTT_CHECKED_RFC_DEST | Protected | See coding | 20081117 | ltt_checked_rfc_dest type sorted table of lst_checked_rfc_dest
WITH UNIQUE KEY rfc_destination
|
Method Signatures
Method CHECK_RFC_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IR_MESSAGES | Call by reference | Object reference (TYPE REF TO) | BAPIRETTAB | Table with BAPI Return Information | 20081117 | ||
| 2 | Importing |
IV_FORCE_RETRY | Call by reference | Type reference (TYPE) | ABAP_BOOL | Force retry after successful check | 20081117 | ||
| 3 | Importing |
IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20081117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20081117 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_OBJECT_TYPE_DETAILS | Call by reference | Type reference (TYPE) | ESH_T_INT_CLUSTER | Data Cluster Container | 20081117 | ||
| 2 | Importing |
IV_HOME_SOFTWARE_COMPONENT | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSREL | System/Release | 20090125 | ||
| 3 | Importing |
IV_NODE_DESCRIPTOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090818 | |||
| 4 | Importing |
IV_NODE_TYPE_BACKEND_NAME | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20090903 | ||
| 5 | Importing |
IV_NODE_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_NODE_NAME | Node Name | 20090818 | ||
| 6 | Importing |
IV_OBJECT_DATA_BY_ID | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 7 | Importing |
IV_OBJECT_DESCRIPTOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 8 | Importing |
IV_OBJECT_EXTR_PREP | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100809 | |||
| 9 | Importing |
IV_OBJECT_ITERATOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 10 | Importing |
IV_OBJECT_ITERATOR_TIME | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 11 | Importing |
IV_OBJECT_TYPE_BACKEND_NAME | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20081117 | ||
| 12 | Importing |
IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20081117 | ||
| 13 | Importing |
IV_PROVIDER_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_PROVIDER_ID | Provider ID | 20081117 | ||
| 14 | Importing |
IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20081117 | ||
| 15 | Importing |
IV_SW_COMP_DESCRIPTOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090818 | |||
| 16 | Importing |
IV_SW_COMP_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20090818 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_NOT_SUPPORTED |
Interface not supported | 20081117 | |
| 2 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20081117 | |
| 3 | CX_ESH_IF_UNKNOWN_ID |
Provided ID is unknown | 20081117 |
Method GET_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Feedback on global extract execution level | 20081117 | ||
| 2 | Exporting |
ET_OBJECT_FEEDBACK | Call by reference | Type reference (TYPE) | ESH_T_IF_OBJECT_FEEDBACK | Feedback for objects which could not be extracted | 20090714 | ||
| 3 | Exporting |
EV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | General ID | 20081117 | ||
| 4 | Exporting |
EV_LAST_OBJECT_ID_STRING | Call by reference | Type reference (TYPE) | ESH_E_IF_IDENTIFIER_STRING | Unique unlimited identifier | 20110125 | ||
| 5 | Exporting |
EV_LAST_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun) | 20081117 | ||
| 6 | Exporting |
EV_NO_MORE_DATA | Call by reference | Type reference (TYPE) | XFELD | Checkbox | 20081117 | ||
| 7 | Importing |
IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20081117 | ||
| 8 | Importing |
IT_OBJECT_IDS | Call by reference | Type reference (TYPE) | ESH_T_IF_CHANGED_OBJECTS | Changed Objects | 20081117 | ||
| 9 | Importing |
IV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | General ID | 20081117 | ||
| 10 | Importing |
IV_LAST_OBJECT_ID_STRING | Call by reference | Type reference (TYPE) | ESH_E_IF_IDENTIFIER_STRING | Unique unlimited identifier | 20110125 | ||
| 11 | Importing |
IV_LAST_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun) | 20081117 | ||
| 12 | Importing |
IV_OBJECT_DATA_BY_ID | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 13 | Importing |
IV_OBJECT_ITERATOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 14 | Importing |
IV_OBJECT_ITERATOR_TIME | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 15 | Importing |
IV_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ESH_E_IF_PACKAGE_SIZE | Package size | 20081117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20081117 |
Method GET_EXCEPTION_BY_FAILURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FAILURE_TYPE | Call by reference | Type reference (TYPE) | SYST-SUBRC | 1 = system_failure, 2 = communication_failure | 20090302 | ||
| 2 | Importing |
IV_MESSAGE_TEXT | Call by reference | Type reference (TYPE) | BAPI_MSG | Message text of failure | 20090302 | ||
| 3 | Importing |
IV_RFC_DESTINATION | Call by reference | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20090302 | ||
| 4 | Importing |
IV_RFC_FUNCTION_MODULE | Call by reference | Type reference (TYPE) | RS38L_FNAM | Name of Function Module | 20090302 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20090302 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_CONNECTIVITY | Call by reference | Object reference (TYPE REF TO) | CL_ESH_ADM_ANY_CONNECTIVITY | Connectivity details | 20081117 | ||
| 2 | Importing |
IV_HOME_SOFTWARE_COMPONENT | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSREL | System/Release | 20090125 | ||
| 3 | Importing |
IV_NODE_DESCRIPTOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090818 | |||
| 4 | Importing |
IV_NODE_TYPE_BACKEND_NAME | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20090903 | ||
| 5 | Importing |
IV_NODE_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_NODE_NAME | Node Name | 20090818 | ||
| 6 | Importing |
IV_OBJECT_DATA_BY_ID | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 7 | Importing |
IV_OBJECT_DESCRIPTOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 8 | Importing |
IV_OBJECT_EXTR_PREP | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100809 | |||
| 9 | Importing |
IV_OBJECT_ITERATOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 10 | Importing |
IV_OBJECT_ITERATOR_TIME | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20081117 | |||
| 11 | Importing |
IV_OBJECT_TYPE_BACKEND_NAME | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20081117 | ||
| 12 | Importing |
IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20081117 | ||
| 13 | Importing |
IV_PROVIDER_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_PROVIDER_ID | Provider ID | 20081117 | ||
| 14 | Importing |
IV_SW_COMP_DESCRIPTOR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090818 | |||
| 15 | Importing |
IV_SW_COMP_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20090818 | ||
| 16 |  Returning |
RR_DATA_PROVIDER_REMOTE | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_DATA_PROVIDER_REMOTE | Data Provider for Remote Connections | 20081117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_NOT_SUPPORTED |
Interface not supported | 20081117 | |
| 2 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20081117 | |
| 3 | CX_ESH_IF_UNKNOWN_ID |
Provided ID is unknown | 20081117 |
Method GET_RFC_DESTINATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_CONNECTIVITY | Call by reference | Object reference (TYPE REF TO) | CL_ESH_ADM_ANY_CONNECTIVITY | Connectivity details | 20081117 | ||
| 2 | Importing |
IR_MESSAGES | Call by reference | Object reference (TYPE REF TO) | BAPIRETTAB | Table with BAPI Return Information | 20081117 | ||
| 3 | Returning |
RV_RFC_DESTINATION | Value transfer | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20081117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20081117 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 720 |
