All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.omg.CORBA.Object

public interface Object

IDL definition: 
interface Object {
boolean _is_a(
in ::CORBA::RepositoryId repId
);
boolean _is_equivalent(
in ::CORBA::Object other_object
);
boolean _non_existent();
unsigned long _hash(
in unsigned long maximum
);
::CORBA::Object _duplicate();
void _release();
::CORBA::Request _request(
in ::CORBA::Identifier operation
);
::CORBA::Request _create_request(
in ::CORBA::Context ctx,
in ::CORBA::Identifier operation,
in ::CORBA::NVList arg_list,
in ::CORBA::NamedValue result
);
::CORBA::Request _create_request(
in ::CORBA::Context ctx,
in ::CORBA::Identifier operation,
in ::CORBA::NVList arg_list,
in ::CORBA::NamedValue result,
in ::CORBA::ExceptionList exceptions,
in ::CORBA::ContextList contexts
);
::CORBA::InterfaceDef _get_interface();
::CORBA::ImplementationDef _get_implementation();
::CORBA::ORB _orb();
::CORBA::BOA _boa();
::CORBA::Identifier _object_name();
::CORBA::RepositoryId _repository_id();
boolean _is_local();
boolean _is_remote();
boolean _is_bound();
boolean _is_persistent();
attribute ::CORBA::Principal _principal;
attribute ::CORBA::BindOptions _bind_options;
::CORBA::Object _clone();
::CORBA::Object _resolve_reference(
in string id
);
};

The Object interface is the root of the CORBA inheritance hierarchy. All interfaces defined in IDL will inherit this interface. This root interface provides functionality for all CORBA interfaces, including network-aware runtime type information, and network-aware object reference equivalence testing, etc. See the specific method descriptions below for details on the difference between network-aware versions of RTTI, equivalence, etc.

Method Index

o _bind_options()
Set or get the bind options associated with the object.
o _bind_options(BindOptions)
Set or get the bind options associated with the object.
o _boa()
Gets the Basic Object Adapter assocaited with the object.
o _clone()
Creates a copy of the object reference, which has its own TCP connection to the server.
o _create_request(Context, String, NVList, NamedValue)
Create a filled dynamic invocation request.
o _create_request(Context, String, NVList, NamedValue, ExceptionList, ContextList)
Create a filled dynamic invocation request.
o _duplicate()
This operation is provided for future extensions.
o _get_implementation()
Returns the implementation definition of the object.
o _get_interface()
Returns the interface definition of the object.
o _hash(int)
Compute a hash value for the object in the range [0..maximum).
o _is_a(String)
Queries an object to see if it implements the specified interface.
o _is_bound()
Queries whether a TCP connection has been established to the implementation object.
o _is_equivalent(Object)
Queries an object to see if it equivalent to another object.
o _is_local()
Queries whether an object reference refers to a object implemented in the local address space.
o _is_persistent()
Queries whether an object reference is valid beyond the lifetime of the process implementing the object.
o _is_remote()
Queries whether an object reference refers to a object implemented in a remote address space.
o _non_existent()
Attempts to "ping" the implementation object.
o _object_name()
Gets the name of the object implementation.
o _orb()
Gets the Object Request Borker associated with the object.
o _principal()
Set or get the principal associated with the object.
o _principal(Principal)
Set or get the principal associated with the object.
o _release()
This operation is provided for future extensions.
o _repository_id()
Gets the repository identifier of the most derived interface of the object implementation.
o _request(String)
Create an empty dynamic invocation request.
o _resolve_reference(String)
Get the reference to a ORBManager::Server object from within the object

Operation: ::CORBA::Object::_resolve_reference.

Methods

o _is_a 
 public abstract boolean _is_a(String repId)
Queries an object to see if it implements the specified interface. Note that this query may result in a call to the implementation object, since it is possible for a given server to simultaneously implement multiple interfaces via multiple inheritance. For example given the following IDL: 
module M {
interface A {
void opA();
};
interface B {
void opB();
};
interface C : A, B {
};
};
Given an interface I in module M, (i.e., M::I) the corresponding repository identifier will generally be "IDL:M/I:1.0" (omitting the quotation marks). However, the repository identifier can be set to an arbitrary string by using #pragmas in the IDL file.

Operation: ::CORBA::Object::_is_a. 

boolean _is_a(
in ::CORBA::RepositoryId repId
);

Parameters:
repId - A repository identifier.
Returns:
true if the implementation object supports the interface, false otherwise.
o _is_equivalent 
 public abstract boolean _is_equivalent(Object other_object)
Queries an object to see if it equivalent to another object. Note that this is not the same as comparing pointers, since the two object references may be locally distinct.

Operation: ::CORBA::Object::_is_equivalent. 

boolean _is_equivalent(
in ::CORBA::Object other_object
);

Parameters:
other_object - An object reference.
Returns:
true if the two object references refer to the same implementation object, false otherwise.
o _non_existent 
 public abstract boolean _non_existent()
Attempts to "ping" the implementation object. This method will not cause a proxy to be rebound to another server (i.e., it does force a bind, but it does not force a rebind).

Operation: ::CORBA::Object::_non_existent. 

boolean _non_existent();

Returns:
false if the implementation object is currently active (possibly after causing the server to be activated), true otherwise.
o _hash 
 public abstract int _hash(int maximum)
Compute a hash value for the object in the range [0..maximum). The value is always positive. return The hash value.

Operation: ::CORBA::Object::_hash. 

unsigned long _hash(
in unsigned long maximum
);

o _duplicate 
 public abstract Object _duplicate()
This operation is provided for future extensions.

Operation: ::CORBA::Object::_duplicate. 

::CORBA::Object _duplicate();

o _release 
 public abstract void _release()
This operation is provided for future extensions.

Operation: ::CORBA::Object::_release. 

void _release();

o _request 
 public abstract Request _request(String operation)
Create an empty dynamic invocation request. For in and inout parameters, the values must be filled in. For out parameters and return values, the types must be filled in.

Operation: ::CORBA::Object::_request. 

::CORBA::Request _request(
in ::CORBA::Identifier operation
);

Parameters:
operation - The name of the operation to invoke.
Returns:
An empty request.
o _create_request 
 public abstract Request _create_request(Context ctx,
                                         String operation,
                                         NVList arg_list,
                                         NamedValue result)
Create a filled dynamic invocation request. The exception list and context list are empty.

Operation: ::CORBA::Object::_create_request. 

::CORBA::Request _create_request(
in ::CORBA::Context ctx,
in ::CORBA::Identifier operation,
in ::CORBA::NVList arg_list,
in ::CORBA::NamedValue result
);

See Also:
o _create_request 
 public abstract Request _create_request(Context ctx,
                                         String operation,
                                         NVList arg_list,
                                         NamedValue result,
                                         ExceptionList exceptions,
                                         ContextList contexts)
Create a filled dynamic invocation request.

Operation: ::CORBA::Object::_create_request. 

::CORBA::Request _create_request(
in ::CORBA::Context ctx,
in ::CORBA::Identifier operation,
in ::CORBA::NVList arg_list,
in ::CORBA::NamedValue result,
in ::CORBA::ExceptionList exceptions,
in ::CORBA::ContextList contexts
);

Parameters:
ctx - The context for the invocation. A default context can be obtained from the ORB.
operation - The name of the operation to invoke.
arg_list - A list of NamedValues, one for each argument to the operation. For in and inout parameters, the values must be filled in. For out parameters the types must be filled in.
result - The type of the result (return value) must be specified.
exceptions - The list of user exceptions' type codes must be specified (may be an empty list).
contexts - The list of contexts must be specified (may be an empty list).
Returns:
The filled dynamic invocation request.
See Also:
get_default_context
o _get_interface 
 public abstract InterfaceDef _get_interface()
Returns the interface definition of the object. This method requires an interface repository.

Operation: ::CORBA::Object::_get_interface. 

::CORBA::InterfaceDef _get_interface();

o _get_implementation 
 public abstract ImplementationDef _get_implementation()
Returns the implementation definition of the object. This method requires an interface repository.

Operation: ::CORBA::Object::_get_implementation. 

::CORBA::ImplementationDef _get_implementation();

o _orb 
 public abstract ORB _orb()
Gets the Object Request Borker associated with the object.

Operation: ::CORBA::Object::_orb. 

::CORBA::ORB _orb();

Throws: INITIALIZE
If the ORB has not been initialized.
See Also:
init
o _boa 
 public abstract BOA _boa()
Gets the Basic Object Adapter assocaited with the object.

Operation: ::CORBA::Object::_boa. 

::CORBA::BOA _boa();

Throws: INITIALIZE
If the BOA has not been initialized.
See Also:
BOA_init
o _object_name 
 public abstract String _object_name()
Gets the name of the object implementation. Returns null if the object is not-named (i.e., it is a transient object or a foreign object).

Operation: ::CORBA::Object::_object_name. 

::CORBA::Identifier _object_name();

Returns:
The object's name.
o _repository_id 
 public abstract String _repository_id()
Gets the repository identifier of the most derived interface of the object implementation.

Operation: ::CORBA::Object::_repository_id. 

::CORBA::RepositoryId _repository_id();

Returns:
The object's repository identifier.
o _is_local 
 public abstract boolean _is_local()
Queries whether an object reference refers to a object implemented in the local address space.

Operation: ::CORBA::Object::_is_local. 

boolean _is_local();

Returns:
true if the implementation object is local false otherwise.
o _is_remote 
 public abstract boolean _is_remote()
Queries whether an object reference refers to a object implemented in a remote address space.

Operation: ::CORBA::Object::_is_remote. 

boolean _is_remote();

Returns:
true if the implementation object is remote false otherwise.
o _is_bound 
 public abstract boolean _is_bound()
Queries whether a TCP connection has been established to the implementation object.

Operation: ::CORBA::Object::_is_bound. 

boolean _is_bound();

Returns:
true if a TCP connect exists (or the implementation is local) false otherwise.
o _is_persistent 
 public abstract boolean _is_persistent()
Queries whether an object reference is valid beyond the lifetime of the process implementing the object.

Operation: ::CORBA::Object::_is_persistent. 

boolean _is_persistent();

Returns:
true if the object reference is persistent, false otherwise.
o _principal 
 public abstract void _principal(Principal _principal)
Set or get the principal associated with the object. A principal can either be associated with a proxy object, or with the target of an active invocation. Attempting to obtain the principal of an implementation while not in an invocation will result in a null.

Writer for attribute: ::CORBA::Object::_principal. 

attribute ::CORBA::Principal _principal;

Returns:
a principal if valid, null otherwise. Note that the principal is stored by reference, so care must be taken in modifying the value.
See Also:
get_principal, default_principal
o _principal 
 public abstract Principal _principal()
Set or get the principal associated with the object. A principal can either be associated with a proxy object, or with the target of an active invocation. Attempting to obtain the principal of an implementation while not in an invocation will result in a null.

Reader for attribute: ::CORBA::Object::_principal. 

attribute ::CORBA::Principal _principal;

Returns:
a principal if valid, null otherwise. Note that the principal is stored by reference, so care must be taken in modifying the value.
See Also:
get_principal, default_principal
o _bind_options 
 public abstract void _bind_options(BindOptions _bind_options)
Set or get the bind options associated with the object. Bind options can only be set on a proxy object (i.e., not on an implementation).

Writer for attribute: ::CORBA::Object::_bind_options. 

attribute ::CORBA::BindOptions _bind_options;

Returns:
the bind options, if they have been set, null otherwise. Note that the bind options are stored by reference, so care must be taken in modifying the value.
o _bind_options 
 public abstract BindOptions _bind_options()
Set or get the bind options associated with the object. Bind options can only be set on a proxy object (i.e., not on an implementation).

Reader for attribute: ::CORBA::Object::_bind_options. 

attribute ::CORBA::BindOptions _bind_options;

Returns:
the bind options, if they have been set, null otherwise. Note that the bind options are stored by reference, so care must be taken in modifying the value.
o _clone 
 public abstract Object _clone()
Creates a copy of the object reference, which has its own TCP connection to the server. If the implentation is local, this operation simply returns the this pointer of the implementation object.

Operation: ::CORBA::Object::_clone. 

::CORBA::Object _clone();

Returns:
A new object reference.
o _resolve_reference 
 public abstract Object _resolve_reference(String id)
Get the reference to a ORBManager::Server object from within the object

Operation: ::CORBA::Object::_resolve_reference. 

::CORBA::Object _resolve_reference(
in string id
);


All Packages  Class Hierarchy  This Package  Previous  Next  Index