XML Inbound Server
Use
The XML inbound server waits for inbound messages at an HTTP port. When a message arrives for the implementing Java interface, the system instantiates the corresponding class from the Java Proxy Framework and calls it using the method that represents the inbound operation of the inbound interface. The method objects are also instantiated so that the application immediately has access to the data for further processing. You normally use the generated get-methods to access the data.
If you compile your implementing Java class again while the XML inbound server is in operation, you must restart the system so that the Java VM on which the inbound server runs, knows a change has been made.
Prerequisites
The host of the XML inbound server must have a static IP address so that it can be reached if the Integration Engine is running on a Unix computer (dynamic IP addresses are not recognized by Unix networks in DNS (Domain Name Service)).
Features
Registration Using jpf.registry
The system searches for the jpf.registry file in the Java work directory, and in the class path of the Java application when you start the inbound server. Once the inbound server has been started, it knows automatically if entries in the file have been changed and updates its registrations accordingly. You assign an implementing Java class to an inbound interface from the Integration Repository, using a line in this file. The line is structured as follows:
<Interface Namespace>#<Inbound Interface>=<Java Class>:<Java Method>
<Inbound Interface> is the name of the interface in the Integration Repository. If the character '#', '=' or ' occurs in one of the names then this must be indicated using the escape character backslash (\), as in the following example:
http\://com/sap/aii/proxy/example#Listening=ExampleService:receive
Using this registration, the XML Inbound Server would instantiate the class
ExampleService for an incoming message with the inbound interface Listening in the namespace http://com.sap.aii.proxy.example, and call its method receive.Inbound Server Commands
All commands to the inbound server are structured as follows:
java -classpath <classpath>
com.sap.aii.proxy.framework.core.XmlInboundServer <command>
You can both start and stop the server, as well as register your implementing classes dynamically:
Commands to the Inbound Server
|
Command |
Meaning |
|
start |
Starts the server. It then starts the HTTP server, which waits for messages at the host and port for the Integration Server specified in jpf.properties (also see: Configuration Files). The file jpf_inbound_server_flag, in the Java work directory, indicates that the server is running. As long as this file exists, no other inbound proxy server can be started. |
|
stop |
Stops the server. As a result, the system removes the file jpf.inbound_server_flag from the Java work directory. |
|
register <reg> |
Registers an inbound interface. The parameter <reg> has the same structure as a line from the jpf.registry file (see above), except that you must replace the equals sign (‘=’) with a blank. |
|
unregister <reg> |
Deregisters an inbound interface. The parameter <reg> has the same structure as a line from the jpf.registry file (see above), except that you must replace the equals sign (‘=’) with a blank. |
|
-r <Filename> register |
Registers a series of inbound interfaces in the file <file name> on the inbound server, in the same way that you register interfaces using the jpf.registry file. |
|
-r <Filename> unregister |
De-registers all inbound interfaces that are assigned to a class in <file name>. |
|
unregisterAll |
De-registers all interfaces registered on the inbound server. |
Activities