SAP ABAP Class CL_ESH_AU_AUTHORIZATION_CHECK (Check Authorization)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_AUTHORIZATION (Package) Authorization
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_AUTHORIZATION (Package) AuthorizationProperties
| Class | CL_ESH_AU_AUTHORIZATION_CHECK | |
| Short Description | Check Authorization | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_AUTHORIZATION | Authorization |
| Created | 20090127 | 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) |
| 2 | CL_ESH_AU_AUTHORIZATION_CACHE |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_ESH_AU_AUTHORIZATION_CHECK has no interface implemented.
Friends
Class CL_ESH_AU_AUTHORIZATION_CHECK has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SS_CONNECTORS |
Static Attribute | Private | Type reference (TYPE) | CL_ESH_AU_AUTHORIZATION_CACHE=>S_DATA | Cached data | 20091110 | ||
| 2 | ST_SEARCH_CONNECTOR_AUTH |
Static Attribute | Private | Type reference (TYPE) | T_SEARCH_CONNECTOR_AUTH | 20090127 | |||
| 3 | SV_IS_CACHE_RETRIEVED |
Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | Cache is retrieved | 20100414 | ||
| 4 | SV_SC_IS_AUTH_CHECK_ACTIVE |
Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_UNDEFINED | Authorization Check is active | 20100414 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CATEGORY |
Static method | Public | Method | Check authorization for a category | 20100414 |
| 2 | CLEAR_BUFFER |
Static method | Public | Method | Clear buffered data | 20101026 |
| 3 | RETRIEVE_CACHE |
Static method | Private | Method | Retrieve cache | 20100414 |
| 4 | SC_CHECK_AUTHORIZATION |
Static method | Private | Method | Check authorization for searching on a connector | 20090128 |
| 5 | SC_GET_DETAILS |
Static method | Private | Method | Get details necessary for a connector authorization check | 20090128 |
| 6 | SC_IS_AUTH_CHECK_ACTIVE |
Static method | Private | Method | Check if authorization check has to be executed | 20090128 |
| 7 | SEARCH_CONNECTOR |
Static method | Public | Method | Check authorization for searching on a connector | 20090127 |
| 8 | SEARCH_CONNECTOR_OLD |
Static method | Public | Method | Check authorization for searching on a connector | 20091110 |
Events
Class CL_ESH_AU_AUTHORIZATION_CHECK has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_SEARCH_CONNECTOR_AUTH | Private | See coding | 20090127 | BEGIN OF s_search_connector_auth,
template_type TYPE esh_e_om_template_type,
connector_id TYPE esh_e_if_search_connector_id,
object_type_id TYPE esh_e_om_object_type,
system_id TYPE syst-sysid,
system_client TYPE syst-mandt,
dummy_system TYPE abap_bool,
dummy_request TYPE abap_bool,
request_type_id TYPE esh_e_om_request,
is_authorized TYPE abap_bool,
END OF s_search_connector_auth
|
||
| 2 | T_SEARCH_CONNECTOR_AUTH | Private | See coding | 20090127 | t_search_connector_auth TYPE SORTED TABLE OF s_search_connector_auth
WITH UNIQUE KEY template_type
connector_id
object_type_id
system_id
system_client
dummy_system
dummy_request
request_type_id
|
Method Signatures
Method CATEGORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_CATEGORY_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_CATEGORY_ID | Category ID | 20100414 | ||
| 2 | Importing |
IV_REFRESH | Call by reference | Type reference (TYPE) | ABAP_BOOL | Refresh authorization check results | 20100414 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_AU_ENGINE |
Exception Class for Authorization | 20100414 | |
| 2 | CX_ESH_AU_NOT_AUTHORIZED |
Not authorized | 20100414 |
Method CLEAR_BUFFER Signature
Method CLEAR_BUFFER on class CL_ESH_AU_AUTHORIZATION_CHECK has no parameter.
Method CLEAR_BUFFER on class CL_ESH_AU_AUTHORIZATION_CHECK has no exception.
Method RETRIEVE_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_REFRESH | Call by reference | Type reference (TYPE) | ABAP_BOOL | Refresh data | 20100414 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_AU_ENGINE |
Exception Class for Authorization | 20100414 |
Method SC_CHECK_AUTHORIZATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CS_SEARCH_CONNECTOR_DETAILS | Call by reference | Type reference (TYPE) | S_SEARCH_CONNECTOR_AUTH | Search connector details for authorization check | 20090128 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_AU_ENGINE |
Exception Class for Authorization | 20090128 |
Method SC_GET_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_SEARCH_CONNECTOR_DETAILS | Call by reference | Type reference (TYPE) | S_SEARCH_CONNECTOR_AUTH | Search connector details for authorization check | 20090128 | ||
| 2 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20090128 | ||
| 3 | Importing |
IV_DUMMY_REQUEST | Call by reference | Type reference (TYPE) | ABAP_BOOL | Use dummy instead of request | 20090128 | ||
| 4 | Importing |
IV_IS_ROOT_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ABAP_BOOL | Is root Connector ID | 20090128 | ||
| 5 | Importing |
IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090128 | ||
| 6 | Importing |
IV_REQUEST_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_REQUEST | Request | 20090128 | ||
| 7 | Importing |
IV_SYSTEM_CLIENT | Call by reference | Type reference (TYPE) | SYST-MANDT | Client ID of Current User | 20090128 | ||
| 8 | Importing |
IV_SYSTEM_ID | Call by reference | Type reference (TYPE) | SYST-SYSID | Name of the SAP System | 20090128 | ||
| 9 | Importing |
IV_TEMPLATE_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | Template Type | 20090128 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_AU_ENGINE |
Exception Class for Authorization | 20090128 |
Method SC_IS_AUTH_CHECK_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RV_TRUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090128 |
Method SC_IS_AUTH_CHECK_ACTIVE on class CL_ESH_AU_AUTHORIZATION_CHECK has no exception.
Method SEARCH_CONNECTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20090127 | ||
| 2 | Importing |
IV_DUMMY_REQUEST | Call by reference | Type reference (TYPE) | ABAP_BOOL | Use dummy instead of request | 20090127 | ||
| 3 | Importing |
IV_IS_ROOT_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ABAP_BOOL | Is root Connector ID | 20090127 | ||
| 4 | Importing |
IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090127 | ||
| 5 | Importing |
IV_REFRESH | Call by reference | Type reference (TYPE) | ABAP_BOOL | Refresh authorization check results | 20100414 | ||
| 6 | Importing |
IV_REQUEST_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_REQUEST | Request | 20090127 | ||
| 7 | Importing |
IV_SYSTEM_CLIENT | Call by reference | Type reference (TYPE) | SYST-MANDT | Client ID of Current User | 20090127 | ||
| 8 | Importing |
IV_SYSTEM_ID | Call by reference | Type reference (TYPE) | SYST-SYSID | Name of the SAP System | 20090127 | ||
| 9 | Importing |
IV_TEMPLATE_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | Template Type | 20090127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_AU_ENGINE |
Exception Class for Authorization | 20090127 | |
| 2 | CX_ESH_AU_NOT_AUTHORIZED |
Not authorized | 20090127 |
Method SEARCH_CONNECTOR_OLD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Search Connector ID | 20091110 | ||
| 2 | Importing |
IV_DUMMY_REQUEST | Call by reference | Type reference (TYPE) | ABAP_BOOL | Use dummy instead of request | 20091110 | ||
| 3 | Importing |
IV_IS_ROOT_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ABAP_BOOL | Is root Connector ID | 20091110 | ||
| 4 | Importing |
IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20091110 | ||
| 5 | Importing |
IV_REQUEST_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_REQUEST | Request | 20091110 | ||
| 6 | Importing |
IV_SYSTEM_CLIENT | Call by reference | Type reference (TYPE) | SYST-MANDT | Client ID of Current User | 20091110 | ||
| 7 | Importing |
IV_SYSTEM_ID | Call by reference | Type reference (TYPE) | SYST-SYSID | Name of the SAP System | 20091110 | ||
| 8 | Importing |
IV_TEMPLATE_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_TEMPLATE_TYPE | Template Type | 20091110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_AU_ENGINE |
Exception Class for Authorization | 20091110 | |
| 2 | CX_ESH_AU_NOT_AUTHORIZED |
Not authorized | 20091110 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 720 |
