com.highqsoft.helper

Class ORBHelper

java.lang.Object

com.highqsoft.helper.ORBHelper

public class ORBHelper
extends java.lang.Object

This class holds the ORB and its settings.

Since:

$Date: 2017/04/06 13:29:16 $

Version:

$Revision: 1.17 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CORBA_PROTOCOL The default CORBA protocol (valie="").
static java.lang.String	DEFAULT_NAME_SERVICE_HOST The default node name for the name service (value="localhost").
static java.lang.String	DEFAULT_NAME_SERVICE_NAME The default name service name (value="NameService").
static java.lang.String	DEFAULT_NAME_SERVICE_PORT The default name service port (value=2809).
static java.lang.String	DEFAULT_ORB_IMPLEMENTATION The default ORB implementation identifier (value=SUN_ORB_IDENT).
static int	INIT_PORT The startup port, from that the coutering starts to get a free port number.
static java.lang.String	JAC_ORB_IDENT The JAC ORB implementation identifier (value="JacORB")
static int	MAX_RETRY The maximum number of retries to find the name service.
static java.lang.String	OPEN_ORB_IDENT The SUN ORB implementation identifier (value="OpenORB")
static java.lang.String	SUN_ORB_IDENT The SUN ORB implementation identifier (value="SunORB")

Constructor Summary

Constructors

Constructor and Description
ORBHelper() The constructor receiving the instance element selection consumer.
ORBHelper(org.omg.CORBA.ORB orb, java.lang.String initialRef) The constructor receiving the instance element selection consumer.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	createOrb() Create the orb.
static org.omg.CORBA.ORB	createOrb(java.lang.String nameServiceHost, java.lang.String nameServicePort, java.lang.String orbImplementation, java.lang.String nameServiceName) Create an ORB.
static org.omg.CORBA.ORB	createOrb(java.lang.String nameServiceHost, java.lang.String nameServicePort, java.lang.String corbaProtocol, java.lang.String orbImplementation, java.lang.String nameServiceName) Create an ORB.
static org.omg.PortableServer.POA	createPOA(java.lang.Object object) Create a POA using a class.
static org.omg.PortableServer.POA	createPOA(org.omg.PortableServer.POA parent, java.lang.Object object) Create a POA using a class.
static org.omg.PortableServer.POA	createPOA(org.omg.PortableServer.POA parent, java.lang.String name) Create a POA
org.omg.PortableServer.POA	createPOA(java.lang.String name) Create a POA
protected void	debug(java.lang.String message) Print out a debug message.
protected void	finalize() Finalize the object.
static ORBHelper	getInstance() Get the instance of the helper.
java.util.logging.Level	getLogLevel() Get the log level.
org.omg.CosNaming.NamingContextExt	getNameService() Get the name service.
static org.omg.CosNaming.NamingContextExt	getNameService(org.omg.CORBA.ORB orb, java.lang.String orbInitRef) Get the name service.
java.lang.String	getNameServiceName() Get the name service name.
static java.lang.String	getNameServiceName(java.lang.String initialRef) Get the name service name.
org.omg.CORBA.ORB	getORB() Get the orb
int	getPort() Get the portnumber.
int	getPortNumber() Get the port number.
org.omg.PortableServer.POA	getRoot() Get the root POA
static org.omg.CORBA.Object	getServiceByName(org.omg.CORBA.ORB orb, org.omg.CosNaming.NamingContextExt nameService, java.lang.String serviceName) Get the service that is registered at name service with the given name.
static void	main(java.lang.String[] args)
static java.lang.String	nameServiceName(java.lang.String orbInitRef) Extract the name service name from initial reference string.
static int	portNumber(java.lang.String initialRef) Get the port number.
void	release() Release the CORBA stuff and shutdown orb.
void	setLogLevel(java.util.logging.Level level) Set the log level.
static void	shutdownOrb(org.omg.CORBA.ORB orb) Shutdown the ORB.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SUN_ORB_IDENT

public static final java.lang.String SUN_ORB_IDENT

The SUN ORB implementation identifier (value="SunORB")

See Also:

Constant Field Values

OPEN_ORB_IDENT

public static final java.lang.String OPEN_ORB_IDENT

The SUN ORB implementation identifier (value="OpenORB")

See Also:

Constant Field Values

JAC_ORB_IDENT

public static final java.lang.String JAC_ORB_IDENT

The JAC ORB implementation identifier (value="JacORB")

See Also:

Constant Field Values

DEFAULT_NAME_SERVICE_NAME

public static final java.lang.String DEFAULT_NAME_SERVICE_NAME

The default name service name (value="NameService").

See Also:

Constant Field Values

DEFAULT_NAME_SERVICE_PORT

public static final java.lang.String DEFAULT_NAME_SERVICE_PORT

The default name service port (value=2809).

See Also:

Constant Field Values

DEFAULT_CORBA_PROTOCOL

public static final java.lang.String DEFAULT_CORBA_PROTOCOL

The default CORBA protocol (valie="").

See Also:

Constant Field Values

DEFAULT_NAME_SERVICE_HOST

public static final java.lang.String DEFAULT_NAME_SERVICE_HOST

The default node name for the name service (value="localhost").

See Also:

Constant Field Values

DEFAULT_ORB_IMPLEMENTATION

public static final java.lang.String DEFAULT_ORB_IMPLEMENTATION

The default ORB implementation identifier (value=SUN_ORB_IDENT).

See Also:

Constant Field Values

MAX_RETRY

public static final int MAX_RETRY

The maximum number of retries to find the name service. The value = 2

See Also:

Constant Field Values

INIT_PORT

public static final int INIT_PORT

The startup port, from that the coutering starts to get a free port number. The value = 4567.

See Also:

Constant Field Values

Constructor Detail

ORBHelper

public ORBHelper()

The constructor receiving the instance element selection consumer.

ORBHelper

public ORBHelper(org.omg.CORBA.ORB orb,
         java.lang.String initialRef)
          throws java.lang.Exception

The constructor receiving the instance element selection consumer.

Parameters:

orb - the orb implementation.

initialRef - the initial reference string.

Throws:

java.lang.Exception - if the POA creation process fails.

Method Detail

getInstance

public static ORBHelper getInstance()

Get the instance of the helper.

Returns:

the helper

getPort

public int getPort()

Get the portnumber.

Returns:

the portnumber

getORB

public org.omg.CORBA.ORB getORB()

Get the orb

Returns:

the orb

getRoot

public org.omg.PortableServer.POA getRoot()

Get the root POA

Returns:

the root POA

createPOA

public org.omg.PortableServer.POA createPOA(java.lang.String name)
                                     throws org.omg.PortableServer.POAPackage.AdapterAlreadyExists,
                                            org.omg.PortableServer.POAManagerPackage.AdapterInactive,
                                            org.omg.PortableServer.POAPackage.InvalidPolicy

Create a POA

Parameters:

name - the name of the new POA.

Returns:

the POA object.

Throws:

org.omg.PortableServer.POAPackage.AdapterAlreadyExists - If the POA already exists.

org.omg.PortableServer.POAManagerPackage.AdapterInactive - If the adapter exist but is not active.

org.omg.PortableServer.POAPackage.InvalidPolicy - If the policy is not sufficient.

finalize

protected void finalize()
                 throws java.lang.Throwable

Finalize the object.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

release

public void release()

Release the CORBA stuff and shutdown orb.

createOrb

protected boolean createOrb()

Create the orb.

Returns:

true if the creation was successful.

createOrb

public static org.omg.CORBA.ORB createOrb(java.lang.String nameServiceHost,
                          java.lang.String nameServicePort,
                          java.lang.String orbImplementation,
                          java.lang.String nameServiceName)
                                   throws java.lang.Exception

Create an ORB. The implementation uses the following defaults:

	parameter	default
nameServiceHost	localhost
nameServicePort	2809
nameServiceName	NameService
orbImplementation	sunORB

Parameters:

nameServiceHost - the name service host name

nameServicePort - the name service port

orbImplementation - the orb implementation (sunOrb and openORB are currently implemented).

nameServiceName - the name service name

Returns:

the orb

Throws:

java.lang.Exception - if the ORB implementation is not handled.

createOrb

public static org.omg.CORBA.ORB createOrb(java.lang.String nameServiceHost,
                          java.lang.String nameServicePort,
                          java.lang.String corbaProtocol,
                          java.lang.String orbImplementation,
                          java.lang.String nameServiceName)
                                   throws java.lang.Exception

Create an ORB. The implementation uses the following defaults:

	parameter	default
nameServiceHost	localhost
nameServicePort	2809
corbaProtocol
nameServiceName	NameService
orbImplementation	sunORB

Parameters:

nameServiceHost - the name service host name

nameServicePort - the name service port

corbaProtocol - the CORBA protocol

orbImplementation - the orb implementation (sunOrb and openORB are currently implemented).

nameServiceName - the name service name

Returns:

the orb

Throws:

java.lang.Exception - if the ORB implementation is not handled.

shutdownOrb

public static void shutdownOrb(org.omg.CORBA.ORB orb)

Shutdown the ORB.

Parameters:

orb - the orb to be shutdown.

getNameService

public org.omg.CosNaming.NamingContextExt getNameService()
                                                  throws java.lang.Exception

Get the name service.

Returns:

the name service context.

Throws:

java.lang.Exception - if something is wrong with the connection.

java.lang.Exception - if the communication fails.

getNameService

public static org.omg.CosNaming.NamingContextExt getNameService(org.omg.CORBA.ORB orb,
                                                java.lang.String orbInitRef)
                                                         throws java.lang.Exception

Get the name service.

Parameters:

orb - the orb implementation.

orbInitRef - the initial reference string.

Returns:

the name service context.

Throws:

java.lang.Exception - if the communication fails.

nameServiceName

public static java.lang.String nameServiceName(java.lang.String orbInitRef)

Extract the name service name from initial reference string.

Parameters:

orbInitRef - the initial reference string.

Returns:

the name service name.

getNameServiceName

public java.lang.String getNameServiceName()

Get the name service name.

Parameters:

orbInitRef -

Returns:

the name service name.

getNameServiceName

public static java.lang.String getNameServiceName(java.lang.String initialRef)

Get the name service name.

Parameters:

orbInitRef -

Returns:

the name service name.

getPortNumber

public int getPortNumber()

Get the port number.

Returns:

the port number

portNumber

public static int portNumber(java.lang.String initialRef)

Get the port number.

Parameters:

initialRef - the initial reference string.

Returns:

the port number

setLogLevel

public void setLogLevel(java.util.logging.Level level)

Set the log level.

Parameters:

level - the log level.

See Also:

Level

getLogLevel

public java.util.logging.Level getLogLevel()

Get the log level.

Returns:

the level

See Also:

Level

createPOA

public static org.omg.PortableServer.POA createPOA(org.omg.PortableServer.POA parent,
                                   java.lang.Object object)
                                            throws org.omg.PortableServer.POAPackage.AdapterAlreadyExists,
                                                   org.omg.PortableServer.POAManagerPackage.AdapterInactive,
                                                   org.omg.PortableServer.POAPackage.InvalidPolicy

Create a POA using a class.

Throws:

org.omg.PortableServer.POAPackage.AdapterAlreadyExists

org.omg.PortableServer.POAManagerPackage.AdapterInactive

org.omg.PortableServer.POAPackage.InvalidPolicy

createPOA

public static org.omg.PortableServer.POA createPOA(java.lang.Object object)
                                            throws org.omg.PortableServer.POAPackage.AdapterAlreadyExists,
                                                   org.omg.PortableServer.POAManagerPackage.AdapterInactive,
                                                   org.omg.PortableServer.POAPackage.InvalidPolicy

Create a POA using a class.

Throws:

org.omg.PortableServer.POAPackage.AdapterAlreadyExists

org.omg.PortableServer.POAManagerPackage.AdapterInactive

org.omg.PortableServer.POAPackage.InvalidPolicy

createPOA

public static org.omg.PortableServer.POA createPOA(org.omg.PortableServer.POA parent,
                                   java.lang.String name)
                                            throws org.omg.PortableServer.POAPackage.AdapterAlreadyExists,
                                                   org.omg.PortableServer.POAManagerPackage.AdapterInactive,
                                                   org.omg.PortableServer.POAPackage.InvalidPolicy

Create a POA

Throws:

org.omg.PortableServer.POAPackage.AdapterAlreadyExists

org.omg.PortableServer.POAManagerPackage.AdapterInactive

org.omg.PortableServer.POAPackage.InvalidPolicy

getServiceByName

public static org.omg.CORBA.Object getServiceByName(org.omg.CORBA.ORB orb,
                                    org.omg.CosNaming.NamingContextExt nameService,
                                    java.lang.String serviceName)
                                             throws org.omg.CosNaming.NamingContextPackage.NotFound,
                                                    org.omg.CosNaming.NamingContextPackage.InvalidName,
                                                    org.omg.CosNaming.NamingContextPackage.CannotProceed

Get the service that is registered at name service with the given name.

Parameters:

orb - the ORB

nameService - the name service

serviceName - the name of the service.

Returns:

the CORBA object of the service. The client must narrow the object it self to cast it to a special object type.

Throws:

org.omg.CosNaming.NamingContextPackage.NotFound

org.omg.CosNaming.NamingContextPackage.InvalidName

org.omg.CosNaming.NamingContextPackage.CannotProceed

debug

protected void debug(java.lang.String message)

Print out a debug message. This will be done on standard out when the FwkContainer DebugLevel is greater equal 1.

Parameters:

message - the message to be printed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

main

public static void main(java.lang.String[] args)
                 throws java.lang.Throwable

Throws:

java.lang.Throwable