[Previous] [Contents] [Next] [IONA Technologies]


CORBA.BaseObject


Contents

CORBA.BaseObject._baseInterfaces()
CORBA.BaseObject._create_request()
CORBA.BaseObject._get_implementation()
CORBA.BaseObject._get_interface()
CORBA.BaseObject._host()
CORBA.BaseObject._implementation()
CORBA.BaseObject._implementation()
CORBA.BaseObject._interfaceHost()
CORBA.BaseObject._interfaceImplementation()
CORBA.BaseObject._interfaceMarker()
CORBA.BaseObject._isNull()
CORBA.BaseObject._isRemote()
CORBA.BaseObject._marker()
CORBA.BaseObject._marker()
CORBA.BaseObject._object_to_string()
CORBA.BaseObject._object_to_string()
CORBA.BaseObject._request()
CORBA.BaseObject.toString()



Synopsis:

Class BaseObject implements functionality common to all OrbixWeb objects. This functionality includes the implementation of all methods defined in the interface CORBA._ObjectRef and allows the characteristics of an OrbixWeb object reference to be retrieved and manipulated.

Programmers never need to directly instantiate CORBA.BaseObject; Java classes generated from IDL interface definitions implement _ObjectRef by inheriting from class CORBA.BaseObject. In an OrbixWeb client, the methods of this class are called on a proxy, unless collocation is set.

OrbixWeb:

See Also:



CORBA.BaseObject._baseInterfaces()


Synopsis:

Description:

Returns a list of the base interfaces of the IDL interface for OrbixWeb object, which includes the interface of the object itself. Each string in the returned sequence of strings holds a single interface name.

Notes:

OrbixWeb specific.



CORBA.BaseObject._create_request()


Synopsis:

Description:

Constructs a Request object. See CORBA.BaseObject._request() for an alternative way to create a Request. See Chapter 19, "Dynamic Invocation Interface", of the OrbixWeb Programming Guide for examples of the use of this method.

Parameters:



ctx

Context object, if any, to be sent in the Request. If the ctx argument to _create_request() is a nil Context object reference, then the Context may be added by calling the ctx() method on the Request object.

operation The name of the operation.

arg_list The parameters (each parameter in the list is of type NamedValue). If the arg_list argument of the constructor is zero, then the arguments must be added by calling the arguments() method on the Request object–one call to arguments() for each argument which is to be passed.

result Contains the return value of the operation.

hrequest A holder for the Request object created by the method. A programmer who wishes to call this method should pre-allocate the RequestHolder object, in line with the standard rules for Holder classes.

req_flags Flag settings for the method invocation.

Return Value:

Returns 1 if successful, 0 otherwise.

Notes:

CORBA defined. This method is part of the Dynamic Invocation Interface.

See Also:



CORBA.BaseObject._get_implementation()


Synopsis:

Description:

Finds the name of the target object's server as registered in the Implementation Repository. For a local object in a server, this will be that server's name if it is known, otherwise it will be the process identifier of the server process. For an object created in the client, it will be the process identifier of the client process. Note that the server name will be known if the server is launched by the OrbixWeb daemon; or if it is launched manually and the server name is passed to CORBA.BOA.impl_is_ready() or set by CORBA.ORB.setServerName().

Notes:

CORBA defined.

See Also:



CORBA.BaseObject._get_interface()


Synopsis:

Description:

Returns a reference to an object in the Interface Repository which describes the interface of this object.

Note that the -R switch (which generates support for use of the Interface Repository) must have been specified to the IDL compiler when the interface was compiled. Otherwise, _get_interface() raises an exception.

Notes:

CORBA defined.



CORBA.BaseObject._host()


Synopsis:

Description:

Returns the name of the host on which the target object is located.

Notes:

OrbixWeb specific.



CORBA.BaseObject._implementation()


Synopsis:

Description:

Finds the name of the target object's server as registered in the Implementation Repository. For a local object in a server, this will be that server's name (if that server's name is known), otherwise it will be the process' identifier or a unique identifier implemented by OrbixWeb. Note that the server name will be known if the server is launched by OrbixWeb; or if it is launched manually and the server name is passed to CORBA.BOA.impl_is_ready() or CORBA.BOA.obj_is_ready() or set by CORBA.ORB.setServerName().

Notes:

OrbixWeb specific. The CORBA defined version of this method is CORBA.BaseObject._get_implementation().

See Also:



CORBA.BaseObject._implementation()


Synopsis:

Description:

Sets the name of the target object's server. Note that this method should be used with caution, as altering the server name associated with an object reference may render the object reference invalid. This method is most commonly used in servers, to assign a server name to an object reference before CORBA.BOA.impl_is_ready() or CORBA.ORB.setServerName() has been called.

Notes:

OrbixWeb specific.

See Also:



CORBA.BaseObject._interfaceHost()


Synopsis:

Description:

Finds the name of a host running an Interface Repository server which stores the target object's IDL definition.

Notes:

OrbixWeb specific.



CORBA.BaseObject._interfaceImplementation()


Synopsis:

Description:

Returns the name of the Interface Repository server, IR.

Notes:

OrbixWeb specific.



CORBA.BaseObject._interfaceMarker()


Synopsis:

Description:

Returns the name of the target object's interface. The interface name is preceded by a path name if the -R and -d switches are passed to the IDL compiler. For example, if interface Account is defined in the file bank.idl, then possible return values for a call to this method on an object of type Account are:

No switches to IDL compiler

Account

-R bank.idl$Account

-R -d banks/commercialBanks banks/CommercialBanks/bank.idl$Account

Notes:

OrbixWeb specific.



CORBA.BaseObject._isNull()


Synopsis:

Description:

If an object is created with an invalid object reference then a "null" object is created. This method determines whether the invoked object is a null object.

Return Value:

Returns true if the object is a null object, returns false otherwise. This method also returns true if the invoked object is a null proxy.

Notes:

OrbixWeb specific.

See Also:



CORBA.BaseObject._isRemote()


Synopsis:

Description:

Determines whether or not an object reference is remote -----that is, whether or not the object it references is in a different address space on the local or a remote host.

Return Value:

Returns true if the reference is to a remote object (that is, the target of the call is a proxy), returns false otherwise.

Notes:

OrbixWeb specific.

See Also:



CORBA.BaseObject._marker()


Synopsis:

Description:

Finds the target object's marker name.

Notes:

OrbixWeb specific.

See Also:



CORBA.BaseObject._marker()


Synopsis:

Description:

Sets the target object's marker name. Chapter 7, "Publishing Object References in Servers" of the OrbixWeb Programming Guide describes the issues involved in naming OrbixWeb objects.

Notes:

OrbixWeb specific.

See Also:



CORBA.BaseObject._object_to_string()


Synopsis:

Description:

Converts the target object's reference to a string. The format of the string depends on the communications protocol used to create the object (that is, Orbix protocol or Internet Inter-ORB Protocol, IIOP).

An OrbixWeb stringified object reference in Orbix protocol format has the form:

:\host:serverName:marker:IR_host:IR_Server:interfaceMarker

See CORBA.ORB.object_to_string() for an explanation of these fields.

Return Value:

Returns a stringified object reference.

Notes:

OrbixWeb specific. See CORBA.ORB.object_to_string() for CORBA defined version of this function.

See Also:



CORBA.BaseObject._object_to_string()


Synopsis:

Description:

Converts the target object's reference to a string. The format of the string returned is determined by the value of parameter kind. If the value of kind is _CORBA.IT_ORBIX_OR_KIND, then the string returned is in the standard Orbix reference string format:

:\host:serverName:marker:IR_host:IR_Server:interfaceMarker

If the value of kind is _CORBA.IT_INTEROPERABLE_OR_KIND, then the string returned is a CORBA Interoperable Object Reference (IOR) for use with the Internet Inter-ORB Protocol (IIOP), as described in Chapter 9, "ORB Interoperability", of the OrbixWeb Programming Guide.

See CORBA.ORB.object_to_string() for an explanation of the fields in the Orbix object reference format.

Parameters:



     kind
    
The format of the object reference string to be returned. Can take the value _CORBA.IT_ORBIX_OR_KIND (to indicate the object reference format associated with the Orbix communications protocol) or _CORBA.IT_INTEROPERABLE_OR_KIND (to indicate the IOR format, associated with IIOP).

Return Value:

Returns a stringified object reference.

Notes:

OrbixWeb specific. See CORBA.ORB.object_to_string() for CORBA defined version of this function.

See Also:



CORBA.BaseObject._request()


Synopsis:

Description:

Constructs a Request on the target object. This is the shorter form of CORBA.BaseObject._create_request().

Arguments and contexts may be added after construction using CORBA.Request.arguments() and CORBA.Request.ctx(). See Chapter 19, "Dynamic Invocation Interface" of the OrbixWeb Programming Guide for examples of the use of this method.

Parameters:



     operation
    
The name of the operation.

Notes:

CORBA defined.

See Also:

CORBA.BaseObject._create_request()

CORBA.Request.arguments()

CORBA.Request.ctx()



CORBA.BaseObject.toString()


Synopsis:

Description:

A Java-specific form of the method _object_to_string(). See CORBA.BaseObject._object_to_string() for details.

Notes:

OrbixWeb specific.

See Also:



[Roadmap] [Utilities] [Compiling] [Configuration]
[Class Reference] [IR Reference] [Daemon Reference] [IDL Grammar] [System Exceptions]
[Index]