SAP ABAP Class CL_SSI_AMC (Messaging)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-CST (Application Component) Client/Server Technology
     SSI_MSG (Package) Messaging
Properties
Class CL_SSI_AMC  
Short Description Messaging    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SSI_MSG   Messaging 
Created 20121108   SAP 
Last change 20140121   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_SSI_AMC has no forward declaration.
Interfaces
Class CL_SSI_AMC has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_AMC_CHANNEL_UTILITY 20130722 ABAP Messaging Channel utility
2 CL_AMC_RUNTIME 20130131 ABAP Messaging Channel (AMC) runtime basis API
3 CL_SSI_AMC_TEST 20121109 Test
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ADDRESS_TYPE_SESSION Constant Public Type reference (TYPE) SSI_AMC_ADDRESS_TYPE '1' Adresse bezeichnet ABAP Session 20121108
2 ADDRESS_TYPE_UI Constant Public Type reference (TYPE) SSI_AMC_ADDRESS_TYPE '3' Adresse bezeichnet ABAP Session 20130508
3 ADDRESS_TYPE_WEB_SOCKET Constant Public Type reference (TYPE) SSI_AMC_ADDRESS_TYPE '2' Adresse bezeichnet Web Socket 20121108
4 CO_MSG_MAX_LENGTH Constant Public Type reference (TYPE) I 31000 Maximal message length 20130409
5 CO_MSG_TYPE_BINARY Constant Public Type reference (TYPE) I 1 Message type BINARY 20121128
6 CO_MSG_TYPE_TEXT Constant Public Type reference (TYPE) I 2 Message type TEXT 20121128
7 CO_MSG_TYPE_UTF8 Constant Public Type reference (TYPE) I 3 Message type UTF8 20121128
8 EXACT_MATCH Constant Public Type reference (TYPE) I 2 Exact Match 20121108
9 PREFIX_MATCH Constant Public Type reference (TYPE) I 1 Prefix Match 20121108
Methods
# Method Level Visibility Method type Description Created on
1 GET_MESSAGE Static method Protected Method Nachricht lesen 20121108
2 GET_RECEIVER_FOR_CHANNEL_ID Static method Protected Method Alle Receiver eines Channels ermitteln 20130830
3 READ_RECEIVER Static method Protected Method Empfänger einer Nachricht lesen 20121108
4 READ_TABLE Static method Public Method Tabelle lesen 20121108
5 RECEIVER_EXIST Static method Protected Method Gibt es registrierte Empfänger? 20130610
6 REGISTER_SESSION Static method Protected Method Session als Nachrichtenempfänger registrieren 20121108
7 REGISTER_UI Static method Protected Method SAP_UI als Nachrichtenempfänger registrieren 20130508
8 REGISTER_WEB_SOCKET Static method Protected Method Web Socket als Nachrichtenempfänger registrieren 20121108
9 REMOVE_CHANNEL_ID Static method Protected Method Nachrichten-Id aus Empfängertabelle löschen 20121108
10 REMOVE_ENTRY Static method Public Method Eintrag in AMC-Tabelle löschen 20130624
11 REMOVE_SESSION Static method Protected Method Session aus Empfängertabelle löschen 20121108
12 REMOVE_UI Static method Protected Method UI aus Empfängertabelle löschen 20130508
13 REMOVE_WEB_SOCKET Static method Protected Method Web-Socket als Tabelle entfernen 20121108
14 SEND_MESSAGE Static method Protected Method Nachricht versenden 20121108
15 SEND_MESSAGE_TO_CLIENT Static method Protected Method Nachricht versenden 20121108
16 SEND_MESSAGE_TO_USER Static method Protected Method Nachricht versenden 20121108
17 _GET_MESSAGE Static method Private Method Nachricht vom Kernel lesen 20121108
18 _READ_RECEIVER Static method Private Method Empfänger einer Nachricht lesen 20121108
19 _READ_TABLE Static method Private Method Tabelle lesen 20121108
20 _RECEIVER_EXIST Static method Private Method Gibt es registrierte Empfänger? 20130610
21 _REGISTER_SESSION Static method Private Method Session als Nachrichtenempfänger registrieren 20121108
22 _REGISTER_UI Static method Private Method SAP UI als Nachrichtenempfänger registrieren 20130508
23 _REGISTER_WEB_SOCKET Static method Private Method Web Socket als Nachrichtenempfänger registrieren 20121108
24 _REMOVE_CHANNEL_ID Static method Private Method Nachrichten-Id aus Empfängertabelle löschen 20121108
25 _REMOVE_ENTRY Static method Private Method Eintrag in AMC-Tabelle löschen 20130624
26 _REMOVE_SESSION Static method Private Method Session aus Empfängertabelle löschen 20121108
27 _REMOVE_UI Static method Private Method UI aus Empfängertabelle löschen 20130508
28 _REMOVE_WEB_SOCKET Static method Private Method Web-Socket als Tabelle entfernen 20121108
29 _SEND_MESSAGE Static method Private Method Kernel Methode Versenden einer Nachricht 20121108
Events
Class CL_SSI_AMC has no event.
Types
Class CL_SSI_AMC has no local type.
Method Signatures

Method GET_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Exporting HEADER Call by reference Type reference (TYPE) XSTRING Header 20121108
3 Exporting MESSAGE Call by reference Type reference (TYPE) XSTRING Message 20121108
# Exception Resumable Description Created on
1 CX_SSI_NO_MESSAGE no message received 20121108

Method GET_RECEIVER_FOR_CHANNEL_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message Channel ID 20130830
2 Returning RECEIVER Value transfer Type reference (TYPE) SSI_AMC_RECEIVER_TABLE Aktuelle Empfängerliste 20130830
3 Importing SYSTEMWIDE Call by reference Type reference (TYPE) SSI_BOOL '1' Empfänger Systemweit ermitteln 20130830
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20130830

Method READ_RECEIVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 2 Match Strategie 20121108
3 Exporting RECEIVER Call by reference Type reference (TYPE) SSI_AMC_RECEIVER_LIST Aktuelle Empfängerliste der Nachricht 20121108
# Exception Resumable Description Created on
1 CX_SSI_BAD_PARAMETER Bad Parameter 20130523
2 CX_SSI_INTERNAL Internal error of the ssi package 20121108
3 CX_SSI_NOT_FOUND No AMC receiver found 20130523

Method READ_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing SERVER_NAME Call by reference Type reference (TYPE) SSI_SERVERNAME Name des Applikations-Servers 20130524
2 Returning TABLE Value transfer Type reference (TYPE) SSI_AMC_RECEIVER_TABLE Aktuelle Empfängerliste 20121108
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20121108
2 CX_SSI_NO_AUTH no authority for this action 20130716

Method RECEIVER_EXIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20130610
2 Importing CLIENT Call by reference Type reference (TYPE) SSI_TENANT_ID ' ' Tenant 20130610
3 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategie 20130610
4 Exporting RECEIVER_EXIST Call by reference Type reference (TYPE) SSI_BOOL Gibt es registrierte Empfänger? 20130610
5 Importing USER Call by reference Type reference (TYPE) SSI_USER_NAME ' ' User 20130610
# Exception Resumable Description Created on
1 CX_SSI_BAD_PARAMETER Bad Parameter 20130610
2 CX_SSI_INTERNAL Internal error of the ssi package 20130610

Method REGISTER_SESSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20121108

Method REGISTER_UI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20130508
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20130508
3 Importing THIS_SESSION Call by reference Type reference (TYPE) I 1 Register this session 20130508
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20130508

Method REGISTER_WEB_SOCKET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20121108

Method REMOVE_CHANNEL_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20121108

Method REMOVE_ENTRY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message Channel ID 20130624
2 Importing ID Call by reference Type reference (TYPE) SSI_AMC_ADDRESS_ID Address 20130624
3 Importing TYPE Call by reference Type reference (TYPE) SSI_AMC_ADDRESS_TYPE Address Type 20130624
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20130625
2 CX_SSI_NOT_FOUND not found 20130625
3 CX_SSI_NO_AUTH no authority for this action 20130625

Method REMOVE_SESSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID '' Message-Channel-dentifikation 20121108
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20121108

Method REMOVE_UI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID '' Message-Channel-dentifikation 20130508
2 Importing THIS_SESSION Call by reference Type reference (TYPE) I 1 This session 20130508
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20130508

Method REMOVE_WEB_SOCKET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID '' Message-Channel-dentifikation 20121108
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20121108

Method SEND_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing HEADER Call by reference Type reference (TYPE) XSTRING Header 20121108
3 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
4 Importing MESSAGE Call by reference Type reference (TYPE) XSTRING Nachricht 20121108
5 Importing MSG_FORMAT Call by reference Type reference (TYPE) I 3 Message format (BINARY, TEXT, UTF8) 20121128
# Exception Resumable Description Created on
1 CX_SSI_INTERNAL Internal error of the ssi package 20121108
2 CX_SSI_MESSAGE_TOO_LONG Message too long 20130320

Method SEND_MESSAGE_TO_CLIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing CLIENT Call by reference Type reference (TYPE) SSI_TENANT_ID Client 20121108
3 Importing HEADER Call by reference Type reference (TYPE) XSTRING Header 20121108
4 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
5 Importing MESSAGE Call by reference Type reference (TYPE) XSTRING Nachricht 20121108
6 Importing MSG_FORMAT Call by reference Type reference (TYPE) I 3 Message format (BINARY, TEXT, UTF8) 20121128
# Exception Resumable Description Created on
1 CX_SSI_BAD_PARAMETER Bad Parameter 20121108
2 CX_SSI_INTERNAL Internal error of the ssi package 20121108
3 CX_SSI_MESSAGE_TOO_LONG Message too long 20130320

Method SEND_MESSAGE_TO_USER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing CLIENT Call by reference Type reference (TYPE) SSI_TENANT_ID Client 20121108
3 Importing HEADER Call by reference Type reference (TYPE) XSTRING Header 20121108
4 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
5 Importing MESSAGE Call by reference Type reference (TYPE) XSTRING Nachricht 20121108
6 Importing MSG_FORMAT Call by reference Type reference (TYPE) I 3 Message format (BINARY, TEXT, UTF8) 20121128
7 Importing USER Call by reference Type reference (TYPE) SSI_USER_NAME User 20121108
# Exception Resumable Description Created on
1 CX_SSI_BAD_PARAMETER Bad Parameter 20121108
2 CX_SSI_INTERNAL Internal error of the ssi package 20121108
3 CX_SSI_MESSAGE_TOO_LONG Message too long 20130320

Method _GET_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Channel-dentifikation 20121108
2 Exporting HEADER Call by reference Type reference (TYPE) XSTRING Header 20121108
3 Exporting MESSAGE Call by reference Type reference (TYPE) XSTRING Message 20121108
4 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Returncode from kernel 20121108

Method _GET_MESSAGE on class CL_SSI_AMC has no exception.

Method _READ_RECEIVER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategie 20121108
3 Exporting RECEIVER Call by reference Type reference (TYPE) SSI_AMC_RECEIVER_LIST Aktuelle Empfängerliste der Nachricht 20121108
4 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20121108

Method _READ_RECEIVER on class CL_SSI_AMC has no exception.

Method _READ_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20121108
2 Exporting TABLE Call by reference Type reference (TYPE) SSI_AMC_RECEIVER_TABLE Aktuelle Empfängerliste 20121108

Method _READ_TABLE on class CL_SSI_AMC has no exception.

Method _RECEIVER_EXIST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20130610
2 Importing CLIENT Call by reference Type reference (TYPE) SSI_TENANT_ID ' ' Tenant 20130610
3 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategie 20130610
4 Exporting RECEIVER_EXIST Call by reference Type reference (TYPE) SSI_BOOL Aktuelle Empfängerliste der Nachricht 20130610
5 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20130610
6 Importing USER Call by reference Type reference (TYPE) SSI_USER_NAME ' ' User 20130610

Method _RECEIVER_EXIST on class CL_SSI_AMC has no exception.

Method _REGISTER_SESSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
3 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20121108

Method _REGISTER_SESSION on class CL_SSI_AMC has no exception.

Method _REGISTER_UI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20130508
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20130508
3 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20130508
4 Importing THIS_SESSION Call by reference Type reference (TYPE) I 1 Register this session 20130508

Method _REGISTER_UI on class CL_SSI_AMC has no exception.

Method _REGISTER_WEB_SOCKET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
3 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20121108

Method _REGISTER_WEB_SOCKET on class CL_SSI_AMC has no exception.

Method _REMOVE_CHANNEL_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Identifikation 20121108
2 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20121108

Method _REMOVE_CHANNEL_ID on class CL_SSI_AMC has no exception.

Method _REMOVE_ENTRY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message Channel ID 20130624
2 Importing ID Call by reference Type reference (TYPE) SSI_AMC_ADDRESS_ID Address 20130624
3 Returning RETURN_CODE Value transfer Type reference (TYPE) I Returncode des Kernels 20130625
4 Importing TYPE Call by reference Type reference (TYPE) SSI_AMC_ADDRESS_TYPE Address Type 20130624

Method _REMOVE_ENTRY on class CL_SSI_AMC has no exception.

Method _REMOVE_SESSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID '' Message-Channel-dentifikation 20121108
2 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20121108

Method _REMOVE_SESSION on class CL_SSI_AMC has no exception.

Method _REMOVE_UI Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID '' Message-Channel-dentifikation 20130508
2 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20130508
3 Importing THIS_SESSION Call by reference Type reference (TYPE) I 1 this session 20130508

Method _REMOVE_UI on class CL_SSI_AMC has no exception.

Method _REMOVE_WEB_SOCKET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID '' Message-Channel-dentifikation 20121108
2 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return code from kernel 20121108

Method _REMOVE_WEB_SOCKET on class CL_SSI_AMC has no exception.

Method _SEND_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANNEL_ID Call by reference Type reference (TYPE) SSI_CHANNEL_ID Message-Channel-dentifikation 20121108
2 Importing CLIENT Call by reference Type reference (TYPE) SSI_TENANT_ID Client 20121108
3 Importing HEADER Call by reference Type reference (TYPE) XSTRING Header 20121108
4 Importing MATCH_STRATEGY Call by reference Type reference (TYPE) I 1 Match Strategy 20121108
5 Importing MESSAGE Call by reference Type reference (TYPE) XSTRING Nachricht 20121108
6 Importing MSG_FORMAT Call by reference Type reference (TYPE) I 3 Message format (BINARY, TEXT, UTF8) 20121128
7 Exporting RETURN_CODE Call by reference Type reference (TYPE) I Return Codes des Kernels 20121108
8 Importing USER Call by reference Type reference (TYPE) SSI_USER_NAME User 20121108

Method _SEND_MESSAGE on class CL_SSI_AMC has no exception.
History
Last changed by/on SAP  20140121 
SAP Release Created in 740