SAP ABAP Class /IWBEP/IF_MGW_NOTIF_PUBLISHER (Notification Publisher Interface)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWBEP/CL_MGW_NOTIF_PUBLISHER | Notification Publisher | 20110406 |
Properties
| Class | /IWBEP/IF_MGW_NOTIF_PUBLISHER | |
| Short Description | Notification Publisher Interface | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20110203 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /IWBEP/IF_MGW_NOTIF_PUBLISHER has no forward declaration.
Interfaces
Class /IWBEP/IF_MGW_NOTIF_PUBLISHER has no interface implemented.
Friends
Class /IWBEP/IF_MGW_NOTIF_PUBLISHER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GCS_NOTIFICATION_TYPES |
Constant | Public | See coding | 20110406 | ||||
| 2 | GCS_OPERATION_TYPES |
Constant | Public | See coding | 20110407 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_NOTIFICATION_ENDPOINTS |
Instance method | Public | Method | Create notification endpoints to Gateway systems. | 20110411 |
| 2 | SEND_NOTIFICATIONS |
Instance method | Public | Method | Send notifications to Gateway. | 20110406 |
Events
Class /IWBEP/IF_MGW_NOTIF_PUBLISHER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_NOTIFICATION | Public | See coding | 20110406 | BEGIN OF ty_s_notification.
INCLUDE TYPE ty_s_notification_header.
TYPES: data_ref TYPE REF TO data, " data ref to the structure of the object for which a notification should be send
END OF ty_s_notification
|
||
| 2 | TY_S_NOTIFICATION_ENDPOINT | Public | See coding | 20110406 | BEGIN OF ty_s_notification_endpoint,
receiver_gateway_id TYPE sysysid, " System id of receiver gateway
receiver_gateway_client TYPE mandt, " System client of receiver Gateway
system_alias TYPE /iwbep/defi_system_alias, " SAP System Alias of the subscription
notifications TYPE ty_t_notifications, " notifications which needs to be sent to receiver gateway
END OF ty_s_notification_endpoint
|
||
| 3 | TY_S_NOTIFICATION_HEADER | Public | See coding | 20110406 | BEGIN OF ty_s_notification_header,
type TYPE char1, " notification type
operation_type TYPE char30, " operation type
entries_of_interest TYPE /iwbep/mgw_notif_no_of_entries, " entries of interest e.g. used in badge info
json_header TYPE string, "JSON formatted header information
timestamp TYPE tzntstmps, " timestamp of delivery data
text TYPE string, " notification text; used as title
language TYPE sy-langu, " notification text language
service_name TYPE string, " external name of service
service_namespace TYPE string, " Namespace
service_version TYPE string, " version
service_root TYPE string, " Service Root
collection TYPE string, " Entity Set name/href of collection
expand TYPE string, " Expand in case of deep inlining - currently not supported
base_url TYPE string, " base url of the subscription request which is passed back to gateway in notification
recipients TYPE ty_t_recipients, " list of recipients with corresponding endpoints
END OF ty_s_notification_header
|
||
| 4 | TY_S_RECIPIENT | Public | See coding | 20110406 | BEGIN OF ty_s_recipient,
username TYPE syuname, " username of user on Gateway
endpoint TYPE string, " delivery address of user
persist_notif TYPE char1, " flag: persist notifications at Gateway
notif_format TYPE /iwbep/mgw_sub_notif_format,
END OF ty_s_recipient
|
||
| 5 | TY_T_NOTIFICATIONS | Public | See coding | 20110406 | ty_t_notifications TYPE STANDARD TABLE OF ty_s_notification WITH DEFAULT KEY
|
||
| 6 | TY_T_NOTIFICATION_ENDPOINT | Public | See coding | 20110411 | ty_t_notification_endpoint TYPE STANDARD TABLE OF ty_s_notification_endpoint WITH DEFAULT KEY
|
||
| 7 | TY_T_RECIPIENTS | Public | See coding | 20110406 | ty_t_recipients TYPE STANDARD TABLE OF ty_s_recipient WITH DEFAULT KEY
|
Method Signatures
Method CREATE_NOTIFICATION_ENDPOINTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_NOTIFICATION_ENDPOINTS | Call by reference | Type reference (TYPE) | TY_T_NOTIFICATION_ENDPOINT | Endpoints | 20110412 | ||
| 2 |  Importing |
IO_TEXT_PROVIDER | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_NOTIF_TEXT_PROV | Notification Text Provider | 20110714 | ||
| 3 | Importing |
IR_POKE_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | Notification Header Data | 20120314 | ||
| 4 | Importing |
IS_DATA | Call by reference | Object reference (TYPE REF TO) | DATA | Notification Content Data | 20110411 | ||
| 5 | Importing |
IT_SUBSCRIPTIONS | Call by reference | Type reference (TYPE) | /IWBEP/T_MGW_SUB_DATA | Subscription Data TableType | 20110411 | ||
| 6 | Importing |
IV_ENTRIES_OF_INTEREST | Call by reference | Type reference (TYPE) | /IWBEP/MGW_NOTIF_NO_OF_ENTRIES | Notification Entries Of Interest | 20110719 | ||
| 7 | Importing |
IV_EXPAND | Call by reference | Type reference (TYPE) | STRING | Expand parameters for payload notification | 20110415 | ||
| 8 | Importing |
IV_OPERATION_TYPE | Call by reference | Type reference (TYPE) | CHAR30 | Notification Operation Type | 20110411 | ||
| 9 | Importing |
IV_TEXT | Call by reference | Type reference (TYPE) | STRING | Default Notification Text | 20110411 | ||
| 10 | Importing |
IV_TYPE | Call by reference | Type reference (TYPE) | CHAR1 | Notification Type | 20110412 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /IWBEP/CX_MGW_TECH_EXCEPTION |
technical exception | 20110411 |
Method SEND_NOTIFICATIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_NOTIFICATION_ENDPOINT | Call by reference | Type reference (TYPE) | TY_S_NOTIFICATION_ENDPOINT | 20110406 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_MGW_TECH_EXCEPTION |
technical exception | 20110411 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
