VisiBroker for Java

Package org.omg.CORBA

This package contains the OMG defined interfaces and classes for CORBA.

See:
          Description

Interface Summary
AbstractInterfaceDef The AbstractInterfaceDef is similar to the InterfaceDef interface, except that abstract interfaces can only inherit from abstract interfaces; they cannot use concrete interfaces as a base.
AbstractInterfaceDefOperations The AbstractInterfaceDef is similar to the InterfaceDef interface, except that abstract interfaces can only inherit from abstract interfaces; they cannot use concrete interfaces as a base.
AliasDef This interface is used to represent a typedef that is stored in the Interface Repository.
AliasDefOperations This interface is used to represent a typedef that is stored in the Interface Repository.
ARG_IN Signifies an "input" argument to an invocation, meaning that the argument is being passed from the client to the server.
ARG_INOUT Signifies an argument used for both input and output in an invocation, meaning that the argument is being passed from the client to the server and then back from the server to the client.
ARG_OUT A constant that signifies an "output" argument to an invocation, meaning that the argument is being passed from the server to the client.
ArrayDef Represents an array that is stored in the Interface Repository.
ArrayDefOperations Represents an array that is stored in the Interface Repository.
AttributeDef This interface is used to represent an interface attribute that is stored in the Interface Repository.
AttributeDefOperations This interface is used to represent an interface attribute that is stored in the Interface Repository.
BAD_POLICY Minor code for PolicyError exception - the requested Policy was not understood by the ORB.
BAD_POLICY_TYPE Minor code for PolicyError exception - type of the value requested for the Policy is not valid for that PolicyType.
BAD_POLICY_VALUE Minor code for PolicyError exception - value requested for the Policy is of a valid type but is not within the valid range for that type.
ConstantDef Represents a constant definition that is stored in the interface repository.
ConstantDefOperations Represents a constant definition that is stored in the interface repository.
Contained Represents Interface Repository objects that are, themselves, contained within another Interface Repository object.
ContainedOperations Represents Interface Repository objects that are, themselves, contained within another Interface Repository object.
Container The Container interface is used to create a containment hierarchy in the Interface Repository.
ContainerOperations The Container interface is used to create a containment hierarchy in the Interface Repository.
CTX_RESTRICT_SCOPE A flag that can be used as the second parameter to the method Context.get_values to restrict the search scope.
Current ORB and CORBA services may wish to provide access to information (context) associated with the thread of execution in which they are running.
CurrentOperations ORB and CORBA services may wish to provide access to information (context) associated with the thread of execution in which they are running.
CustomMarshal An abstract value type that is meant to be used by the ORB.
DataInputStream Provides methods to read primitive data types from input stream when unmarshaling customer value types.
DataOutputStream Provides methods to write primitive data types to the output stream when marshaling customer value types.
DomainManager Provides mechanisms for establishing and navigating relationships to superior and subordinate domains and creating and accessing policies.
DomainManagerOperations Provides mechanisms for establishing and navigating relationships to superior and subordinate domains and creating and accessing policies.
DynAny Deprecated. Use the new DynAny instead
DynArray Deprecated. Use the new DynArray instead
DynEnum Deprecated. Use the new DynEnum instead
DynFixed Deprecated. Use the new DynFixed instead
DynSequence Deprecated. Use the new DynSequence instead
DynStruct Deprecated. Use the new DynStruct instead
DynUnion Deprecated. Use the new DynUnion instead
DynValue Deprecated. Use the new DynValue instead
EnumDef Represents an enumeration that is stored in the Interface Repository.
EnumDefOperations Represents an enumeration that is stored in the Interface Repository.
ExceptionDef Represents an exception that is stored in the Interface Repository.
ExceptionDefOperations Represents an exception that is stored in the Interface Repository.
FixedDef This interface is used to represent a fixed data type definition that is stored in the Interface Repository.
FixedDefOperations This interface is used to represent a fixed data type definition that is stored in the Interface Repository.
IDLType The IDLType interface is defined as a marker interface used to mark those Repository Objects that form IDL types.
IDLTypeOperations The IDLType interface is defined as a marker interface used to mark those Repository Objects that form IDL types.
InterfaceDef Represents the concrete interface that is stored in the Interface Repository.
InterfaceDefOperations Represents the concrete interface that is stored in the Interface Repository.
IRObject The IRObject interface offers a generic interface to any object stored in the Interface Repository.
IRObjectOperations The IRObject interface offers a generic interface to any object stored in the Interface Repository.
LocalInterface Extends the org.omg.CORBA.Object interface to represent a locality constrained interface.
LocalInterfaceDef This interface is used to represent an IDL module for the local interface.
LocalInterfaceDefOperations This interface is used to represent an IDL module for the local interface.
ModuleDef Represents an IDL module in the interface repository.
ModuleDefOperations Represents an IDL module in the interface repository.
NativeDef This interface is used to represent a native definition that is stored in the Interface Repository.
NativeDefOperations This interface is used to represent a native definition that is stored in the Interface Repository.
Object The definition for a CORBA object reference.
OMGVMCID Defines the vendor minor code id assigned to OMG
OperationDef Represents an interface operation that is stored in the Interface Repository.
OperationDefOperations Represents an interface operation that is stored in the Interface Repository.
Policy Using this interface, an ORB or CORBA service may choose to allow access to certain choices that affect its operation.
PolicyCurrent The PolicyCurrent interface derives from PolicyManager and Current without adding new methods.
PolicyCurrentOperations The PolicyCurrent interface derives from PolicyManager and Current without adding new methods.
PolicyManager The PolicyManager interface is used to access policy overrides at the VisiBroker ORB level.
PolicyManagerOperations The PolicyManager interface is used to access policy overrides at the VisiBroker ORB level.
PolicyOperations Using this interface, an ORB or CORBA service may choose to allow access to certain choices that affect its operation.
PrimitiveDef Represents a primitive type (such as an int or a long) that is stored in the Interface Repository.
PrimitiveDefOperations Represents a primitive type (such as an int or a long) that is stored in the Interface Repository.
PRIVATE_MEMBER Indicates a Private value member.
PUBLIC_MEMBER Indicates a Public value member.
Repository The Repository provides an interface to the Interface Repository itself, which is used to contain the definitions of objects that are available to clients.
RepositoryOperations The Repository provides an interface to the Interface Repository itself, which is used to contain the definitions of objects that are available to clients.
SequenceDef Represents an sequence that is stored in the Interface Repository.
SequenceDefOperations Represents an sequence that is stored in the Interface Repository.
StringDef Represents a String that is stored in the Interface Repository.
StringDefOperations Represents a String that is stored in the Interface Repository.
StructDef Represents a structure that is stored in the Interface Repository.
StructDefOperations Represents a structure that is stored in the Interface Repository.
TypedefDef This abstract interface represents a user-defined structure that is stored in the Interface Repository.
TypedefDefOperations This abstract interface represents a user-defined structure that is stored in the Interface Repository.
UnionDef Represents a Union that is stored in the Interface Repository.
UnionDefOperations Represents a Union that is stored in the Interface Repository.
UNSUPPORTED_POLICY Minor code for PolicyError exception - the requested Policy is understood to be valid by the ORB, but is not currently supported.
UNSUPPORTED_POLICY_VALUE Minor code for PolicyError exception - value requested for the Policy is of a valid type and within the valid range for that type, but this valid value is not currently supported.
ValueBoxDef This interface is used as a simple value type that contains a single public member of any IDL type.
ValueBoxDefOperations This interface is used as a simple value type that contains a single public member of any IDL type.
ValueDef This interface represents a value definition that is stored in the Interface Repository.
ValueDefOperations This interface represents a value definition that is stored in the Interface Repository.
ValueMemberDef Represents a value member definition that is stored in the Interface Repository.
ValueMemberDefOperations Represents a value member definition that is stored in the Interface Repository.
VM_ABSTRACT  
VM_CUSTOM  
VM_NONE  
VM_TRUNCATABLE  
WstringDef Represents a Unicode string that is stored in the Interface Repository.
WstringDefOperations Represents a Unicode string that is stored in the Interface Repository.
 

Class Summary
_IDLTypeStub The Stub for IDLType.
_PolicyStub The Stub for Policy.
Any Serves as a container for any data that can be described in IDL or for any IDL primitive type.
AnyHolder The Holder for Any.
AnySeqHelper The Helper for AnySeq.
AnySeqHolder The Holder for AnySeq.
AttributeDescription The AttributeDescription describes an attribute that is stored in the interface repository.
AttributeMode Defines modes for IDL attributes.
BooleanHolder The Holder for Boolean.
BooleanSeqHelper The Helper for BooleanSeq.
BooleanSeqHolder The Holder for BooleanSeq.
ByteHolder The Holder for Byte.
CharHolder The Holder for Char.
CharSeqHelper The Helper for CharSeq.
CharSeqHolder The Holder for CharSeq.
CompletionStatus Carried inside a standard system exception and indicates whether an invocation succeeded or not.
CompletionStatusHelper The Helper for CompletionStatus.
ConstantDescription The ConstantDescription describes a constant that is stored in the interface repository.
Context An object used in Request operations to specify the context object in which context strings must be resolved before being sent along with the request invocation.
ContextList An object containing a modifiable list of String objects that represent property names.
CurrentHelper The Helper for Current.
CurrentHolder The Holder for Current.
DefinitionKind The class that provides the constants used to identify the type of an Interface Repository object.
DefinitionKindHelper The Helper for DefinitionKind.
DoubleHolder The Holder for Double.
DoubleSeqHelper The Helper for DoubleSeq.
DoubleSeqHolder The Holder for DoubleSeq.
DynamicImplementation Deprecated. org.omg.CORBA.DynamicImplementation
Environment A container (holder) for an exception that is used in Request operations to make exceptions available to the client.
ExceptionDescription The ExceptionDescription class describes an exception that is stored in the interface repository.
ExceptionList An object used in Request operations to describe the exceptions that can be thrown by a method.
FieldNameHelper The Helper for FieldName.
FixedHolder The Holder for Fixed.
FloatHolder The Holder for Float.
FloatSeqHelper The Helper for FloatSeq.
FloatSeqHolder The Holder for FloatSeq.
IdentifierHelper The Helper for Identifier.
IDLTypeHelper The Helper for IDLType.
Initializer  
InterfaceDescription The InterfaceDescription class provides a description of the interface that is stored in the interface repository
IntHolder The Holder for Int.
LocalObject Provides a base class for the implementation of IDL local interfaces.
LongHolder The Holder for Long.
LongLongSeqHelper The Helper for LongLongSeq.
LongLongSeqHolder The Holder for LongLongSeq.
LongSeqHelper The Helper for LongSeqHelper.
LongSeqHolder The Holder for LongSeq.
ModuleDescription The ModuleDescription class describes a module that is stored in the interface repository.
NamedValue An object used in the DII and DSI to describe arguments and return values.
NameValuePair Provides an association between a name and its value stored in a CORBA::Any
NameValuePairHelper The Helper for NameValuePair.
NVList A modifiable list containing NamedValue objects.
ObjectHelper  
ObjectHolder The Holder for Object.
OctetSeqHelper The Helper for OctetSeq.
OctetSeqHolder The Holder for OctetSeq.
OperationDescription The OperationDescription class is stored in the interface repository.
OperationMode This class enumerates the modes of operation.
ORB A class providing APIs for the CORBA Object Request Broker features.
ParameterDescription The ParameterDescription class describes a parameter for an operation that is stored in the interface repository.
ParameterMode This class enumerates the three modes of parameters:
ParameterModeHelper Enumeration of parameter modes for Parameter.
ParameterModeHolder Enumeration of parameter modes for Parameter.
PolicyErrorCodeHelper Encapsulates a reason a Policy may be invalid.
PolicyErrorHelper Thrown to indicate problems with parameter values passed to the ORB.create_policy operation.
PolicyErrorHolder Thrown to indicate problems with parameter values passed to the ORB.create_policy operation.
PolicyHelper The Helper for Policy.
PolicyHolder The Holder for Policy.
PolicyListHelper The Helper for PolicyList.
PolicyListHolder The Holder for PolicyList.
PolicyTypeHelper The Helper for PolicyType.
PrimitiveKind The PrimitiveKind class enumerates the primitive types present in the IDL.
Principal Deprecated. Deprecated by CORBA 2.2.
PrincipalHolder Deprecated. Deprecated by CORBA 2.2.
RepositoryIdHelper The Helper for RepositoryId.
Request An object containing the information necessary for invoking a method.
ServerRequest An object that captures the explicit state of a request for the Dynamic Skeleton Interface (DSI).
ServiceDetail  
ServiceDetailHelper  
ServiceInformation  
ServiceInformationHelper  
ServiceInformationHolder The Holder for ServiceInformation.
SetOverrideType Specifies the override type for policies.
SetOverrideTypeHelper The Helper for SetOverrideType.
ShortHolder The Holder for Short.
ShortSeqHelper The Helper for ShortSeqHelper.
ShortSeqHolder The Holder for ShortSeq.
StringHolder The Holder for String.
StringSeqHelper An array of Strings
StringSeqHolder An array of Strings
StringValueHelper The Helper for StringValue.
StructMember This interface is used to define each field of a struct.
StructMemberHelper The Helper for StructMember.
TCKind The Java mapping of the IDL enum TCKind, which specifies the kind of a TypeCode object.
TypeCode A container for information about a specific CORBA data type.
TypeCodeHolder The Holder for TypeCode.
TypeDescription The TypeDescription class is stored in the interface repository.
ULongLongSeqHelper The Helper for ULongLongSeq.
ULongLongSeqHolder The Holder for ULongLongSeq.
ULongSeqHelper The Helper for ULongSeq.
ULongSeqHolder The Holder for ULongSeq.
UnionMember The UnionMember class describes a member of the union that is stored in the interface repository.
UnionMemberHelper The Helper for UnionMember.
UnknownUserExceptionHelper The Helper for UnknownUserException.
UnknownUserExceptionHolder The Holder for UnknownUserException.
UShortSeqHelper The Helper for UShortSeq.
UShortSeqHolder The Holder for UShortSeq.
ValueBaseHelper  
ValueBaseHolder The Holder for ValueBase.
ValueDescription This interface is used to represent a description of the value type that is stored in the Interface Repository.
ValueMember Contians information about a Value member.
ValueMemberHelper The Helper for ValueMember.
VersionSpecHelper The Helper for VersionSpec.
VisibilityHelper The Helper for Visibility.
WCharSeqHelper The Helper for WCharSeq.
WCharSeqHolder The Holder for WCharSeq.
WrongTransactionHelper The Helper for WrongTransaction.
WrongTransactionHolder The Holder for WrongTransaction.
WStringSeqHelper An array of WStrings
WStringSeqHolder An array of WStrings
WStringValueHelper org/omg/CORBA/WStringValueHelper.java Generated by the IDL-to-Java compiler (portable), version "3.0" from orb.idl 31 May 1999 22:27:30 o'clock GMT+00:00 The class definition has been modified to conform to the following OMG specifications : ORB core as defined by CORBA 2.3.1 (formal/99-10-07) IDL/Java Language Mapping as defined in ptc/00-01-08
 

Exception Summary
ACTIVITY_COMPLETED The ACTIVITY_COMPLETED system exception may be raised on any method for which Activity context is accessed.
ACTIVITY_REQUIRED The ACTIVITY_REQUIRED system exception may be raised on any method for which an Activity context is required.
BAD_CONTEXT Exception thrown when an operation is invoked by a client but the passed context does not contain the context values required by the operation.
BAD_INV_ORDER This exception indicates that the caller has invoked operations in the wrong order.
BAD_OPERATION Exception thrown when an object reference denotes an existing object, but that the object does not support the operation that was invoked.
BAD_PARAM Exception thrown when a parameter passed to a call is out of range or otherwise considered illegal.
BAD_QOS System exceptions are thrown by the runtime when certain error cases occur.
BAD_TYPECODE Exception thrown when the ORB has encountered a malformed type code (for example, a type code with an invalid TCKind value).
Bounds A user exception thrown when a parameter is not within the legal bounds for the object that a method is trying to access.
CODESET_INCOMPATIBLE System exceptions are thrown by the runtime when certain error cases occur.
COMM_FAILURE This exception is raised if communication is lost while an operation is in progress, after the request was sent by the client, but before the reply from the server has been returned to the client.
DATA_CONVERSION This exception is raised if an ORB cannot convert the representation of data as marshaled into its native representation or vice-versa.
FREE_MEM Exception thrown when the ORB failed in an attempt to free dynamic memory, for example because of heap corruption or memory segments being locked.
IMP_LIMIT This exception indicates that an implementation limit was exceeded in the ORB run time.
INITIALIZE Exception thrown when an ORB has encountered a failure during its initialization, such as failure to acquire networking resources or detecting a configuration error.
INTERNAL This exception indicates an internal failure in an ORB, for example, if an ORB has detected corruption of its internal data structures.
INTF_REPOS Exception raised when an ORB cannot reach the interface repository, or some other failure relating to the interface repository is detected.
INV_FLAG Exception thrown when an invalid flag was passed to an operation (for example, when creating a DII request).
INV_IDENT This exception indicates that an IDL identifier is syntactically invalid.
INV_OBJREF This exception indicates that an object reference is internally malformed.
INV_POLICY Standard exception thrown when an invocation cannot be made because of an incompatibility between Policy overrides that apply to the particular invocation.
INVALID_ACTIVITY The INVALID_ACTIVITY system exception may be raised on the Activity or Transaction services' resume methods if a transaction or Activity is resumed in a context different to that from which it was suspended.
INVALID_TRANSACTION Exception thrown when the request carried an invalid transaction context.
InvalidPolicies Raised by PolicyManager::set_policy_overrides method.
MARSHAL A request or reply from the network is structurally invalid.
NO_IMPLEMENT This exception indicates that even though the operation that was invoked exists (it has an IDL definition), no implementation for that operation exists.
NO_MEMORY Exception thrown when the ORB run time has run out of memory.
NO_PERMISSION Exception thrown when an invocation failed because the caller has insufficient privileges.
NO_RESOURCES Exception thrown when the ORB has encountered some general resource limitation.
NO_RESPONSE This exception is raised if a client attempts to retrieve the result of a deferred synchronous call, but the response for the request is not yet available.
OBJ_ADAPTER This exception typically indicates an administrative mismatch, for example, a server may have made an attempt to register itself with an implementation repository under a name that is already in use, or is unknown to the repository.
OBJECT_NOT_EXIST Exception raised whenever an invocation on a deleted object was performed.
PERSIST_STORE This exception indicates a persistent storage failure, for example, failure to establish a database connection or corruption of a database.
PolicyError Indicates problems with parameter values passed to the ORB::create_policy operation.
REBIND  
SystemException The root class for all CORBA standard exceptions.
TIMEOUT  
TRANSACTION_MODE System exceptions are thrown by the runtime when certain error cases occur.
TRANSACTION_REQUIRED Exception indicates that the request carried a null transaction context, but an active transaction is required.
TRANSACTION_ROLLEDBACK Exception thrown when the transaction associated with the request has already been rolled back or marked to roll back.
TRANSACTION_UNAVAILABLE System exceptions are thrown by the runtime when certain error cases occur.
TRANSIENT Exception thrown when the ORB attempted to reach an object and failed.
UNKNOWN This exception is raised if an operation implementation throws a non-CORBA exception (such as an exception specific to the implementation's programming language), or if an operation raises a user exception that does not appear in the operation's raises expression.
UnknownUserException A class that contains user exceptions returned by the server.
UserException The root class for CORBA IDL-defined user exceptions.
WrongTransaction Raised when the deferred synchronous model is used.
 

Package org.omg.CORBA Description

This package contains the OMG defined interfaces and classes for CORBA. Also includes classes such as the ORB and the Object interface. A complete description of these interfaces and classes can be found in the CORBA Specification.

General Information

ORB class

Please refer to ORB

Exception Classes

CORBA system exceptions are a subclass of java.lang.RuntimeException. This means that CORBA system exceptions do not need to be declared in all method signatures which might raise such exceptions.

The UserException is a subclass of java.lang.Exception.

Note: Due to the changes in the inheritance hierarchy, the class org.omg.CORBA.Exception no longer exists.

SystemException

public class SystemException extends java.lang.RuntimeException

CORBA system exceptions are raised when the runtime encounters problems. They inherit from java.lang.RuntimeException. The table below summarizes all the SystemException classes that can be raised and their associated meanings.

The standard IDL system exceptions are mapped to final Java classes that extend org.omg.CORBA.SystemException and provide access to the IDL major and minor exception code, as well as a string describing the reason for the exception.

Note: There are no public constructors for org.omg.CORBA.SystemException; only classes that extend it can be instantiated.

Currently, Borland VisiBroker does not support the use of minor codes; consequently, there is no minor method to set the minor code.

SystemException attributes

public CompletionStatus completed

This attribute indicates whether the operation was completed or not.

List of system exceptions
 

Exception class name Description
BAD_CONTEXT  Error processing context object. 
BAD_INV_ORDER  Routine invocations out of order. 
BAD_OPERATION  Invalid operation. 
BAD_PARAM  An invalid parameter was passed. 
BAD_TYPECODE  Invalid typecode. 
COMM_FAILURE  Communication failure. 
DATA_CONVERSION  Data conversion error. 
FREE_MEM  Unable to free memory. 
INDIRECTION EXCEPTION  Mismatch in typecode indirection when reading or writing. 
IMP_LIMIT  Implementation limit violated. 
INITIALIZE  ORB initialization failure. 
INTERNAL  ORB internal error. 
INTF_REPOS  Error accessing interface repository. 
INV_FLAG  Invalid flag was specified. 
INV_IDENT  Invalid identifier syntax. 
INV_OBJREF  Invalid object reference specified. 
INV_POLICY  Invalid policy for invocation. 
INVALID_TRANSACTION  Invalid transaction context encountered. 
MARSHAL  Error marshalling parameter or result. 
NO_IMPLEMENT  Operation implementation not available. 
NO_MEMORY  Dynamic memory allocation failure. 
NO_PERMISSION  No permission for attempted operation. 
NO_RESOURCES  Insufficient resources to process request. 
NO_RESPONSE  Response to request not yet available. 
OBJ_ADAPTER  Failure detected by object adaptor. 
OBJECT_NOT_EXIST  Object is not available. 
PERSIST_STORE  Persistent storage failure. 
REBIND  IOR conflicts with the QoS policies that were set. 
TRANSACTION REQUIRED  Non-null transaction context required. 
TRANSACTION_ROLLEDBACK  Transaction has been rolled back. 
TRANSIENT  Transient failure. 
UNKNOWN  A Java exception of type java.lang.Exception is thrown. 

UserException

public class UserException extends java.lang.Exception

The UserException class is an abstract base class used to define exceptions that an object implementation may raise. There is no state information associated with these exception types, but derived classes may add their own state information. The primary use of this class is to simplify the use of catch blocks in a client's code.

Generated interfaces and classes

The Helper and Holder classes are provided for most the classes in the org.omg.CORBA package. They are also generated by the idl2java compiler for user-defined types and are given the name of the class that is generated for the type with an additional Holder or Helper suffix. Given a user-defined type named MyType, the idl2java compiler generates the following:

Signature and operations classes

These two classes, MyType and MyTypeOperations, provide the complete signature of your IDL interface when mapped to Java.

Signature class

This class defines the signature interface for each interface you declare in your IDL file.

Operations class

This class defines all of the methods that must be implemented by the object implementation. This class acts as the delegate object for the associated tie class when the tie mechanism is used.

Ancillary classes

For each user-defined type a Helper and a Holder class are generated.

Helper class

An abstract Helper class is generated by the idl2java compiler and contains the utility methods for operating on the associated object. The reason for using the Helper class is to avoid loading the methods that the class offers if they are not needed.

For objects like mapped structures, enumerations, unions, exceptions, valuetypes, and valueboxes, the Helper class provides methods for reading and writing the object to a stream and returning the object's repository identifier. The Helper classes generated for interfaces contain additional methods, like bind and narrow.

Holder class

Since the Java language only allows parameters to be passed by value and not by reference, Holder classes are used to support the passing of out and inout parameters associated with operation requests. The interface of the Holder class is consistent for all types.

Portability stub and skeleton interfaces

The IDL to Java language mapping defines a stub class that may be used for both the local and the remote invocation of objects. Skeleton classes can be either stream-based or DSI-based.

Note: Stub and skeleton classes are not generated for local interfaces.

Stub class

The stub class provides stub implementation for <interface_name> which the client calls. All stubs inherit from org.omg.CORBA.portable.ObjectImpl.

POA class

Stream-based skeletons extend org.omg.PortableServer.Servant and DSI-based skeletons extend org.omg.PortableServer.DynamicImplementation. This abstract class provides the interface to the server-side implementation of your class.

POATie class

The POATie class extends the <interface>POA class and allows you to delegate calls to any of the <interface>Operations methods to another object which implements the same methods. You do not have to use the POATie class if you do not want, but instead you may have your <interface>Impl class directly extend the <interface>POA abstract class.

<interface_name>Operations

abstract public interface <interface_name>Operations

An Operations class is generated by the idl2java compiler and contains the interface definitions of the methods and constants declared for <interface_name> in the IDL file.

<type_name>Helper

abstract public class <type_name>Helper

A Helper class is provided for most classes in the org.omg.CORBA package. Helper classes are also generated by the idl2java compiler for all user-defined types. The suffix Helper is added to the class name that is generated for the type. A variety of static methods are provided to manipulate the class.

Methods for all Helper classes

public static <interface_name> extract(org.omg.CORBA.Any any)

This method extracts the type from the specified Any object.
 

Parameter Description
any  The Any object to contain the object. 

public static String id()

This method gets the repository id for this object.

public static void insert(org.omg.CORBA.Any any, <type_name> value)

This method insert a type into the specified Any object.
 

Parameter Description
any  The Any object to contain the type. 
value  The type to insert. 

public static <type_name> read(org.omg.CORBA.portable.InputStream input)

This method reads a type from the specified input stream.
 

Parameter Description
input  The input stream from which the object is read. 

public static org.omg.CORBA.TypeCode type()

This method returns the TypeCode associated with this object. For a list of possible return values see "TCKind."

public static void write(org.omg.CORBA.portable.OutputStream output, <type_name> value)

This method writes a type to the specified output stream.
 

Parameter Description
output  The output stream to which the object is written. 
value  The type to be written to the output stream. 

Methods generated for interfaces

public static <interface_name> bind(org.omg.CORBA.ORB orb)

This method attempts to bind to any instance of an object of type <interface_name>.

public static <interface_name> bind(org.omg.CORBA.ORB orb, java.lang.String name)

This method attempts to bind to an object of type <interface_name> that has the specified instance name.
 

Parameter Description
name  The instance name of the desired object. 

public static <interface_name> bind(org.omg.CORBA.ORB orb, java.lang.String name, java.lang.String host, com.inprise.vbroker.CORBA.BindOptions _options)

This method attempts to bind to an object of type <interface_name> that has the specified instance name and which is located on the specified host, using the specified BindOptions.

Note: BindOptions is deprecated.
 

Parameter Description
name  The instance name of the desired object. 
host  The optional host name where the desired object is located. 
options  The bind options for this object. (pass a null value as BindOptions is deprecated)

public static <interface_name> bind(org.omg.CORBA.ORB orb, java.lang.String fullPoaName, byte[] oid)

This method attempts to bind to an object of type <interface_name> that was created by the specified POA with the specified object id.
 

Parameter Description
fullPoaName The full name of the POA.
oid The object id of the instance.

public static <interface_name> bind(org.omg.CORBA.ORB orb, java.lang.String fullPoaName, byte[] oid, java.lang.String host, com.inprise.vbroker.CORBA.BindOptions _options)

This method attempts to bind to an object of type <interface_name> that was created by the specified POA with the specified object id and which is located on the specified host, using the specified BindOptions.

Note: BindOptions is deprecated.
 

Parameter Description
fullPoaName The full name of the POA.
oid The object id of the instance.
host The optional host name where the desired object is located.
options The bind options for this object (pass a null value as BindOptions is deprecated)

public static <interface_name> narrow(org.omg.CORBA.Object object)

This method attempts to narrow a org.omg.CORBA.Object reference to an object of type <interface_name>. If the object reference cannot be narrowed, a null value is returned.
 

Parameter Description
object The object to be narrowed to the type <interface_name>.

Methods generated for object wrappers

The following methods are generated for helper classes when you invoke the idl2java command with the -obj_wrapper option. For more information about the -obj_wrapper option, refer to the Object Wrappers section of the VisiBroker Developer's Guide.

public static void addClientObjectWrapperClass(org.omg.CORBA.ORB orb, java.lang.Class c)

Adds a typed object wrapper from a client application. If more than one typed object wrapper is installed, they are added in the order in which they were registered.

Note: This method should only be invoked by a client application.
 

Parameter Description
The object wrapper that you want to add. 
orb  The VisiBroker ORB the client wishes to use, obtained by the invoking the ORB.init method. Currently, this method does not use the orb parameter. 

public static void addServerObjectWrapperClass(org.omg.CORBA.ORB orb, java.lang.Class c)

Adds a typed object wrapper from a server application. If more than one typed object wrapper is installed, they are added in the order in which they were registered.

Note: This method should only be invoked by a server application.
 

Parameter Description
The object wrapper that you want to add. 
orb  The VisiBroker ORB the server wishes to use, obtained by the invoking the ORB.init method. Currently, this method does not use the orb parameter. 

public static void removeClientObjectWrapperClass(org.omg.CORBA.ORB orb, java.lang.Class c)

Removes a typed object wrapper from a client application.

Note: This method should only be invoked by a client application.
 

Parameter Description
The object wrapper that you want to remove. 
orb  The VisiBroker ORB the client wishes to use, obtained by the invoking the ORB.init method. 

public static void removeServerObjectWrapperClass(org.omg.CORBA.ORB orb, java.lang.Class c)

Removes a typed object wrapper from a server application.

Note: This method should only be invoked by a server application.
 

Parameter Description
The object wrapper class that you want to remove. 
orb  The VisiBroker ORB the server wishes to use, obtained by the invoking the ORB.init method. 

<type_name>Holder

public final class <interface_name>Holder

A Holder class is provided for all basic IDL types in the org.omg.CORBA package. Holder classes are also generated by the idl2java compiler for all user-defined types. The suffix Holder is added to the class name that is generated for user-defined types. Each Holder has a set of constructors and a value member, which is the typed value.

The holder classes for the basic types are defined below. They are in the org.omg.CORBA package:

The Holder class for a user-defined type <type_name> follows.
// Java
final public class <type_name>Holder
   implements org.omg.CORBA.portable.Streamable {
   public <type_name> value;
   public <type_name>Holder() {}
   public <type_name>Holder(<type_name> initial) {}
   public void _read(org.omg.CORBA.portable.InputStream i)
      {...};
   public void _write(org.omg.CORBA.portable.OutputStream o)
      {...};
   public org.omg.CORBA.TypeCode _type() {...}
   }

Member data

public <type_name> value

This value represents the type contained by this object.

Methods

public <type_name>Holder()

This default constructor is useful for out parameters. The default constructor sets the value field to the default value for the type as defined by the Java language. The value is set to false for boolean types, 0 for integral and char types, null for strings, and null for object references.

public <type_name>Holder(<interface_name> initial)

The value constructor is useful for inout parameters. The value field is copied from the value field of the specified Any object.
 

Parameter Description
initial  The other object the Holder is containing. 

_<interface_name>Stub

abstract public class _<interface_name>Stub

A stub class is generated by the idl2java compiler to provide a stub implementation for <interface_name> which the client calls. This class provides the implementation for transparently acting on an object implementation.

<interface_name>POA

abstract public class <interface_name>POA

This class provides the POA skeleton (servant) class for your interface. It does not provide any implementation for the <interface>Operations interface. You extend this class when implementing your <interface>Impl class.

<interface_name>POATie

abstract public class <interface_name>POATie

A tie class is generated by the idl2java compiler for creating a delegator class for <interface_name>POA.

Methods

public <interface>POATie (final <interface>Operations _delegate)

This method is the constructor. You pass it an object which implements the <interface>Operations interface and which will be used as the delegate object.

public <interface>POATie (final <interface>Operations _delegate, final org.omg.PortableServer.POA _poa)

This method is the constructor which initializes the delegate object and the default POA servant.


Borland Software Corporation
http://www.borland.com
100 Enterprise Way
Scotts Valley, CA 95066
Voice: (831) 431-1000
pubsweb@borland.com

Read the latest documentation online