SAP ABAP Interface IF_DBMS_USER (Interface of Data Base User)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-USR-ADM (Application Component) User and Authorization Management
     ⤷ SUSR_IDENTITY_DBMS (Package) Data Base Management System User Administration

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_DBMS_USER_HDB	DB User Administration for DB HANA	20120904

Properties

Interface	IF_DBMS_USER
Short Description	Interface of Data Base User

General Data

Package	SUSR_IDENTITY_DBMS	Data Base Management System User Administration
Created	20120904	SAP
Last changed	20141121
Unicode checks active	☑

Forward declarations

Interface IF_DBMS_USER has no forward declaration.

Interfaces

Interface IF_DBMS_USER has no interface.

Friends

Interface IF_DBMS_USER has no friend.

Attributes

Interface IF_DBMS_USER has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ALTER_USER	Instance method	Public	Method	Change DB user data	20120904
2	ALTER_USERS	Instance method	Public	Method	Change DB users data	20120904
3	CHECK_ROLE_EXIST	Instance method	Public	Method	Check if DB Role exists	20130207
4	CHECK_USER_EXISTS	Instance method	Public	Method	Check whether the user exists	20121004
5	CLOSE_CONNECTION	Instance method	Public	Method	Close the related DBMS connection	20121109
6	CREATE_INSTANCE	Static method	Public	Method	create the instance of the related class to this interface	20120913
7	CREATE_USER	Instance method	Public	Method	Create Data Base User	20120904
8	CREATE_USERS	Instance method	Public	Method	Create Data Base Users	20120904
9	DROP_USER	Instance method	Public	Method	Drop DB user	20120904
10	DROP_USERS	Instance method	Public	Method	Drop DB users	20120904
11	GET_ALL_USER_NAMES	Instance method	Public	Method	Get all DB user names	20120919
12	GET_DBMS	Static method	Public	Method	Returns the DB system for which the user should be created	20120904
13	GET_USER	Instance method	Public	Method	Get DB user data	20120904
14	GET_USERS	Instance method	Public	Method	Get DB users data	20120904
15	IS_PASSWORD_VALID	Instance method	Public	Method	Check whether the password fulfills the DBMS password policy	20120925
16	IS_USER_NAME_VALID	Instance method	Public	Method	Check whether the user name is valid for DBMS system	20121016
17	MODIFY_USER	Instance method	Public	Method	Create and/or change DBMS user	20121005
18	QUERY_ROLES	Instance method	Public	Method	Query DB roles	20130204
19	QUERY_USER	Instance method	Public	Method	Query DB user	20121010

Events

Interface IF_DBMS_USER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_DB_USER_NAME	Public	Type reference (TYPE)	SUID_DBMS_USER		20120904
2	TY_S_DB_ROLE_INFO	Public	See coding			20130213	BEGIN OF ty_s_db_role_info, role_name TYPE suid_dbms_role, grantor TYPE ty_db_user_name, END OF ty_s_db_role_info
3	TY_S_DB_ROLE_NAME	Public	See coding			20130228	BEGIN OF ty_s_db_role_name, role_name TYPE suid_dbms_role, created_by TYPE ty_db_user_name, END OF ty_s_db_role_name
4	TY_S_DB_USER_CHANGED_FIELDS	Public	See coding			20121005	BEGIN OF ty_s_db_user_changed_fields, password TYPE boole_d, user_deactivated TYPE boole_d, role_assignment TYPE boole_d, END OF ty_s_db_user_changed_fields
5	TY_S_DB_USER_DATA	Public	See coding			20120904	BEGIN OF ty_s_db_user_data, user_name TYPE ty_db_user_name, user_id TYPE suid_dbms_user_id, created_by TYPE ty_db_user_name, created_on TYPE timestamp, changed_by TYPE ty_db_user_name, changed_on TYPE timestamp, user_deactivated TYPE suid_dbms_user_deactivated, password TYPE string, external_identity type string, "IDENTIFIED EXTERNALLY AS end of ty_s_db_user_data
6	TY_S_DB_USER_DATA_ALTER	Public	See coding			20120904	BEGIN OF ty_s_db_user_data_alter, user_name TYPE ty_db_user_name, password TYPE string, deactivate_user TYPE boole_d, activate_user TYPE boole_d, set_client TYPE boole_d, external_name type string, "IDENTIFIED EXTERNALLY AS end of ty_s_db_user_data_alter
7	TY_S_DB_USER_DATA_CREATE	Public	See coding			20120904	BEGIN OF ty_s_db_user_data_create, user_name TYPE ty_db_user_name, password TYPE string, external_identity type string, "IDENTIFIED EXTERNALLY AS end of ty_s_db_user_data_create
8	TY_T_DB_ROLE_INFO	Public	See coding			20130213	ty_t_db_role_info TYPE TABLE OF ty_s_db_role_info WITH DEFAULT KEY
9	TY_T_DB_ROLE_NAME	Public	See coding			20130206	ty_t_db_role_name TYPE TABLE OF ty_s_db_role_name WITH DEFAULT KEY
10	TY_T_DB_USER_CHANGED_FIELDS	Public	See coding			20121005	ty_t_db_user_changed_fields TYPE TABLE OF ty_s_db_user_changed_fields WITH DEFAULT KEY
11	TY_T_DB_USER_DATA	Public	See coding			20120904	ty_t_db_user_data TYPE STANDARD TABLE OF ty_s_db_user_data WITH KEY primary_key COMPONENTS user_name
12	TY_T_DB_USER_DATA_ALTER	Public	See coding			20120904	ty_t_db_user_data_alter TYPE TABLE OF ty_s_db_user_data_alter WITH KEY primary_key COMPONENTS user_name
13	TY_T_DB_USER_DATA_CREATE	Public	See coding			20120904	ty_t_db_user_data_create TYPE STANDARD TABLE OF ty_s_db_user_data_create WITH KEY primary_key COMPONENTS user_name
14	TY_T_DB_USER_NAME	Public	See coding			20120904	ty_t_db_user_name TYPE TABLE OF ty_db_user_name WITH DEFAULT KEY

Method Signatures

Method ALTER_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 of messages	20120904
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: DB user could not be updated	20120904
3	Importing	IS_DB_USER_DATA	Call by reference	☐	Type reference (TYPE)	TY_S_DB_USER_DATA_ALTER		DB user data for update	20120904
4	Importing	IT_ROLE_NAMES	Call by reference	☑	Type reference (TYPE)	TY_T_DB_ROLE_INFO		List of DB roles	20130207

Method ALTER_USER on Interface IF_DBMS_USER has no exception.

Method ALTER_USERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FAILED_USERS	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME		Table of failed users	20120913
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table of messages	20120904
3	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: DB user could not be updated	20120904
4	Importing	IT_DB_USER_DATA	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_DATA_ALTER		DB user data for update	20120904

Method ALTER_USERS on Interface IF_DBMS_USER has no exception.

Method CHECK_ROLE_EXIST 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 messages	20130207
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: DB Connection failed	20130207
3	Exporting	EV_ROLE_EXISTS	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: Role exists	20130207
4	Importing	IV_ROLE_NAME	Call by reference	☐	Type reference (TYPE)	SUID_DBMS_ROLE		DB Role name	20130207

Method CHECK_ROLE_EXIST on Interface IF_DBMS_USER has no exception.

Method CHECK_USER_EXISTS 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 messages	20121004
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: DB Connection failed	20121010
3	Exporting	EV_USER_EXISTS	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: user exists	20121004
4	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	TY_DB_USER_NAME		DB user name	20121004

Method CHECK_USER_EXISTS on Interface IF_DBMS_USER has no exception.

Method CLOSE_CONNECTION Signature

Method CLOSE_CONNECTION on Interface IF_DBMS_USER has no parameter.
Method CLOSE_CONNECTION on Interface IF_DBMS_USER has no exception.

Method CREATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DBMS_USER	Call by reference	☐	Object reference (TYPE REF TO)	IF_DBMS_USER		Interface of Data Base User	20120913
2	Importing	IR_DBMS_CONNECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_SQL_CONNECTION		Database Connection	20120913

Method CREATE_INSTANCE on Interface IF_DBMS_USER has no exception.

Method CREATE_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 of messages which occured during creation of user	20120904
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: user cannot be created	20120904
3	Importing	IS_DB_USER_DATA	Call by reference	☐	Type reference (TYPE)	TY_S_DB_USER_DATA_CREATE		data of the user which has to be created	20120904

Method CREATE_USER on Interface IF_DBMS_USER has no exception.

Method CREATE_USERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FAILED_USERS	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME		Table of failed users	20120913
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		table of messages which occured during creation of user	20120904
3	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: user cannot be created	20120904
4	Importing	IT_DB_USER_DATA	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_DATA_CREATE		data of the user which has to be created	20120904

Method CREATE_USERS on Interface IF_DBMS_USER has no exception.

Method DROP_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 of messages	20120904
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: User could not be deleted	20120904
3	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	TY_DB_USER_NAME		DB User name	20120904

Method DROP_USER on Interface IF_DBMS_USER has no exception.

Method DROP_USERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FAILED_USERS	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME		Table of failed users	20120913
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table of messages	20120904
3	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: User could not be deleted	20120904
4	Importing	IT_USER_NAME	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME		DB User name	20120904

Method DROP_USERS on Interface IF_DBMS_USER has no exception.

Method GET_ALL_USER_NAMES 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	20121001
2	Exporting	ET_USER_NAMES	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME			20120919

Method GET_ALL_USER_NAMES on Interface IF_DBMS_USER has no exception.

Method GET_DBMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DBMS	Call by reference	☐	Type reference (TYPE)	DBCON_DBMS		Database system	20120904

Method GET_DBMS on Interface IF_DBMS_USER has no exception.

Method GET_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DB_USER_DATA	Call by reference	☐	Type reference (TYPE)	TY_S_DB_USER_DATA		DB user data	20120904
2	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table messages	20120904
3	Exporting	ET_ROLE_NAMES	Call by reference	☐	Type reference (TYPE)	TY_T_DB_ROLE_INFO		DBMS roles	20130207
4	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: data of user could not be got from DB	20120904
5	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	TY_DB_USER_NAME		DB user name	20120904

Method GET_USER on Interface IF_DBMS_USER has no exception.

Method GET_USERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DB_USER_DATA	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_DATA		DB user data	20120917
2	Exporting	ET_FAILED_USERS	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME		Table of failed users	20120913
3	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table messages	20120904
4	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: data of user could not be got from DB	20120904
5	Importing	IT_USER_NAME	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME		DB user name	20120904

Method GET_USERS on Interface IF_DBMS_USER has no exception.

Method IS_PASSWORD_VALID 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 messages	20121001
2	Exporting	EV_VALID	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: Password fulfills policy	20120925
3	Importing	IV_PASSWORD	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Password	20120925

Method IS_PASSWORD_VALID on Interface IF_DBMS_USER has no exception.

Method IS_USER_NAME_VALID 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 messages	20121016
2	Exporting	EV_VALID	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: User name is valid	20121016
3	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	TY_DB_USER_NAME			20121016

Method IS_USER_NAME_VALID on Interface IF_DBMS_USER has no exception.

Method MODIFY_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 messages	20121005
2	Exporting	EV_FAILED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		X: user cannot be modified	20121005
3	Importing	IS_CHANGED_FIELDS	Call by reference	☐	Type reference (TYPE)	TY_S_DB_USER_CHANGED_FIELDS		List of fields which has to be changed	20121005
4	Importing	IS_USER_DATA	Call by reference	☐	Type reference (TYPE)	TY_S_DB_USER_DATA		User data	20121005
5	Importing	IT_ROLE_NAMES	Call by reference	☑	Type reference (TYPE)	TY_T_DB_ROLE_INFO		List of assigned roles	20130207

Method MODIFY_USER on Interface IF_DBMS_USER has no exception.

Method QUERY_ROLES 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	20130206
2	Exporting	ET_ROLE_NAMES	Call by reference	☐	Type reference (TYPE)	TY_T_DB_ROLE_NAME		List of role names	20130206
3	Importing	IV_HITS	Call by reference	☐	Type reference (TYPE)	INT4	200	Natural number	20130206
4	Importing	IV_ROLE_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		Role name	20130206

Method QUERY_ROLES on Interface IF_DBMS_USER has no exception.

Method QUERY_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	20121010
2	Exporting	ET_USER_NAMES	Call by reference	☐	Type reference (TYPE)	TY_T_DB_USER_NAME			20121010
3	Importing	IV_HITS	Call by reference	☐	Type reference (TYPE)	INT4	200	Natural number	20121010
4	Importing	IV_USER_NAME	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		User name	20121010

Method QUERY_USER on Interface IF_DBMS_USER has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740