The example server consists of two classes, the servant and the server. The servant, HelloImpl, is the implementation of the Hello IDL interface; each Hello instance is implemented by a HelloImpl instance. The servant is a subclass of HelloPOA, which is generated by the idlj compiler from the example IDL.
The servant contains one method for each IDL operation, in this example, the sayHello() and shutdown() methods. Servant methods are just like ordinary Java methods; the extra code to deal with the ORB, with marshaling arguments and results, and so on, is provided by the skeleton.
The server class has the server's main() method, which:
This lesson introduces the basics of writing a CORBA server. For an example of the "Hello World" program with a persistent object server, see Example 2: Hello World with Persistent State. For more discussion of CORBA servers, see Developing Servers.
The steps in this lesson cover:
To create HelloServer.java,
// HelloServer.java
import HelloApp.*;
import org.omg.CosNaming.*;
import org.omg.CosNaming.NamingContextPackage.*;
import org.omg.CORBA.*;
import org.omg.PortableServer.*;
import org.omg.PortableServer.POA;
import java.util.Properties;
class HelloImpl extends HelloPOA {
private ORB orb;
public void setORB(ORB orb_val) {
orb = orb_val;
}
// implement sayHello() method
public String sayHello() {
return "\nHello world !!\n";
}
// implement shutdown() method
public void shutdown() {
orb.shutdown(false);
}
}
public class HelloServer {
public static void main(String args[]) {
try{
// create and initialize the ORB
ORB orb = ORB.init(args, null);
// get reference to rootpoa & activate the POAManager
POA rootpoa = POAHelper.narrow(orb.resolve_initial_references("RootPOA"));
rootpoa.the_POAManager().activate();
// create servant and register it with the ORB
HelloImpl helloImpl = new HelloImpl();
helloImpl.setORB(orb);
// get object reference from the servant
org.omg.CORBA.Object ref = rootpoa.servant_to_reference(helloImpl);
Hello href = HelloHelper.narrow(ref);
// get the root naming context
org.omg.CORBA.Object objRef =
orb.resolve_initial_references("NameService");
// Use NamingContextExt which is part of the Interoperable
// Naming Service (INS) specification.
NamingContextExt ncRef = NamingContextExtHelper.narrow(objRef);
// bind the Object Reference in Naming
String name = "Hello";
NameComponent path[] = ncRef.to_name( name );
ncRef.rebind(path, href);
System.out.println("HelloServer ready and waiting ...");
// wait for invocations from clients
orb.run();
}
catch (Exception e) {
System.err.println("ERROR: " + e);
e.printStackTrace(System.out);
}
System.out.println("HelloServer Exiting ...");
}
}
This section explains each line of HelloServer.java, describing what the code does, as well as why it is needed for this application.
The structure of a CORBA server program is the same as most Java applications: You import required library packages, declare the server class, define a main() method, and handle exceptions.
First, we import the packages required for the server class:
// The package containing our stubs import HelloApp.*; // HelloServer will use the naming service import org.omg.CosNaming.*; // The package containing special exceptions thrown by the name service import org.omg.CosNaming.NamingContextPackage.*; // All CORBA applications need these classes import org.omg.CORBA.*; // Classes needed for the Portable Server Inheritance Model import org.omg.PortableServer.*; import org.omg.PortableServer.POA; // Properties to initiate the ORB import java.util.Properties;
In this example, we are defining the class for the servant object within HelloServer.java, but outside the HelloServer class.
class HelloImpl extends HelloPOA
{
// The sayHello() and shutdown() methods go here.
}
The servant is a subclass of HelloPOA so that it inherits the general CORBA functionality generated for it by the compiler.
First, we create a private variable, orb that is
used in the setORB(ORB) method. The setORB
method is a private method defined by the application developer so
that they can set the ORB value with the servant. This ORB value is
used to invoke shutdown() on that specific ORB in response
to the shutdown() method invocation from the client.
private ORB orb;
public void setORB(ORB orb_val) {
orb = orb_val;
}
Next, we declare and implement the required sayHello() method:
public String sayHello()
{
return "\nHello world!!\n";
}
And last of all, we implement the shutdown() method
in a similar way. The shutdown() method calls the
org.omg.CORBA.ORB.shutdown(boolean) method for the
ORB. The shutdown(false) operation indicate that the
ORB should shut down immediately, without waiting for processing to
complete.
public void shutdown() {
orb.shutdown(false);
}
The next step is to declare the server class:
public class HelloServer
{
// The main() method goes here.
}
Every Java application needs a main method. It is declared within the scope of the HelloServer class:
public static void main(String args[])
{
// The try-catch block goes here.
}
Because all CORBA programs can throw CORBA system exceptions at runtime, all of the main() functionality is placed within a try-catch block. CORBA programs throw runtime exceptions whenever trouble occurs during any of the processes (marshaling, unmarshaling, upcall) involved in invocation. The exception handler simply prints the exception and its stack trace to standard output so you can see what kind of thing has gone wrong.
The try-catch block is set up inside main(), as shown:
try{
// The rest of the HelloServer code goes here.
} catch(Exception e) {
System.err.println("ERROR: " + e);
e.printStackTrace(System.out);
}
A CORBA server needs a local ORB object, as does the CORBA client. Every server instantiates an ORB and registers its servant objects so that the ORB can find the server when it receives an invocation for it.
The ORB variable is declared and initialized inside the try-catch block.
ORB orb = ORB.init(args, null);
The call to the ORB's init() method passes in the server's command line arguments, allowing you to set certain properties at runtime.
The ORB obtains the initial object references to services such
as the Name Service using the method
resolve_initial_references.
The reference to the root POA is retrieved and the POAManager is activated from within the try-catch block.
POA rootpoa = POAHelper.narrow(orb.resolve_initial_references("RootPOA"));
rootpoa.the_POAManager().activate();
The activate() operation changes the state of the
POA manager to active, causing associated POAs to start processing
requests. The POA manager encapsulates the processing state of the
POAs with which it is associated. Each POA object has
an associated POAManager object. A POA manager may be
associated with one or more POA objects.
We instantiate the servant object inside the try-catch block, just after activating the POA manager, as shown:
HelloImpl helloImpl = new HelloImpl();
The section of code describing the servant class was explained previously.
In the next line of code, setORB(orb) is defined on the servant so that ORB.shutdown() can be called as part of the shutdown operation. This step is required because of the shutdown() method defined in Hello.idl.
helloImpl.setORB(orb);
There are other options for implementing the shutdown operation. In this example, the shutdown() method called on the Object takes care of shutting down an ORB. In another implementation, the shutdown method implementation could have simply set a flag, which the server could have checked and called shutdown().
The next set of code is used to get the object reference associated with the servant. The narrow() method is required to cast CORBA object references to their proper types.
org.omg.CORBA.Object ref = rootpoa.servant_to_reference(helloImpl);
Hello href = HelloHelper.narrow(ref);
The HelloServer works with the Common Object Services (COS) Naming Service to make the servant object's operations available to clients. The server needs an object reference to the naming service so that it can publish the references to the objects implementing various interfaces. These object references are used by the clients for invoking methods. Another way a servant can make the objects available to clients for invocations is by stringifying the object references to a file.
The two options for Naming Services shipped with J2SE v.1.4 are:
This example uses orbd.
In the try-catch block, below getting the object reference for the servant, we call orb.resolve_initial_references() to get an object reference to the name server:
org.omg.CORBA.Object objRef =
orb.resolve_initial_references("NameService");
The string "NameService" is defined for all CORBA ORBs. When you pass in that string, the ORB returns a naming context object that is an object reference for the name service. The string "NameService" indicates:
The proprietary string "TNameService" indicates that the naming service will be transient when using ORBD's naming service.
As with all CORBA object references, objRef is a generic CORBA object. To use it as a NamingContextExt object, you must narrow it to its proper type. The call to narrow() is just below the previous statement:
NamingContextExt ncRef = NamingContextExtHelper.narrow(objRef);
Here you see the use of an idlj-generated helper class, similar in function to HelloHelper. The ncRef object is now an org.omg.CosNaming.NamingContextExt and you can use it to access the naming service and register the server, as shown in the next topic.
The NamingContextExt object is part of the Interoperable Naming Service specification.
Just below the call to narrow(), we create a new NameComponent array. Because the path to Hello has a single element, we create the single-element array that NamingContext.resolve requires for its work:
String name = "Hello";
NameComponent path[] = ncRef.to_name( name );
Finally, we pass path and the servant object to the naming service, binding the servant object to the "Hello" id:
ncRef.rebind(path, href);
Now, when the client calls resolve("Hello") on the initial naming context, the naming service returns an object reference to the Hello servant.
The previous sections describe the code that makes the server ready; the next section explains the code that enables it to simply wait around for a client to request its service. The following code, which is at the end of (but within) the try-catch block, shows how to accomplish this.
orb.run();
When called by the main thread, ORB.run() enables the
ORB to perform work using the main thread, waiting until an
invocation comes from the ORB. Because of its placement in
main(), after an invocation completes and
sayHello() returns, the server will wait again. This is
the reason that the HelloClient explicitly shuts down
the ORB after completing its task.
Now we will compile the HelloServer.java so that we can correct any errors before continuing with this tutorial.
Windows users note that you should substitute backslashes (\) for the slashes (/) in all paths in this document.
To compile HelloServer.java,
javac HelloServer.java HelloApp/*.java
Running the Hello World Application discusses running HelloServer and the rest of the application.
CORBA supports at least two different server-side mappings for implementing an IDL interface:
Using the Inheritance Model, you implement the IDL interface using an implementation class that also extends the compiler-generated skeleton.
Inheritance models include:
The default server-side mapping generated when either the -fall or -fserver arguments are used conform to Chapter 11, Portable Object Adapter (POA) of the CORBA 2.3.1 Specification (formal/99-10-07). For more information on the POA, see Portable Object Adapter.
The advantages of using the Portable Object Adaptor (POA) are:
NOTE: ImplBase is obsoleted in favor of the POA model, but is provided to allow compatibility with servers written in J2SE 1.3 and prior. We do not recommend creating new servers using this nonstandard model.
Using the Delegation Model, you implement the IDL interface using two classes:
The Delegation model is also known as the Tie model, or the Tie Delegation model. It inherits from either the POA or ImplBase compiler-generated skeleton, so the models will be described as POA/Tie or ImplBase/Tie models in this document.
This tutorial presents the POA Inheritance model for server-side implementation. For tutorials using the other server-side implementations, see the following documents:
You might want to use the Tie model instead of the typical Inheritance model if your implementation must inherit from some other implementation. Java allows any number of interface inheritance, but there is only one slot for class inheritance. If you use the inheritance model, that slot is used up . By using the Tie Model, that slot is freed up for your own use. The drawback is that it introduces a level of indirection: one extra method call occurs when invoking a method.
The ImplBase server-side model is an Inheritance Model, as is the POA model. Use the idlj compiler with the -oldImplBase flag to generate server-side bindings that are compatible with older version of Java IDL (prior to J2SE 1.4).
Note that using the -oldImplBase flag is non-standard: these APIs are obsoleted. You would use this flag ONLY for compatibility with existing servers written in J2SE 1.3 or earlier. In that case, you would need to modify an existing MAKEFILE to add the -oldImplBase flag to the idlj compiler, otherwise POA-based server-side mappings will be generated.
