1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
8
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
10
TITLE="Ice Reference Documentation"
11
HREF="index.html"><LINK
13
TITLE="Slice Documentation"
16
TITLE="IceGrid::AdaptiveLoadBalancingPolicy"
17
HREF="x9176.html"><LINK
19
TITLE="IceGrid::ApplicationDescriptor"
20
HREF="x10602.html"></HEAD
31
SUMMARY="Header navigation table"
40
>Ice Reference Documentation</TH
50
><<< Previous</A
56
>Slice Documentation</TD
64
>Next >>></A
112
> administrative interface. <DIV
126
SRC="./stylesheet-images/warning.gif"
134
access to this interface is a security risk! Please see the
141
> documentation for further information.</P
162
HREF="x9202.html#ICEGRID.ADMIN.ADDAPPLICATION"
170
>Add an application to <SPAN
180
HREF="x9202.html#ICEGRID.ADMIN.ADDOBJECT"
188
>Add an object to the object registry.</P
192
HREF="x9202.html#ICEGRID.ADMIN.ADDOBJECTWITHTYPE"
195
>addObjectWithType</TT
200
>Add an object to the object registry and explicitly specify
205
HREF="x9202.html#ICEGRID.ADMIN.ENABLESERVER"
213
>Enable or disable a server.</P
217
HREF="x9202.html#ICEGRID.ADMIN.GETADAPTERENDPOINTS"
220
>getAdapterEndpoints</TT
225
>Get the list of endpoints for an adapter.</P
229
HREF="x9202.html#ICEGRID.ADMIN.GETALLADAPTERIDS"
232
>getAllAdapterIds</TT
237
>Get all the adapter ids registered with <SPAN
247
HREF="x9202.html#ICEGRID.ADMIN.GETALLAPPLICATIONNAMES"
250
>getAllApplicationNames</TT
261
> applications currently registered.</P
265
HREF="x9202.html#ICEGRID.ADMIN.GETALLNODENAMES"
279
> nodes currently registered.</P
283
HREF="x9202.html#ICEGRID.ADMIN.GETALLOBJECTINFOS"
286
>getAllObjectInfos</TT
291
>Get the object info of all the registered objects whose stringified
292
identities match the given expression.</P
296
HREF="x9202.html#ICEGRID.ADMIN.GETALLSERVERIDS"
304
>Get all the server ids registered with <SPAN
314
HREF="x9202.html#ICEGRID.ADMIN.GETAPPLICATIONDESCRIPTOR"
317
>getApplicationDescriptor</TT
322
>Get an application descriptor.</P
326
HREF="x9202.html#CEGRID.ADMIN.GETDEFAULTAPPLICATIONDESCRIPTOR"
329
>getDefaultApplicationDescriptor</TT
334
>Get the default application descriptor.</P
338
HREF="x9202.html#ICEGRID.ADMIN.GETNODEHOSTNAME"
346
>Get the hostname of this node.</P
350
HREF="x9202.html#ICEGRID.ADMIN.GETNODEINFO"
358
>Get the node information for the node with the given name.</P
362
HREF="x9202.html#ICEGRID.ADMIN.GETNODELOAD"
370
>Get the load averages of the node.</P
374
HREF="x9202.html#ICEGRID.ADMIN.GETOBJECTINFO"
382
>Get the object info for the object with the given identity.</P
386
HREF="x9202.html#ICEGRID.ADMIN.GETSERVERINFO"
394
>Get the server information for the server with the given id.</P
398
HREF="x9202.html#ICEGRID.ADMIN.GETSERVERPID"
406
>Get a server's system process id.</P
410
HREF="x9202.html#ICEGRID.ADMIN.GETSERVERSTATE"
418
>Get a server's state.</P
422
HREF="x9202.html#ICEGRID.ADMIN.GETSLICECHECKSUMS"
425
>getSliceChecksums</TT
430
>Returns the checksums for the IceGrid Slice definitions.</P
434
HREF="x9202.html#ICEGRID.ADMIN.INSTANTIATESERVER"
437
>instantiateServer</TT
442
>Instantiate a server template from an application.</P
446
HREF="x9202.html#ICEGRID.ADMIN.ISSERVERENABLED"
454
>Check if the server is enabled or disabled.</P
458
HREF="x9202.html#ICEGRID.ADMIN.PATCHAPPLICATION"
461
>patchApplication</TT
466
>Patch the given application data.</P
470
HREF="x9202.html#ICEGRID.ADMIN.PATCHSERVER"
482
HREF="x9202.html#ICEGRID.ADMIN.PINGNODE"
496
> node to see if it is active.</P
500
HREF="x9202.html#ICEGRID.ADMIN.REMOVEADAPTER"
508
>Remove the adapter with the given id.</P
512
HREF="x9202.html#ICEGRID.ADMIN.REMOVEAPPLICATION"
515
>removeApplication</TT
520
>Remove an application from <SPAN
530
HREF="x9202.html#ICEGRID.ADMIN.REMOVEOBJECT"
538
>Remove an object from the object registry.</P
542
HREF="x9202.html#ICEGRID.ADMIN.SENDSIGNAL"
550
>Send signal to a server.</P
554
HREF="x9202.html#ICEGRID.ADMIN.SHUTDOWN"
572
HREF="x9202.html#ICEGRID.ADMIN.SHUTDOWNNODE"
590
HREF="x9202.html#ICEGRID.ADMIN.STARTSERVER"
598
>Start a server and wait for its activation.</P
602
HREF="x9202.html#ICEGRID.ADMIN.STOPSERVER"
614
HREF="x9202.html#ICEGRID.ADMIN.SYNCAPPLICATION"
622
>Synchronize a deployed application with the given application
627
HREF="x9202.html#ICEGRID.ADMIN.UPDATEAPPLICATION"
630
>updateApplication</TT
635
>Update a deployed application with the given update application
640
HREF="x9202.html#ICEGRID.ADMIN.UPDATEOBJECT"
648
>Update an object in the object registry.</P
652
HREF="x9202.html#ICEGRID.ADMIN.WRITEMESSAGE"
660
>Write message on server stdout or stderr.</P
671
NAME="ICEGRID.ADMIN.ADDAPPLICATION"
695
>ApplicationDescriptor</CODE
708
>DeploymentException</CODE
715
>Add an application to <SPAN
744
> The application descriptor.</P
767
>DeploymentException</CODE
772
> Raised if application deployment
784
NAME="ICEGRID.ADMIN.ADDOBJECT"
818
>ObjectExistsException</CODE
825
>DeploymentException</CODE
832
>Add an object to the object registry. <SPAN
839
object type by calling <TT
842
> on the given proxy. The object
843
must be reachable.</P
866
> The object to be added to the registry.</P
889
>ObjectExistsException</CODE
894
> Raised if the object is already
906
NAME="ICEGRID.ADMIN.ADDOBJECTWITHTYPE"
909
>addObjectWithType</TT
925
>addObjectWithType</TT
949
>ObjectExistsException</CODE
956
>DeploymentException</CODE
963
>Add an object to the object registry and explicitly specify
987
> The object to be added to the registry.</P
998
> The object type.</P
1014
CLASS="VARIABLELIST"
1021
>ObjectExistsException</CODE
1026
> Raised if the object is already
1038
NAME="ICEGRID.ADMIN.ENABLESERVER"
1082
>ServerNotExistException</CODE
1089
>NodeUnreachableException</CODE
1096
>Enable or disable a server. A disabled server can't be started
1097
on demand or administratively. The enable state of the server
1098
is not persistent: if the node is shutdown and restarted, the
1099
server will be enabled by default.</P
1111
CLASS="VARIABLELIST"
1133
> True to enable the server, false to disable it.</P
1149
CLASS="VARIABLELIST"
1156
>ServerNotExistException</CODE
1161
> Raised if the server doesn't exist.</P
1168
>NodeUnreachableException</CODE
1173
> Raised if the node could not
1185
NAME="ICEGRID.ADMIN.GETADAPTERENDPOINTS"
1188
>getAdapterEndpoints</TT
1200
HREF="x8111.html#ICEGRID.STRINGOBJECTPROXYDICT"
1203
>StringObjectProxyDict</SPAN
1207
>getAdapterEndpoints</TT
1222
>AdapterNotExistException</CODE
1229
>NodeUnreachableException</CODE
1236
>Get the list of endpoints for an adapter.</P
1248
CLASS="VARIABLELIST"
1259
> The adapter id.</P
1273
> A dictionary of adapter direct proxy classified by
1287
CLASS="VARIABLELIST"
1294
>AdapterNotExistException</CODE
1299
> Raised if the adapter doesn't
1307
>NodeUnreachableException</CODE
1312
> Raised if the node could not be
1324
NAME="ICEGRID.ADMIN.GETALLADAPTERIDS"
1327
>getAllAdapterIds</TT
1339
HREF="x78.html#ICE.STRINGSEQ"
1342
>::Ice::StringSeq</SPAN
1346
>getAllAdapterIds</TT
1352
>Get all the adapter ids registered with <SPAN
1368
> The adapter ids.</P
1376
NAME="ICEGRID.ADMIN.GETALLAPPLICATIONNAMES"
1379
>getAllApplicationNames</TT
1391
HREF="x78.html#ICE.STRINGSEQ"
1394
>::Ice::StringSeq</SPAN
1398
>getAllApplicationNames</TT
1410
> applications currently registered.</P
1420
> The application names.</P
1428
NAME="ICEGRID.ADMIN.GETALLNODENAMES"
1431
>getAllNodeNames</TT
1443
HREF="x78.html#ICE.STRINGSEQ"
1446
>::Ice::StringSeq</SPAN
1450
>getAllNodeNames</TT
1462
> nodes currently registered.</P
1472
> The node names.</P
1480
NAME="ICEGRID.ADMIN.GETALLOBJECTINFOS"
1483
>getAllObjectInfos</TT
1495
HREF="x8111.html#ICEGRID.OBJECTINFOSEQ"
1498
>ObjectInfoSeq</SPAN
1502
>getAllObjectInfos</TT
1516
>Get the object info of all the registered objects whose stringified
1517
identities match the given expression.</P
1529
CLASS="VARIABLELIST"
1540
> The expression to match against the stringified
1541
identities of registered objects. The expression may contain
1542
a trailing wildcard (<TT
1559
> All the object infos with a stringified identity
1560
matching the given expression.</P
1568
NAME="ICEGRID.ADMIN.GETALLSERVERIDS"
1571
>getAllServerIds</TT
1583
HREF="x78.html#ICE.STRINGSEQ"
1586
>::Ice::StringSeq</SPAN
1590
>getAllServerIds</TT
1596
>Get all the server ids registered with <SPAN
1612
> The server ids.</P
1620
NAME="ICEGRID.ADMIN.GETAPPLICATIONDESCRIPTOR"
1623
>getApplicationDescriptor</TT
1638
>ApplicationDescriptor</CODE
1642
>getApplicationDescriptor</TT
1657
>ApplicationNotExistException</CODE
1664
>Get an application descriptor.</P
1676
CLASS="VARIABLELIST"
1687
> The application name.</P
1701
> s The application descriptor.</P
1714
CLASS="VARIABLELIST"
1721
>ApplicationNotExistException</CODE
1726
> Raised if the application
1738
NAME="CEGRID.ADMIN.GETDEFAULTAPPLICATIONDESCRIPTOR"
1741
>getDefaultApplicationDescriptor</TT
1756
>ApplicationDescriptor</CODE
1760
>getDefaultApplicationDescriptor</TT
1767
>DeploymentException</CODE
1774
>Get the default application descriptor.</P
1781
NAME="ICEGRID.ADMIN.GETNODEHOSTNAME"
1784
>getNodeHostname</TT
1800
>getNodeHostname</TT
1815
>NodeNotExistException</CODE
1822
>NodeUnreachableException</CODE
1829
>Get the hostname of this node.</P
1841
CLASS="VARIABLELIST"
1868
CLASS="VARIABLELIST"
1875
>NodeNotExistException</CODE
1880
> Raised if the node doesn't exist.</P
1887
>NodeUnreachableException</CODE
1892
> Raised if the node could not be
1904
NAME="ICEGRID.ADMIN.GETNODEINFO"
1941
>NodeNotExistException</CODE
1948
>NodeUnreachableException</CODE
1955
>Get the node information for the node with the given name.</P
1967
CLASS="VARIABLELIST"
1992
> The node information.</P
2005
CLASS="VARIABLELIST"
2012
>NodeNotExistException</CODE
2017
> Raised if the node doesn't exist.</P
2024
>NodeUnreachableException</CODE
2029
> Raised if the node could not be
2041
NAME="ICEGRID.ADMIN.GETNODELOAD"
2079
>NodeNotExistException</CODE
2086
>NodeUnreachableException</CODE
2093
>Get the load averages of the node.</P
2105
CLASS="VARIABLELIST"
2130
> The node load information.</P
2143
CLASS="VARIABLELIST"
2150
>NodeNotExistException</CODE
2155
> Raised if the node doesn't exist.</P
2162
>NodeUnreachableException</CODE
2167
> Raised if the node could not be
2179
NAME="ICEGRID.ADMIN.GETOBJECTINFO"
2206
>::Ice::Identity</CODE
2219
>ObjectNotRegisteredException</CODE
2226
>Get the object info for the object with the given identity.</P
2238
CLASS="VARIABLELIST"
2249
> The identity of the object.</P
2263
> The object info.</P
2276
CLASS="VARIABLELIST"
2283
>ObjectNotRegisteredException</CODE
2288
> Raised if the object doesn't
2300
NAME="ICEGRID.ADMIN.GETSERVERINFO"
2337
>ServerNotExistException</CODE
2344
>Get the server information for the server with the given id.</P
2356
CLASS="VARIABLELIST"
2381
> s The server information.</P
2394
CLASS="VARIABLELIST"
2401
>ServerNotExistException</CODE
2406
> Raised if the server doesn't exist.</P
2417
NAME="ICEGRID.ADMIN.GETSERVERPID"
2451
>ServerNotExistException</CODE
2458
>NodeUnreachableException</CODE
2465
>Get a server's system process id. The process id is operating
2466
system dependent.</P
2478
CLASS="VARIABLELIST"
2503
> The server's process id.</P
2516
CLASS="VARIABLELIST"
2523
>ServerNotExistException</CODE
2528
> Raised if the server doesn't exist.</P
2535
>NodeUnreachableException</CODE
2540
> Raised if the node could not be
2552
NAME="ICEGRID.ADMIN.GETSERVERSTATE"
2589
>ServerNotExistException</CODE
2596
>NodeUnreachableException</CODE
2603
>Get a server's state.</P
2615
CLASS="VARIABLELIST"
2640
> The server state.</P
2653
CLASS="VARIABLELIST"
2660
>ServerNotExistException</CODE
2665
> Raised if the server doesn't exist.</P
2672
>NodeUnreachableException</CODE
2677
> Raised if the node could not be
2689
NAME="ICEGRID.ADMIN.GETSLICECHECKSUMS"
2692
>getSliceChecksums</TT
2704
HREF="x78.html#ICE.SLICECHECKSUMDICT"
2707
>::Ice::SliceChecksumDict</SPAN
2711
>getSliceChecksums</TT
2717
>Returns the checksums for the IceGrid Slice definitions.</P
2727
> A dictionary mapping Slice type ids to their checksums.</P
2735
NAME="ICEGRID.ADMIN.INSTANTIATESERVER"
2738
>instantiateServer</TT
2754
>instantiateServer</TT
2777
>ServerInstanceDescriptor</CODE
2790
>ApplicationNotExistException</CODE
2797
>DeploymentException</CODE
2804
>Instantiate a server template from an application.</P
2811
NAME="ICEGRID.ADMIN.ISSERVERENABLED"
2814
>isServerEnabled</TT
2830
>isServerEnabled</TT
2845
>ServerNotExistException</CODE
2852
>NodeUnreachableException</CODE
2859
>Check if the server is enabled or disabled.</P
2871
CLASS="VARIABLELIST"
2898
CLASS="VARIABLELIST"
2905
>ServerNotExistException</CODE
2910
> Raised if the server doesn't
2918
>NodeUnreachableException</CODE
2923
> Raised if the node could not
2935
NAME="ICEGRID.ADMIN.PATCHAPPLICATION"
2938
>patchApplication</TT
2955
>patchApplication</TT
2979
>ApplicationNotExistException</CODE
2986
>PatchException</CODE
2993
>Patch the given application data. If the patch argument is an
2994
empty string, all of the application's servers that depend on patch
2995
data will be patched.</P
3007
CLASS="VARIABLELIST"
3018
> The application name.</P
3029
> If true, the servers depending on the data to
3030
patch will be shutdown if necessary.</P
3046
CLASS="VARIABLELIST"
3053
>PatchException</CODE
3058
> Raised if the patch failed.</P
3065
>ApplicationNotExistException</CODE
3070
> Raised if the application
3082
NAME="ICEGRID.ADMIN.PATCHSERVER"
3126
>ServerNotExistException</CODE
3133
>NodeUnreachableException</CODE
3140
>PatchException</CODE
3159
CLASS="VARIABLELIST"
3181
> If true, servers depending on the data to patch
3182
will be shutdown if necessary.</P
3198
CLASS="VARIABLELIST"
3205
>ServerNotExistException</CODE
3210
> Raised if the server doesn't
3218
>NodeUnreachableException</CODE
3223
> Raised if the node could not be
3231
>PatchException</CODE
3236
> Raised if the patch failed.</P
3247
NAME="ICEGRID.ADMIN.PINGNODE"
3281
>NodeNotExistException</CODE
3294
> node to see if it is active.</P
3306
CLASS="VARIABLELIST"
3331
> true if the node ping succeeded, false otherwise.</P
3344
CLASS="VARIABLELIST"
3351
>NodeNotExistException</CODE
3356
> Raised if the node doesn't exist.</P
3367
NAME="ICEGRID.ADMIN.REMOVEADAPTER"
3401
>AdapterNotExistException</CODE
3408
>DeploymentException</CODE
3415
>Remove the adapter with the given id.</P
3427
CLASS="VARIABLELIST"
3434
>AdapterNotExistException</CODE
3439
> Raised if the adapter doesn't
3451
NAME="ICEGRID.ADMIN.REMOVEAPPLICATION"
3454
>removeApplication</TT
3470
>removeApplication</TT
3485
>ApplicationNotExistException</CODE
3492
>Remove an application from <SPAN
3510
CLASS="VARIABLELIST"
3521
> The application name.</P
3537
CLASS="VARIABLELIST"
3544
>ApplicationNotExistException</CODE
3549
> Raised if the application
3561
NAME="ICEGRID.ADMIN.REMOVEOBJECT"
3585
>::Ice::Identity</CODE
3598
>ObjectNotRegisteredException</CODE
3605
>DeploymentException</CODE
3612
>Remove an object from the object registry.</P
3624
CLASS="VARIABLELIST"
3635
> The identity of the object to be removed from the
3652
CLASS="VARIABLELIST"
3659
>ObjectNotRegisteredException</CODE
3664
> Raised if the object doesn't
3676
NAME="ICEGRID.ADMIN.SENDSIGNAL"
3719
>ServerNotExistException</CODE
3726
>NodeUnreachableException</CODE
3733
>BadSignalException</CODE
3740
>Send signal to a server.</P
3752
CLASS="VARIABLELIST"
3774
> The signal, for example SIGTERM or 15.</P
3790
CLASS="VARIABLELIST"
3797
>ServerNotExistException</CODE
3802
> Raised if the server doesn't
3810
>NodeUnreachableException</CODE
3815
> Raised if the node could not be
3823
>BadSignalException</CODE
3828
> Raised if the signal is not recognized
3829
by the target server.</P
3840
NAME="ICEGRID.ADMIN.SHUTDOWN"
3865
>Shut down the <SPAN
3878
NAME="ICEGRID.ADMIN.SHUTDOWNNODE"
3913
>NodeNotExistException</CODE
3920
>NodeUnreachableException</CODE
3945
CLASS="VARIABLELIST"
3972
CLASS="VARIABLELIST"
3979
>NodeNotExistException</CODE
3984
> Raised if the node doesn't exist.</P
3991
>NodeUnreachableException</CODE
3996
> Raised if the node could not be
4008
NAME="ICEGRID.ADMIN.STARTSERVER"
4043
>ServerNotExistException</CODE
4050
>ServerStartException</CODE
4057
>NodeUnreachableException</CODE
4064
>Start a server and wait for its activation.</P
4076
CLASS="VARIABLELIST"
4101
> True if the server was successfully started, false
4115
CLASS="VARIABLELIST"
4122
>ServerNotExistException</CODE
4127
> Raised if the server doesn't
4135
>NodeUnreachableException</CODE
4140
> Raised if the node could not be
4152
NAME="ICEGRID.ADMIN.STOPSERVER"
4187
>ServerNotExistException</CODE
4194
>NodeUnreachableException</CODE
4213
CLASS="VARIABLELIST"
4240
CLASS="VARIABLELIST"
4247
>ServerNotExistException</CODE
4252
> Raised if the server doesn't
4260
>NodeUnreachableException</CODE
4265
> Raised if the node could not be
4277
NAME="ICEGRID.ADMIN.SYNCAPPLICATION"
4280
>syncApplication</TT
4296
>syncApplication</TT
4301
>ApplicationDescriptor</CODE
4314
>DeploymentException</CODE
4321
>ApplicationNotExistException</CODE
4328
>Synchronize a deployed application with the given application
4329
descriptor. This operation will replace the current descriptor
4330
with this new descriptor.</P
4342
CLASS="VARIABLELIST"
4353
> The application descriptor.</P
4369
CLASS="VARIABLELIST"
4376
>DeploymentException</CODE
4381
> Raised if application deployment
4389
>ApplicationNotExistException</CODE
4394
> Raised if the application
4406
NAME="ICEGRID.ADMIN.UPDATEAPPLICATION"
4409
>updateApplication</TT
4425
>updateApplication</TT
4430
>ApplicationUpdateDescriptor</CODE
4443
>DeploymentException</CODE
4450
>ApplicationNotExistException</CODE
4457
>Update a deployed application with the given update application
4470
CLASS="VARIABLELIST"
4481
> The update descriptor.</P
4497
CLASS="VARIABLELIST"
4504
>DeploymentException</CODE
4509
> Raised if application deployment
4517
>ApplicationNotExistException</CODE
4522
> Raised if the application
4534
NAME="ICEGRID.ADMIN.UPDATEOBJECT"
4568
>ObjectNotRegisteredException</CODE
4575
>DeploymentException</CODE
4582
>Update an object in the object registry.</P
4594
CLASS="VARIABLELIST"
4605
> The object to be updated to the registry.</P
4621
CLASS="VARIABLELIST"
4628
>ObjectNotRegisteredException</CODE
4633
> Raised if the object doesn't
4645
NAME="ICEGRID.ADMIN.WRITEMESSAGE"
4697
>ServerNotExistException</CODE
4704
>NodeUnreachableException</CODE
4711
>Write message on server stdout or stderr.</P
4723
CLASS="VARIABLELIST"
4756
> 1 for stdout, 2 for stderr.</P
4772
CLASS="VARIABLELIST"
4779
>ServerNotExistException</CODE
4784
> Raised if the server doesn't
4792
>NodeUnreachableException</CODE
4797
> Raised if the node could not be
4810
SUMMARY="Footer navigation table"
4823
><<< Previous</A
4841
>Next >>></A
4851
>IceGrid::AdaptiveLoadBalancingPolicy</TT
4868
>IceGrid::ApplicationDescriptor</TT
b'\\ No newline at end of file'