1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
|
/* ORB.java --
Copyright (C) 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version. */
package org.omg.CORBA;
import gnu.CORBA.Restricted_ORB;
import gnu.CORBA.fixedTypeCode;
import gnu.CORBA.generalTypeCode;
import gnu.CORBA.gnuContext;
import gnu.CORBA.primitiveTypeCode;
import gnu.CORBA.recordTypeCode;
import gnu.CORBA.recursiveTypeCode;
import org.omg.CORBA.ORBPackage.InconsistentTypeCode;
import java.applet.Applet;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;
/**
* A central class in CORBA implementation, responsible for sending and
* handling remote invocations. ORB also works as a factory for
* creating instances of certain CORBA classes.
*
* Despite the core library contains the fully working CORBA implementation,
* it also provides a simple way to plug-in the alternative CORBA support.
* This is done by replacing the ORB. The alternative ORB can be specified
* via properties, passed to ORB.Init(...).
*
* When creating an ORB instance, the class name
* is searched in the following locations:
* <p>
* 1. Applet parameter or application string array, if any.<br>
* 2. The properties parameter, if any.<br>
* 3. The System properties.<br>
* 4. The orb.properties file located in the user.home directory (if any).<br>
* 5. The orb.properties file located in the java.home/lib directory (if any).
* </p>
*
* The supported properties are:
* <table border="1">
* <tr><td> org.omg.CORBA.ORBClass</td><td>The class,
* implementing the functional ORB, returned by
* {@link #init(Applet, Properties)} or
* {@link #init(String[], Properties)} </td></tr>
* <tr><td>org.omg.CORBA.ORBSingletonClass</td><td>The class,
* implementing the restricted ORB, returned by
* {@link #init()}.
* </td></tr>
* <tr><td>org.omg.CORBA.ORBInitRef</td><td>Specifies the
* initial reference, accessible by name with the method
* {@link resolve_initial_references(String)}.
* </table>
* The command line accepts the same properties as a keys. When specifying
* in the command line, the prefix org.omg.CORBA can be omitted,
* for instance<code> -ORBInitRef NameService=IOR:aabbccdd....</code>
*
* @author Audrius Meskauskas (AudriusA@Bioinformatics.org)
*/
public abstract class ORB
{
/**
* By default, {@link init(String[], Properties)} and
* {@link init(Applet, Properties} return
* the built-in fully functional ORB is returned. If the
* <code>props</code> contains the property org.omg.CORBA.ORBClass,
* the value of this property is used as a class name to instantiate
* a user-defined ORB.
*/
private static final String FUNCTIONAL_ORB = "org.omg.CORBA.ORBClass";
/**
* The name of the restricted ORB property.
*/
private static final String RESTRICTED_ORB =
"org.omg.CORBA.ORBSingletonClass";
/**
* The class, implementing the default fully functional ORB.
*/
private static final String DEFAULT_FUNCTIONAL_ORB =
gnu.CORBA.Poa.ORB_1_4.class.getName();
/**
* The class, implementing the default restricted ORB.
*/
private static final String DEFAULT_RESTRICTED_ORB =
gnu.CORBA.Restricted_ORB.class.getName();
/**
* Connect the given CORBA object to this ORB. After the object is
* connected, it starts receiving remote invocations via this ORB.
*
* The OMG group recommends to use Portable Object Adapter (POA) instead
* of calling this method.
*
* This method is implemented in the derived Gnu Classpah classes,
* returned by ORB.init(..). In this abstract class, the implementation
* just throws {@link NO_IMPLEMENT}.
*
* @param object the org.omg.CORBA.Object to connect.
*/
public void connect(org.omg.CORBA.Object object)
{
throw new NO_IMPLEMENT();
}
/**
* Disconnect the given CORBA object from this ORB. The object will be
* no longer receiving the remote invocations. In response to the
* remote invocation on this object, the ORB will send the
* exception {@link OBJECT_NOT_EXIST}. The object, however, is not
* destroyed and can receive the local invocations.
*
* This method is implemented in the derived Gnu Classpah classes,
* returned by ORB.init(..). In this abstract class, the implementation
* just throws {@link NO_IMPLEMENT}.
*
* @param object the object to disconnect.
*/
public void disconnect(org.omg.CORBA.Object object)
{
throw new NO_IMPLEMENT();
}
/**
* Create alias typecode for the given typecode.
*/
public abstract TypeCode create_alias_tc(String id, String name,
TypeCode typecode
);
/**
* Create an instance of the CORBA {@link Any} with the type, intialised
* to {@link TCKind#tc_null}
*/
public abstract Any create_any();
/**
* Create a typecode, defining an array of the given elements.
*
* @param length the size of array
* @param element_type the array component type.
*
* @return the corresponding typecode.
*/
public abstract TypeCode create_array_tc(int length, TypeCode element_type);
/**
* Creates an empty CORBA <code>ContextList</code>.
*
* @return the newly created context list.
*/
public abstract ContextList create_context_list();
/**
* The support for {@link DynAny} and derived interfaces
* has never been implemented in Sun's java releases,
* at least till v1.4 inclusive.
*
* Since v1.4 this stil missing implementation was replaced
* by the new DynamicAny package.
*
* @throws NO_IMPLEMENT, always.
*/
public DynAny create_basic_dyn_any(org.omg.CORBA.TypeCode t)
throws InconsistentTypeCode
{
throw new NO_IMPLEMENT();
}
;
/**
* The support for {@link DynAny} and derived interfaces
* has never been implemented in Sun's java releases,
* at least till v1.4 inclusive.
*
* Since v1.4 this stil missing implementation was replaced
* by the new DynamicAny package.
*
* @throws NO_IMPLEMENT, always.
*/
public DynAny create_dyn_any(org.omg.CORBA.Any a)
{
throw new NO_IMPLEMENT();
}
;
/**
* The support for {@link DynArray}
* has never been implemented in Sun's java releases,
* at least till v1.4 inclusive.
*
* Since v1.4 this stil missing implementation was replaced
* by the new DynamicAny package.
*
* @throws NO_IMPLEMENT, always.
*/
public DynArray create_dyn_array(org.omg.CORBA.TypeCode t)
throws InconsistentTypeCode
{
throw new NO_IMPLEMENT();
}
;
/**
* The support for {@link DynEnum}
* has never been implemented in Sun's java releases,
* at least till v1.4 inclusive.
*
* Since v1.4 this stil missing implementation was replaced
* by the new DynamicAny package.
*
* @throws NO_IMPLEMENT, always.
*/
public DynEnum create_dyn_enum(org.omg.CORBA.TypeCode t)
throws InconsistentTypeCode
{
throw new NO_IMPLEMENT();
}
;
/**
* The support for {@link DynSequence}
* has never been implemented in Sun's java releases,
* at least till v1.4 inclusive.
*
* Since v1.4 this stil missing implementation was replaced
* by the new DynamicAny package.
*
* @throws NO_IMPLEMENT, always.
*/
public DynSequence create_dyn_sequence(org.omg.CORBA.TypeCode t)
throws InconsistentTypeCode
{
throw new NO_IMPLEMENT();
}
;
/**
* The support for {@link DynStruct} and derived interfaces
* has never been implemented in Sun's java releases,
* at least till v1.4 inclusive.
*
* Since v1.4 this stil missing implementation was replaced
* by the new DynamicAny package.
*
* @throws NO_IMPLEMENT, always.
*/
public DynStruct create_dyn_struct(org.omg.CORBA.TypeCode t)
throws InconsistentTypeCode
{
throw new NO_IMPLEMENT();
}
;
/**
* The support for {@link DynUnion} and derived interfaces
* has never been implemented in Sun's java releases,
* at least till v1.4 inclusive.
*
* Since v1.4 this stil missing implementation was replaced
* by the new DynamicAny package.
*
* @throws NO_IMPLEMENT, always.
*/
public DynUnion create_dyn_union(org.omg.CORBA.TypeCode t)
throws InconsistentTypeCode
{
throw new NO_IMPLEMENT();
}
;
/**
* Create a typecode, defining the given enumeration.
*
* @param id the id.
* @param name the name.
* @param members the memebers
* @return the created enumeration.
*/
public abstract TypeCode create_enum_tc(String id, String name,
String[] members
);
/**
* Create an environment (container for exceptions).
*
* @return the created container.
*/
public abstract Environment create_environment();
/**
* Creates an empty exception list.
*
* @return the newly created list.
*/
public abstract ExceptionList create_exception_list();
/**
* Create the exception typecode.
*
* @param id the id of exception.
* @param name the name of exception.
* @param members the members of exception.
*/
public abstract TypeCode create_exception_tc(String id, String name,
StructMember[] members
);
/**
* Creates a TypeCode object for CORBA <code>fixed</code> that is
* mapped to java {@link java.math.BigDecimal}.
*
* @param digits the number of digits in that <code>fixed</code>.
* @param scale the number of digits after the decimal point.
*
* @return the corresponding TypeCode.
*/
public TypeCode create_fixed_tc(short digits, short scale)
{
fixedTypeCode r = new fixedTypeCode();
r.setDigits(digits);
r.setScale(scale);
return r;
}
/**
* Creates a typecode, representing the IDL interface.
*
* @param id the interface repository id.
* @param name the interface name.
*
* @return the created typecode.
*/
public abstract TypeCode create_interface_tc(String id, String name);
/**
* Create an instance of a new {@link NVList}.
*
* @param count the initial size of the list. If more elements are added,
* the list automatically expands.
*
* @return the created list.
*/
public abstract NVList create_list(int count);
/**
* Create a new named value.
*
* @param name the name of the named value
* @param any the content of the named value.
* @param flags the flags of the named value
*
* @return the named value.
*/
public abstract NamedValue create_named_value(String s, Any any, int flags);
/**
* Send multiple prepared requests one way, do not caring about the answer.
* The messages, containing requests, will be marked, indicating that
* the sender is not expecting to get a reply.
*
* @param requests the prepared array of requests.
*
* @see Request#send_oneway()
*/
public abstract void send_multiple_requests_oneway(Request[] requests);
/**
* Send multiple prepared requests expecting to get a reply. All requests
* are send in parallel, each in its own separate thread. When the
* reply arrives, it is stored in the agreed fields of the corresponing
* request data structure. If this method is called repeatedly,
* the new requests are added to the set of the currently sent requests,
* but the old set is not discarded.
*
* @param requests the prepared array of requests.
*
* @see #poll_next_response()
* @see #get_next_response()
* @see Request#send_deferred()
*/
public abstract void send_multiple_requests_deferred(Request[] requests);
/**
* Find if any of the requests that have been previously sent with
* {@link #send_multiple_requests_deferred}, have a response yet.
*
* @return true if there is at least one response to the previously
* sent request, false otherwise.
*/
public abstract boolean poll_next_response();
/**
* Get the next instance with a response being received. If all currently
* sent responses not yet processed, this method pauses till at least one of
* them is complete. If there are no requests currently sent, the method
* pauses till some request is submitted and the response is received.
* This strategy is identical to the one accepted by Suns 1.4 ORB
* implementation.
*
* @return the previously sent request that now contains the received
* response.
*
* @throws WrongTransaction If the method was called from the transaction
* scope different than the one, used to send the request. The exception
* can be raised only if the request is implicitly associated with some
* particular transaction.
*/
public abstract Request get_next_response()
throws WrongTransaction;
/**
* Create a new CDR output stream, where the parameter values can be written
* during the method invocation.
*
* @return a stream to write values into.
*/
public abstract org.omg.CORBA.portable.OutputStream create_output_stream();
/**
* This should create the list, initialised with the argument descriptions
* for the given operation definition (CORBA <code>OperationDef</code>).
* The information should be obtained from the interface repository.
* However this method is oficially documented as not implemented at least
* till v1.4 inclusive.
*
* @param peration_definition the operation definition, must be
* CORBA <code>OperationDef</code>.
*
* @return never
*
* @throws NO_IMPLEMENT, always.
*/
public NVList create_operation_list(Object operation_definition)
{
throw new NO_IMPLEMENT();
}
/**
* This should create the new policy with the specified type and initial
* state. The policies and methods for getting them are not implemented till
* v1.4 inclusive.
*
* @param type the policy type.
* @param value the policy value.
*
* @return never
*
* @throws NO_IMPLEMENT, always.
*/
public Policy create_policy(int type, Any value)
throws PolicyError
{
throw new NO_IMPLEMENT();
}
/**
* Create typecode, defining the sequence of the elements, having
* the given type.
*
* @param bound the maximal length of the sequence, 0 if not restricted.
*
* @param element_type the sequence element type.
*
* @return the typecode.
*/
public abstract TypeCode create_sequence_tc(int bound, TypeCode element_type);
/**
* Create a TypeCode, representing the CORBA <code>string</code>.
*
* @param bound the maximal length of the string, 0 is unlimited.
*
* @return the corresponding string typecode.
*/
public abstract TypeCode create_string_tc(int bound);
/**
* Create the typecode, defining the given IDL structure.
*
* The TypeCode object is initialized with the given id, name, and members.
* @param id the Id of this type.
* @param the name of this type.
* @param members the member list.
*
* @return the typecode.
*/
public abstract TypeCode create_struct_tc(String id, String name,
StructMember[] members
);
/**
* Create the typecode, defining the given IDL union.
*
* The TypeCode object is initialized with the given id, name, discriminator
* and members.
*
* @param id the Id of this type.
* @param the name of this type.
* @param discriminator the union discriminator.
* @param members the member list.
*
* @return the typecode.
*/
public abstract TypeCode create_union_tc(String id, String name,
TypeCode discriminator,
UnionMember[] members
);
/**
* Create a TypeCode, representing the CORBA <code>wstring</code>.
*
* @param bound the maximal length of the string, 0 is unlimited.
*
* @return the corresponding string typecode.
*/
public abstract TypeCode create_wstring_tc(int bound);
/**
* Create a typecode for an abstract interface. The abstract interface
* can be either CORBA object or CORBA value type.
*
* @param id the id of the abstract interface.
* @param name the name of the abstract interface.
*
* @return the created typecode.
*/
public TypeCode create_abstract_interface_tc(String id, String name)
{
generalTypeCode t = new generalTypeCode(TCKind.tk_abstract_interface);
t.setName(name);
t.setId(id);
return t;
}
/**
* Create a typecode for a native interface.
*
* @param id the id of the native interface.
* @param name the name of the native interface.
*
* @return the created typecode.
*/
public TypeCode create_native_tc(String id, String name)
{
generalTypeCode t = new generalTypeCode(TCKind.tk_native);
t.setName(name);
t.setId(id);
return t;
}
/**
* Create a typecode, representing a tree-like structure.
* This structure contains a member that is a sequence of the same type,
* as the structure itself. You can imagine as if the folder definition
* contains a variable-length array of the enclosed (nested) folder
* definitions. In this way, it is possible to have a tree like
* structure that can be transferred via CORBA CDR stream.
*
* @deprecated It is easier and clearler to use a combination of
* create_recursive_tc and create_sequence_tc instead.
*
* @param bound the maximal expected number of the nested components
* on each node; 0 if not limited.
*
* @param offset the position of the field in the returned structure
* that contains the sequence of the structures of the same field.
* The members before this field are intialised using parameterless
* StructMember constructor.
*
* @return a typecode, defining a stucture, where a member at the
* <code>offset</code> position defines an array of the identical
* structures.
*
* @see #create_recursive_tc(String)
* @see #create_sequence_tc(int, TypeCode)
*/
public TypeCode create_recursive_sequence_tc(int bound, int offset)
{
recordTypeCode r = new recordTypeCode(TCKind.tk_struct);
for (int i = 0; i < offset; i++)
r.add(new StructMember());
TypeCode recurs = new primitiveTypeCode(TCKind.tk_sequence);
r.add(new StructMember("", recurs, null));
return r;
}
/**
* Create a typecode which serves as a placeholder for typcode, containing
* recursion.
*
* @param id the id of the recursive typecode, for that this typecode
* serves as a placeholder.
*/
public TypeCode create_recursive_tc(String id)
{
return new recursiveTypeCode(id);
}
/**
* Create value box typecode.
*/
public TypeCode create_value_box_tc(String id, String name,
TypeCode boxed_type
)
{
generalTypeCode t = new generalTypeCode(TCKind.tk_value_box);
t.setName(name);
t.setId(id);
t.setContentType(boxed_type);
return t;
}
/**
* Create IDL value type code.
*/
public TypeCode create_value_tc(String id, String name, short type_modifier,
TypeCode concrete_base, ValueMember[] members
)
{
recordTypeCode r = new recordTypeCode(TCKind.tk_value);
r.setId(id);
r.setName(name);
r.setTypeModifier(type_modifier);
r.setConcreteBase_type(concrete_base);
for (int i = 0; i < members.length; i++)
{
r.add(members [ i ]);
}
return r;
}
/**
* This should return the information, related to the current thread.
* The information is needed, for instance, to get the current object
* from the code that serves several objects in parallel threads.
* The {@link Current} is very general interface, with no fields and
* operations defined. This method is not implemented in Suns
* releases at least till v1.5 inclusive. To obtain the
* {@link org.omg.PortableServer.Current}, use
* {@link #resolve_initial_references}, passing "POACurrent".
*
* @deprecated since 1.2, use {@link #resolve_initial_references}.
*
* @return never
*
* @throws NO_IMPLEMENT always.
*/
public Current get_current()
{
throw new NO_IMPLEMENT();
}
/**
* This should return the information about the CORBA facilities and
* services, available from this ORB. However this method is oficially
* documented as not implemented at least till v1.5 inclusive.
*
* @param service_type a type of the service being requested. The OMG
* specification currently defines only one value, 1, for security
* related services.
*
* @param service_info a holder, where the returned information should
* be stored.
*
* @return should return true if the service information is available
* from the ORB, but this method never returns.
*
* @throws NO_IMPLEMENT always.
*/
public boolean get_service_information(short service_type,
ServiceInformationHolder service_info
)
{
throw new NO_IMPLEMENT();
}
/**
* Get the default context of this ORB. This is an initial root of all
* contexts.
*
* The default method returns a new context with the empty name and
* no parent context.
*
* @return the default context of this ORB.
*
* @throws NO_IMPLEMENT for the Singleton ORB, returned by
* the parameterless {@link init()}.
*/
public Context get_default_context()
{
return new gnuContext("", null);
}
/**
* Return thg typecode, representing the given primitive object type.
*
* @param the kind of the primitive typecode.
*
* @return the typecode of the primitve typecode.
*/
public abstract TypeCode get_primitive_tc(TCKind tcKind);
/**
* Returns so-called Singleton ORB, a highly restricted version
* that cannot communicate over network. This ORB is provided
* for the potentially malicious applets with heavy security restrictions.
*
* The returned Singleton ORB can only create typecodes,
* {@link Any}, {@link ContextList}, {@link NVList} and
* {@link org.omg.CORBA.portable.OutputStream} that writes to an
* internal buffer.
*
* All other methods throw the {@link NO_IMPLEMENT} exception, additionally
* printing the error message about the potential attempt to violate
* the security rules.
*
* The implementing ORB class, used in this method, is found as described
* in the header.
*
* @return the working derivative of ORB, implementing the methods
* of this abstract class.
*/
public static ORB init()
{
String orb_cn = getORBName(null, RESTRICTED_ORB);
if (orb_cn == null)
return Restricted_ORB.Singleton;
else
return createORB(null, orb_cn);
}
/**
* Creates the working instance of ORB for an applet.
*
* By default the built-in fully functional ORB is returned. The ORB class
* is found as described in the header of this class.
*
* @param applet the applet. The property org.omg.CORBA.ORBClass,
* if present, defines the used ORB implementation class. If this
* property is not present, the ORB class is found as described in the
* class header.
*
* @param props the properties, may be <code>null</code>.
*
* @return a newly created functional derivative of this abstract class.
*/
public static ORB init(Applet applet, Properties props)
{
String ocn = applet.getParameter(FUNCTIONAL_ORB);
ORB orb = createORB(props, ocn);
orb.set_parameters(applet, props);
return orb;
}
/**
* Creates the working instance of ORB for a
* standalone application.
*
* By default the built-in fully functional ORB is returned. The ORB class
* is found as described in the header of this class.
*
* @param the parameters, passed to the applications
* <code>main(String[] args)</code> method, may be <code>null</code>.
* The parameter -org.omg.CORBA.ORBClass <class name>
* if present, defines the used ORB implementation class. If this
* property is not present, the ORB class is found as described in the
* class header.
*
* @param props application specific properties, may be <code>null</code>.
*
* @return a newly created functional derivative of this abstract class.
*/
public static ORB init(String[] args, Properties props)
{
String ocn = null;
String orbKey = "-" + FUNCTIONAL_ORB;
if (args != null)
if (args.length >= 2)
{
for (int i = 0; i < args.length - 1; i++)
{
if (args [ i ].equals(orbKey))
ocn = args [ i + 1 ];
}
}
ORB orb = createORB(props, ocn);
orb.set_parameters(args, props);
return orb;
}
/**
* List the initially available CORBA objects (services).
*
* @return a list of services.
*
* @see resolve_initial_references(String)
*/
public abstract String[] list_initial_services();
/**
* Find and return the easily accessible CORBA object, addressed
* by name. The returned object is typically casted to the more
* specific reference using the <code>narrow(Object)</code> method
* of its helper. The method resolves the following string values,
* returning the working objects:
* <table border="1"><tr><th>String</th><th>Object class</th>
* <th>Object use</th></tr>
*
* <tr><td>NameService</td><td>{@link org.omg.CosNaming.NamingContextExt}</td>
* <td>Finds (usually remote) object by its name.</td></tr>
*
* <tr><td>RootPOA</td><td>{@link org.omg.PortableServer.POA}</td>
* <td>Holds the POA tree for this ORB, where since 1.4 all servants
* should be connected.</td></tr>
*
* <tr><td>RootPOAManager</td><td>{@link org.omg.PortableServer.POAManager}
* </td><td>Regulates (suspends/resumes) the root POA
* activity</td></tr>
*
* <tr><td>POACurrent</td><td>{@link org.omg.PortableServer.Current}
* </td><td>Informs the current thread about the Id and POA of the
* object being currently served (the methods of
* <code>Current</code> return different values for
* different threads).
* </td></tr>
*
* <tr><td>CodecFactory</td><td>{@link org.omg.IOP.Codec}</td>
* <td>Encodes/decodes IDL data types into/from byte arrays.</td>
* </tr>
*
* <tr><td>DynAnyFactory</td><td>{@link org.omg.DynamicAny.DynAnyFactory}</td>
* <td>Creates DynAny's.</td>
* </tr>
*
* </table>
*
* @param name the object name.
* @return the object
* @throws org.omg.CORBA.ORBPackage.InvalidName if the given name
* is not associated with the known object.
*/
public abstract Object resolve_initial_references(String name)
throws org.omg.CORBA.ORBPackage.InvalidName;
/**
* Get the IOR reference string for the given object.
* IOR can be compared with the Internet address for a web page,
* it provides means to locate the CORBA service on the web.
* IOR contains the host address, port number, the object identifier
* (key) inside the server, the communication protocol version,
* supported charsets and so on.
*
* @param the CORBA object
* @return the object IOR representation.
* @see string_to_object(String)
*/
public abstract String object_to_string(Object forObject);
/**
* This should perform the implementation dependent unit of work in the
* main thread.
*
* This method is part of the support for the distribute use of the
* single execution thread.
*
* Same as in Suns releases at least till 1.4 inclusive,
* the distribute use of the single thread is not implemented.
* Use multiple threads, provided by jre.
*
* The method returns without action.
*/
public void perform_work()
{
}
/**
* Checks if the ORB needs the main thread to perform some work.
* The method should return true if the ORB needs the main thread,
* and false if it does not.
*
* This method is part of the support for the distribute use of the
* single execution thread.
*
* Same as in Suns releases at least till 1.4 inclusive,
* the distributed use of the single thread is not implemented.
* Use multiple threads, provided by jre.
*
* @return false, always.
*/
public boolean work_pending()
{
return false;
}
/**
* Find and return the CORBA object, addressed by the given
* IOR string representation. The object can (an usually is)
* located on a remote computer, possibly running a different
* (not necessary java) CORBA implementation. The returned
* object is typically casted to the more specific reference
* using the <code>narrow(Object)</code> method of its helper.
*
* @param IOR the object IOR representation string.
*
* @return the found CORBA object.
* @see object_to_string(org.omg.CORBA.Object)
*/
public abstract Object string_to_object(String IOR);
/**
* Start listening on the input socket. This method
* blocks the current thread until {@link #shutdown(boolean)}
* is called and shutdown process is completed.
*/
public void run()
{
}
/**
* Shutdown the ORB server.
*
* @param wait_for_completion if true, the current thread is
* suspended untile the shutdown process is complete.
*/
public void shutdown(boolean wait_for_completion)
{
}
/**
* Destroy this server, releasing the occupied resources.
* The default method returns without action.
*/
public void destroy()
{
}
/**
* Set the ORB parameters. This method is normally called from
* {@link #init(String[], Properties)}.
*
* @param para the parameters, that were passed as the parameters
* to the <code>main(String[] args)</code> method of the current standalone
* application.
*
* @param props application specific properties that were passed
* as a second parameter in {@link init(String[], Properties)}).
* Can be <code>null</code>.
*/
protected abstract void set_parameters(String[] para, Properties props);
/**
* Set the ORB parameters. This method is normally called from
* {@link #init(Applet, Properties)}.
*
* @param app the current applet.
*
* @param props application specific properties, passed as the second
* parameter in {@link #init(Applet, Properties)}.
* Can be <code>null</code>.
*/
protected abstract void set_parameters(Applet app, Properties props);
/**
* Checks if the communication over network is allowed.
* @throws java.lang.SecurityException
*/
private static final void checkNetworkingPermission(String host, int port)
throws SecurityException
{
SecurityManager security = System.getSecurityManager();
if (security != null)
{
security.checkConnect(host, port);
}
}
/**
* Get the ORB class name.
*/
private static String getORBName(Properties props, String property)
{
String orb_cn = null;
if (props != null)
orb_cn = props.getProperty(property, null);
if (orb_cn == null)
orb_cn = System.getProperty(property, null);
if (orb_cn == null)
orb_cn = checkFile(property, "user.home", null);
if (orb_cn == null)
orb_cn = checkFile(property, "java.home", "lib");
return orb_cn;
}
/**
* Check if the property is defined in the existsting file orb.properties.
*
* @param property the property
* @param dir the system property, defining the folder where the
* file could be expected.
* @param subdir subfolder where to look for the file.
*
* @return the property value, null if not found or file does not exist.
*/
private static String checkFile(String property, String dir, String subdir)
{
try
{
File f = new File(dir);
if (!f.exists())
return null;
if (subdir != null)
f = new File(f, subdir);
f = new File(f, "orb.properties");
if (!f.exists())
return null;
Properties p = new Properties();
p.load(new BufferedInputStream(new FileInputStream(f)));
return p.getProperty(property, null);
}
catch (IOException ex)
{
return null;
}
}
/**
* Create ORB when its name is possibly known.
*
* @param props properties, possibly containing the ORB name.
* @param orbClassName the direct ORB class name, overriding
* other possible locations, or null if not specified.
*/
private static ORB createORB(Properties props, String orbClassName)
{
ORB orb = null;
if (orbClassName == null)
{
orbClassName = getORBName(props, FUNCTIONAL_ORB);
if (orbClassName == null)
orbClassName = DEFAULT_FUNCTIONAL_ORB;
}
try
{
orb = (ORB) Class.forName(orbClassName).newInstance();
}
catch (ClassNotFoundException ex)
{
noORB(orbClassName, ex);
}
catch (IllegalAccessException ex)
{
noORB(orbClassName, ex);
}
catch (InstantiationException ex)
{
noORB(orbClassName, ex);
}
return orb;
}
/**
* Throw the runtime exception.
*
* @param orb_c the ORB class name.
* @param why the explaining chained exception.
*/
private static void noORB(String orb_c, Throwable why)
{
throw new RuntimeException("The ORB " + orb_c + " cannot be instantiated.",
why
);
}
}
|