SAP ABAP Class CL_SEFS_LDAP_EX_TOOLS (Tools for Extraction of LDAP Information for FS)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-TRX-EFS (Application Component) TREX Enterprise File Search
     SEFS_LDAP_EXTRACT (Package) File Search Extraction of LDAP Data
Properties
Class CL_SEFS_LDAP_EX_TOOLS  
Short Description Tools for Extraction of LDAP Information for FS    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SEFS_LDAP_EXTRACT   File Search Extraction of LDAP Data 
Created 20100803   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
Class CL_SEFS_LDAP_EX_TOOLS has no interface implemented.
Friends
Class CL_SEFS_LDAP_EX_TOOLS has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_MESSAGE_ID Constant Public Type reference (TYPE) SYST-MSGID 'SEFS_LDAP_MSG' Message class 20100803
2 GC_TEMPLATE_TYPE Constant Private Type reference (TYPE) CHAR14 'TEMPLATE_TYPE' Text field length 14 20100809
3 GS_LDAP_STATE Static Attribute Protected Type reference (TYPE) SEFS_S_LDAP_STATE Current state of LDAP server 20100803
4 GT_USERGROUP_HIER Static Attribute Private Type reference (TYPE) SEFS_T_LDAP_USERGROUP_HIER Table type for LDAP user group hierarchies 20100805
5 GT_USERGROUP_SID_DATA Static Attribute Private Type reference (TYPE) SEFS_T_LDAP_USERGROUP_DATA Usergroup data in LDAP 20100806
6 GV_FIRST_TIME Static Attribute Private Type reference (TYPE) ABAP_BOOL 'X' 20100811
7 SC_MSG_TYPE_ABORT Constant Public Type reference (TYPE) SYMSGTY 'A' Message Type 20100803
8 SC_MSG_TYPE_DEBUG Constant Public Type reference (TYPE) SYMSGTY 'D' Message Type 20100803
9 SC_MSG_TYPE_ERROR Constant Public Type reference (TYPE) SYMSGTY 'E' Message Type 20100803
10 SC_MSG_TYPE_INFO Constant Public Type reference (TYPE) SYMSGTY 'I' Message Type 20100803
11 SC_MSG_TYPE_SUCCESS Constant Public Type reference (TYPE) SYMSGTY 'S' Message Type 20100803
12 SC_MSG_TYPE_WARNING Constant Public Type reference (TYPE) SYMSGTY 'W' Message Type 20100803
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_ADM_AUTHORITIES Static method Public Method Check for create, change, and display admin authorization 20100806
2 CHECK_FOR_FS Static method Public Method Check if it is a data provider service 20100809
3 COMPL_MES_HANDL_ERROR_LDAP Static method Private Method Very detailed exception handling for LDAP with text IDs 20100803
4 COMPL_MES_HANDL_ERROR_LDAP_PRO Static method Public Method Capsulate the exception handling needed for framework 20100803
5 CONVERT_AD_SID_BLOCK_TO_EXT Static method Private Method Convert a SID block to external representation 20100803
6 CONVERT_AD_SID_TO_EXT Static method Private Method Convert MS Active Directory SID to external representation 20100803
7 CONVERT_HEX_TO_INTEGER Static method Private Method Convert 1 digit from a hexadecimal representation to integer 20100803
8 DETERMINE_CONNECTOR_DATA Static method Public Method Determine the connector data to identify excludes smoketest 20101006
9 GET_ALL_GROUP_DATA_FOR_USER Static method Public Method Gets all needed group data for user 20100805
10 GET_DIRECT_GROUP_LIST_FOR_USER Static method Private Method Gets the direct groupo list from LDAP for one user 20100805
11 GET_DIRECT_SID_LIST_FOR_USER Static method Public Method Get SID list for SY-UNAME, from buffer or MS Active Dir. 20100803
12 GET_DN_FOR_PRIMARYGROUPID Static method Private Method Get Distinguished Name for a primaryGroupID 20100805
13 GET_ES_LDAP_CONFIGURATION Static method Private Method Get the ES LDAP configuration 20110114
14 GET_FAST_SEARCH_INFO Static method Private Method Determines fast search info if available 20100804
15 GET_GROUP_SECURITY Static method Private Method Extract the hexadecimal security value from a group type 20100805
16 GET_LOGSYS_INFO Static method Private Method Gets the connector info too create a search via connector 20100813
17 LDAP_SYSTEMBIND Static method Private Method Comfort shell around function module LDAP_SYSTEMBIND 20100803
18 LDAP_UNBIND Static method Public Method Comfort shell around function module LDAP_UNBIND 20100803
19 RESOLVE_AD_USERGROUP Static method Private Method Resolve 1 usergroup by accessing MS Active Directory 20100805
20 RESOLVE_USER_USERGROUP Static method Private Method Gets all groups starting from basicgroups using hierarchy 20100805
21 TEXT_MESSAGE_CONVERT_SHORT Static method Private Method Convert a text message (string) to sy-message 20100803
Events
Class CL_SEFS_LDAP_EX_TOOLS has no event.
Types
Class CL_SEFS_LDAP_EX_TOOLS has no local type.
Method Signatures

Method CHECK_ADM_AUTHORITIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_IS_CHANGE_AUTHORIZED Call by reference Type reference (TYPE) ABAP_BOOL 20100806
2 Exporting EV_IS_CREATE_AUTHORIZED Call by reference Type reference (TYPE) ABAP_BOOL 20100806
3 Exporting EV_IS_DISPLAY_AUTHORIZED Call by reference Type reference (TYPE) ABAP_BOOL 20100806

Method CHECK_ADM_AUTHORITIES on class CL_SEFS_LDAP_EX_TOOLS has no exception.

Method CHECK_FOR_FS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_IS_FS Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20100809
2 Importing IR_CONNECTIVITY Call by reference Object reference (TYPE REF TO) CL_ESH_ADM_ANY_CONNECTIVITY Connectivity details 20100809
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100811

Method COMPL_MES_HANDL_ERROR_LDAP 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 Table with BAPI Return Information 20100803
2 Importing IR_ERROR Call by reference Object reference (TYPE REF TO) CX_ROOT Abstract Superclass for All Global Exceptions 20100803
3 Importing IS_EXCEPTION Call by reference Type reference (TYPE) ABAP_BOOL 'X' 20100806
4 Importing IS_SEVERE Call by reference Type reference (TYPE) ABAP_BOOL ' ' 20100803
5 Importing IV_ADJUST_MSG_TYPE Call by reference Type reference (TYPE) ABAP_BOOL ' ' 20100812
6 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYST-MSGID Message Class 20100803
7 Importing IV_MSG_MSGV1 Call by reference Type reference (TYPE) CHAR255 Char255 20100803
8 Importing IV_MSG_MSGV2 Call by reference Type reference (TYPE) CHAR255 Char255 20100803
9 Importing IV_MSG_MSGV3 Call by reference Type reference (TYPE) CHAR255 Char255 20100803
10 Importing IV_MSG_MSGV4 Call by reference Type reference (TYPE) CHAR255 Char255 20100803
11 Importing IV_MSG_NO Call by reference Type reference (TYPE) SYST-MSGNO Message Number 20100803
12 Importing IV_MSG_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type 20100803
13 Importing IV_TEXTID Call by reference Type reference (TYPE) SCX_T100KEY T100 Key with Parameters Mapped to Attribute Names 20100803
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR General Errors in DPS Services 20100803

Method COMPL_MES_HANDL_ERROR_LDAP_PRO 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 Table with BAPI Return Information 20100803
2 Importing IR_ERROR Call by reference Object reference (TYPE REF TO) CX_ROOT Abstract Superclass for All Global Exceptions 20100803
3 Importing IS_EXCEPTION Call by reference Type reference (TYPE) ABAP_BOOL 'X' 20100803
4 Importing IV_MSG_ID Call by reference Type reference (TYPE) SYST-MSGID Message Class 20100803
5 Importing IV_MSG_MSGV1 Call by reference Type reference (TYPE) CHAR255 char255 20100803
6 Importing IV_MSG_MSGV2 Call by reference Type reference (TYPE) CHAR255 char255 20100803
7 Importing IV_MSG_MSGV3 Call by reference Type reference (TYPE) CHAR255 char255 20100803
8 Importing IV_MSG_MSGV4 Call by reference Type reference (TYPE) CHAR255 char255 20100803
9 Importing IV_MSG_NO Call by reference Type reference (TYPE) SYST-MSGNO Message Number 20100803
10 Importing IV_MSG_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type 20100803
# Exception Resumable Description Created on
1 CX_ESH_IF_PROVIDER_ERROR General error in provider 20100803

Method CONVERT_AD_SID_BLOCK_TO_EXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SID_BLOCK_HEX_R Call by reference Type reference (TYPE) SEFS_D_AD_SID_BLOCK_HEX_R MS Active Directory SID block in readable hex representation 20100803
2 Returning RV_SID_BLOCK_EXT Value transfer Type reference (TYPE) SEFS_D_AD_SID_BLOCK_EXT MS Active Directory SID block in external representation 20100803
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100803

Method CONVERT_AD_SID_TO_EXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_SID_EXT Call by reference Type reference (TYPE) CLIKE MS Active Directory SID in external representation 20100803
2 Importing IV_SID_HEX_READABLE Call by reference Type reference (TYPE) CLIKE MS Active Directory SID in readable hex representation 20100803
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100803

Method CONVERT_HEX_TO_INTEGER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HEX Call by reference Type reference (TYPE) SEFS_D_HEX_DIGIT 1 digit from a readable hexadecimal representation 20100803
2 Returning RV_INTEGER Value transfer Type reference (TYPE) INT4 Equivalent value in integer format 20100806
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100803

Method DETERMINE_CONNECTOR_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_CONNECTOR_ID Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_CONNECTOR_ID Search Connector ID 20101006
2 Importing IR_CONNECTIVITY Call by reference Object reference (TYPE REF TO) CL_ESH_ADM_ANY_CONNECTIVITY Connectivity details 20101006
3 Importing IV_OBJECT_TYPE_ID Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20101006
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20101006

Method GET_ALL_GROUP_DATA_FOR_USER 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 Table with BAPI Return Information 20100806
2 Exporting ET_USERGROUP_SID_DATA Call by reference Type reference (TYPE) SEFS_T_LDAP_USERGROUP_DATA Table of usergroup data in LDAP 20100805
3 Exporting ET_USER_USERGROUP_DATA Call by reference Type reference (TYPE) SEFS_T_LDAP_USER_USERGROUP Table type for LDAP user usergroup data 20100805
4 Importing IR_CONNECTIVITY Call by reference Object reference (TYPE REF TO) CL_ESH_ADM_ANY_CONNECTIVITY Connectivity details 20100812
5 Importing IV_UNAME Call by reference Type reference (TYPE) XUBNAME SY-UNAME User Name in User Master Record 20100805
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100805

Method GET_DIRECT_GROUP_LIST_FOR_USER 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 Table with BAPI Return Information 20100811
2 Exporting ET_USERGROUPS Call by reference Type reference (TYPE) SEFS_T_USERGROUP_WITH_DOMAIN Destinguished Names (DN) of usergroups with LDAP domains 20100805
3 Importing IR_CONNECTIVITY Call by reference Object reference (TYPE REF TO) CL_ESH_ADM_ANY_CONNECTIVITY Connectivity details 20100812
4 Importing IV_UNAME Call by reference Type reference (TYPE) XUBNAME SY-UNAME User Name in User Master Record 20100805
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100805

Method GET_DIRECT_SID_LIST_FOR_USER 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 Table with BAPI Return Information 20100806
2 Exporting ET_SID_LISTS Call by reference Type reference (TYPE) SEFS_T_SID_LIST_WITH_DOMAIN List of SIDs per LDAP domain 20100803
3 Importing IR_CONNECTIVITY Call by reference Object reference (TYPE REF TO) CL_ESH_ADM_ANY_CONNECTIVITY Connectivity details 20100812
4 Importing IV_UNAME Call by reference Type reference (TYPE) XUBNAME SY-UNAME User Name in User Master Record 20100803
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100803

Method GET_DN_FOR_PRIMARYGROUPID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_USERGROUP_DN Call by reference Type reference (TYPE) SEFS_D_LDAP_USERGROUP Destinguished Name (DN) of a usergroup in LDAP 20100805
2 Importing IV_DOMAIN_NAME Call by reference Type reference (TYPE) SEFS_D_LDAP_DOMAIN_NAME Name of an LDAP domain 20100805
3 Importing IV_LDAP_SERVER Call by reference Type reference (TYPE) SEFS_D_LDAP_SERVER Symbolic name of LDAP server 20100805
4 Importing IV_PRIMARYGROUPID Call by reference Type reference (TYPE) CHAR16 primaryGroupID 20100805
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100805

Method GET_ES_LDAP_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_LDAP_DOMAIN Call by reference Type reference (TYPE) SEFS_T_LDAP_DOMAIN Enterprise File Search: Settings for LDAP domain 20110114

Method GET_ES_LDAP_CONFIGURATION on class CL_SEFS_LDAP_EX_TOOLS has no exception.

Method GET_FAST_SEARCH_INFO 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 Table with BAPI Return Information 20100811
2 Exporting EV_ATTR_FAST_VALUE Call by reference Type reference (TYPE) SEFS_D_LDAP_ATTR_FAST Attribute for fast access (optional, e.g. sAMAccountName) 20100804
3 Exporting EV_ATTR_USERNAME_VALUE Call by reference Type reference (TYPE) SEFS_D_LDAP_ATTR_FAST_C Content of attribute for fast access (optional) 20100804
4 Importing IR_CONNECTIVITY Call by reference Object reference (TYPE REF TO) CL_ESH_ADM_ANY_CONNECTIVITY Connectivity details 20100812
5 Importing IV_LDAP_DOMAIN_NAME Call by reference Type reference (TYPE) SEFS_D_LDAP_DOMAIN_NAME Name of an LDAP domain 20100804
6 Importing IV_UNAME Call by reference Type reference (TYPE) XUBNAME SY-UNAME User Name in User Master Record 20100813
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100804

Method GET_GROUP_SECURITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_GROUP_TYPE Call by reference Type reference (TYPE) STRING MS Active Directory group type as hexadecimal string 20100805
2 Returning RV_SECURITY_HEX Value transfer Type reference (TYPE) SEFS_D_HEX_DIGIT Hexadecimal security value (8 = security enabled) 20100805

Method GET_GROUP_SECURITY on class CL_SEFS_LDAP_EX_TOOLS has no exception.

Method GET_LOGSYS_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_SYSTEM_ID Call by reference Type reference (TYPE) LOGSYS Connection GUID 20100813
2 Importing IR_CONNECTIVITY Call by reference Object reference (TYPE REF TO) CL_ESH_ADM_ANY_CONNECTIVITY Connectivity details 20100813
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100813

Method LDAP_SYSTEMBIND Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LDAP_SERVER Call by reference Type reference (TYPE) SEFS_D_LDAP_SERVER Symbolic name of LDAP server 20100803
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100803

Method LDAP_UNBIND Signature

Method LDAP_UNBIND on class CL_SEFS_LDAP_EX_TOOLS has no parameter.
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100803

Method RESOLVE_AD_USERGROUP 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 Table with BAPI Return Information 20100806
2 Exporting ET_USERGROUP_SID_DATA Call by reference Type reference (TYPE) SEFS_T_LDAP_USERGROUP_DATA Table of usergroup data in LDAP 20100805
3 Importing IS_USERGROUP Call by reference Type reference (TYPE) SEFS_S_USERGROUP_WITH_DOMAIN Destinguished Name (DN) of a usergroup with LDAP domain 20100805
4 Importing IV_LDAP_UNBIND Call by reference Type reference (TYPE) BOOLE_D 'X' X = Close LDAP connection at return 20100805
# Exception Resumable Description Created on
1 CX_SEFS_LDAP_EX_ERROR Errors during LDAP extraction for FS 20100805

Method RESOLVE_USER_USERGROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_USER_USERGROUP_DATA Call by reference Type reference (TYPE) SEFS_T_LDAP_USER_USERGROUP Table type for LDAP user usergroup data 20100805
2 Importing IT_USERGROUP_DATA_DIRECT Call by reference Type reference (TYPE) SEFS_T_USERGROUP_WITH_DOMAIN Destinguished Names (DN) of usergroups with LDAP domains 20100805
3 Importing IV_UNAME Call by reference Type reference (TYPE) XUBNAME User Name in User Master Record 20100805

Method RESOLVE_USER_USERGROUP on class CL_SEFS_LDAP_EX_TOOLS has no exception.

Method TEXT_MESSAGE_CONVERT_SHORT 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 Table with BAPI Return Information 20100803
2 Importing IV_MESSAGE_ID Call by reference Type reference (TYPE) SYMSGID Message ID 20100803
3 Importing IV_MESSAGE_NO Call by reference Type reference (TYPE) SYMSGNO Message No (has to contain &1&2&3&4) 20100803
4 Importing IV_MESSAGE_TYPE Call by reference Type reference (TYPE) SYMSGTY Message Type A, E, W, I, S 20100803
5 Importing IV_TEXT Call by reference Type reference (TYPE) STRING Message Text 20100803

Method TEXT_MESSAGE_CONVERT_SHORT on class CL_SEFS_LDAP_EX_TOOLS has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 703