Package com.zeroc.IceGrid
Interface AdminSessionPrx
- All Superinterfaces:
ObjectPrx
,SessionPrx
Used by administrative clients to view,
update, and receive observer updates from the IceGrid
registry. Admin sessions are created either via the
Registry
object or via the registry admin SessionManager
object.- See Also:
-
Field Summary
Fields inherited from interface com.zeroc.Ice.ObjectPrx
ice_staticId, noExplicitContext
-
Method Summary
Modifier and TypeMethodDescriptionstatic AdminSessionPrx
checkedCast
(ObjectPrx obj) Contacts the remote server to verify that the object implements this type.static AdminSessionPrx
checkedCast
(ObjectPrx obj, String facet) Contacts the remote server to verify that a facet of the object implements this type.static AdminSessionPrx
Contacts the remote server to verify that a facet of the object implements this type.static AdminSessionPrx
checkedCast
(ObjectPrx obj, Map<String, String> context) Contacts the remote server to verify that the object implements this type.default void
Finish updating the registry and release the exclusive lock.default void
finishUpdate
(Map<String, String> context) Finish updating the registry and release the exclusive lock.default CompletableFuture<Void>
Finish updating the registry and release the exclusive lock.default CompletableFuture<Void>
finishUpdateAsync
(Map<String, String> context) Finish updating the registry and release the exclusive lock.default AdminPrx
getAdmin()
Get the admin interface.default AdminPrx
Get the admin interface.default CompletableFuture<AdminPrx>
Get the admin interface.default CompletableFuture<AdminPrx>
getAdminAsync
(Map<String, String> context) Get the admin interface.default ObjectPrx
Get a "template" proxy for admin callback objects.default ObjectPrx
getAdminCallbackTemplate
(Map<String, String> context) Get a "template" proxy for admin callback objects.default CompletableFuture<ObjectPrx>
Get a "template" proxy for admin callback objects.default CompletableFuture<ObjectPrx>
getAdminCallbackTemplateAsync
(Map<String, String> context) Get a "template" proxy for admin callback objects.default String
Get the name of the registry replica hosting this session.default String
getReplicaName
(Map<String, String> context) Get the name of the registry replica hosting this session.default CompletableFuture<String>
Get the name of the registry replica hosting this session.default CompletableFuture<String>
getReplicaNameAsync
(Map<String, String> context) Get the name of the registry replica hosting this session.default AdminSessionPrx
ice_adapterId
(String newAdapterId) Returns a proxy that is identical to this proxy, except for the adapter ID.default AdminSessionPrx
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.default AdminSessionPrx
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.default AdminSessionPrx
ice_collocationOptimized
(boolean b) Returns a proxy that is identical to this proxy, except for collocation optimization.default AdminSessionPrx
ice_compress
(boolean co) Returns a proxy that is identical to this proxy, except for compression.default AdminSessionPrx
ice_connectionCached
(boolean newCache) Returns a proxy that is identical to this proxy, except for connection caching.default AdminSessionPrx
ice_connectionId
(String connectionId) Returns a proxy that is identical to this proxy, except for its connection ID.default AdminSessionPrx
ice_context
(Map<String, String> newContext) Returns a proxy that is identical to this proxy, except for the per-proxy context.default AdminSessionPrx
Returns a proxy that is identical to this proxy, but uses datagram invocations.default AdminSessionPrx
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.default AdminSessionPrx
ice_endpoints
(Endpoint[] newEndpoints) Returns a proxy that is identical to this proxy, except for the endpoints.default AdminSessionPrx
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.default AdminSessionPrx
ice_fixed
(Connection connection) Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.default AdminSessionPrx
ice_invocationTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.default AdminSessionPrx
ice_locator
(LocatorPrx locator) Returns a proxy that is identical to this proxy, except for the locator.default AdminSessionPrx
ice_locatorCacheTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the locator cache timeout.default AdminSessionPrx
Returns a proxy that is identical to this proxy, but uses oneway invocations.default AdminSessionPrx
ice_preferSecure
(boolean b) Returns a proxy that is identical to this proxy, except for its endpoint selection policy.default AdminSessionPrx
ice_router
(RouterPrx router) Returns a proxy that is identical to this proxy, except for the router.default AdminSessionPrx
ice_secure
(boolean b) Returns a proxy that is identical to this proxy, except for how it selects endpoints.static String
Returns the Slice type ID associated with this type.default AdminSessionPrx
ice_timeout
(int t) Returns a proxy that is identical to this proxy, except for its connection timeout setting.default AdminSessionPrx
Returns a proxy that is identical to this proxy, but uses twoway invocations.default void
Keep the session alive.default void
Keep the session alive.default CompletableFuture<Void>
Keep the session alive.default CompletableFuture<Void>
keepAliveAsync
(Map<String, String> context) Keep the session alive.default FileIteratorPrx
openNodeStdErr
(String name, int count) Open the given node stderr file for reading.default FileIteratorPrx
openNodeStdErr
(String name, int count, Map<String, String> context) Open the given node stderr file for reading.default CompletableFuture<FileIteratorPrx>
openNodeStdErrAsync
(String name, int count) Open the given node stderr file for reading.default CompletableFuture<FileIteratorPrx>
openNodeStdErrAsync
(String name, int count, Map<String, String> context) Open the given node stderr file for reading.default FileIteratorPrx
openNodeStdOut
(String name, int count) Open the given node stdout file for reading.default FileIteratorPrx
openNodeStdOut
(String name, int count, Map<String, String> context) Open the given node stdout file for reading.default CompletableFuture<FileIteratorPrx>
openNodeStdOutAsync
(String name, int count) Open the given node stdout file for reading.default CompletableFuture<FileIteratorPrx>
openNodeStdOutAsync
(String name, int count, Map<String, String> context) Open the given node stdout file for reading.default FileIteratorPrx
openRegistryStdErr
(String name, int count) Open the given registry stderr file for reading.default FileIteratorPrx
openRegistryStdErr
(String name, int count, Map<String, String> context) Open the given registry stderr file for reading.default CompletableFuture<FileIteratorPrx>
openRegistryStdErrAsync
(String name, int count) Open the given registry stderr file for reading.default CompletableFuture<FileIteratorPrx>
openRegistryStdErrAsync
(String name, int count, Map<String, String> context) Open the given registry stderr file for reading.default FileIteratorPrx
openRegistryStdOut
(String name, int count) Open the given registry stdout file for reading.default FileIteratorPrx
openRegistryStdOut
(String name, int count, Map<String, String> context) Open the given registry stdout file for reading.default CompletableFuture<FileIteratorPrx>
openRegistryStdOutAsync
(String name, int count) Open the given registry stdout file for reading.default CompletableFuture<FileIteratorPrx>
openRegistryStdOutAsync
(String name, int count, Map<String, String> context) Open the given registry stdout file for reading.default FileIteratorPrx
openServerLog
(String id, String path, int count) Open the given server log file for reading.default FileIteratorPrx
Open the given server log file for reading.default CompletableFuture<FileIteratorPrx>
openServerLogAsync
(String id, String path, int count) Open the given server log file for reading.default CompletableFuture<FileIteratorPrx>
Open the given server log file for reading.default FileIteratorPrx
openServerStdErr
(String id, int count) Open the given server stderr file for reading.default FileIteratorPrx
openServerStdErr
(String id, int count, Map<String, String> context) Open the given server stderr file for reading.default CompletableFuture<FileIteratorPrx>
openServerStdErrAsync
(String id, int count) Open the given server stderr file for reading.default CompletableFuture<FileIteratorPrx>
openServerStdErrAsync
(String id, int count, Map<String, String> context) Open the given server stderr file for reading.default FileIteratorPrx
openServerStdOut
(String id, int count) Open the given server stdout file for reading.default FileIteratorPrx
openServerStdOut
(String id, int count, Map<String, String> context) Open the given server stdout file for reading.default CompletableFuture<FileIteratorPrx>
openServerStdOutAsync
(String id, int count) Open the given server stdout file for reading.default CompletableFuture<FileIteratorPrx>
openServerStdOutAsync
(String id, int count, Map<String, String> context) Open the given server stdout file for reading.default void
setObservers
(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs) Set the observer proxies that receive notifications when the state of the registry or nodes changes.default void
setObservers
(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs, Map<String, String> context) Set the observer proxies that receive notifications when the state of the registry or nodes changes.default CompletableFuture<Void>
setObserversAsync
(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs) Set the observer proxies that receive notifications when the state of the registry or nodes changes.default CompletableFuture<Void>
setObserversAsync
(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs, Map<String, String> context) Set the observer proxies that receive notifications when the state of the registry or nodes changes.default void
setObserversByIdentity
(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs) Set the observer identities that receive notifications the state of the registry or nodes changes.default void
setObserversByIdentity
(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs, Map<String, String> context) Set the observer identities that receive notifications the state of the registry or nodes changes.default CompletableFuture<Void>
setObserversByIdentityAsync
(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs) Set the observer identities that receive notifications the state of the registry or nodes changes.default CompletableFuture<Void>
setObserversByIdentityAsync
(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs, Map<String, String> context) Set the observer identities that receive notifications the state of the registry or nodes changes.default int
Acquires an exclusive lock to start updating the registry applications.default int
startUpdate
(Map<String, String> context) Acquires an exclusive lock to start updating the registry applications.default CompletableFuture<Integer>
Acquires an exclusive lock to start updating the registry applications.default CompletableFuture<Integer>
startUpdateAsync
(Map<String, String> context) Acquires an exclusive lock to start updating the registry applications.static AdminSessionPrx
uncheckedCast
(ObjectPrx obj) Downcasts the given proxy to this type without contacting the remote server.static AdminSessionPrx
uncheckedCast
(ObjectPrx obj, String facet) Downcasts the given proxy to this type without contacting the remote server.Methods inherited from interface com.zeroc.Ice.ObjectPrx
equals, ice_executor, ice_facet, ice_flushBatchRequests, ice_flushBatchRequestsAsync, ice_getAdapterId, ice_getCachedConnection, ice_getCommunicator, ice_getCompress, ice_getConnection, ice_getConnectionAsync, ice_getConnectionId, ice_getContext, ice_getEncodingVersion, ice_getEndpoints, ice_getEndpointSelection, ice_getFacet, ice_getIdentity, ice_getInvocationTimeout, ice_getLocator, ice_getLocatorCacheTimeout, ice_getRouter, ice_getTimeout, ice_id, ice_id, ice_idAsync, ice_idAsync, ice_identity, ice_ids, ice_ids, ice_idsAsync, ice_idsAsync, ice_invoke, ice_invoke, ice_invokeAsync, ice_invokeAsync, ice_isA, ice_isA, ice_isAAsync, ice_isAAsync, ice_isBatchDatagram, ice_isBatchOneway, ice_isCollocationOptimized, ice_isConnectionCached, ice_isDatagram, ice_isFixed, ice_isOneway, ice_isPreferSecure, ice_isSecure, ice_isTwoway, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync
Methods inherited from interface com.zeroc.Glacier2.SessionPrx
destroy, destroy, destroyAsync, destroyAsync
-
Method Details
-
keepAlive
default void keepAlive()Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session. -
keepAlive
Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.- Parameters:
context
- The Context map to send with the invocation.- See Also:
-
keepAliveAsync
Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.- Returns:
- A future that will be completed when the invocation completes.
- See Also:
-
keepAliveAsync
Keep the session alive. Clients should call this operation regularly to prevent the server from reaping the session.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
- See Also:
-
getAdmin
Get the admin interface. The admin object returned by this operation can only be accessed by the session.- Returns:
- The admin interface proxy.
-
getAdmin
Get the admin interface. The admin object returned by this operation can only be accessed by the session.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The admin interface proxy.
-
getAdminAsync
Get the admin interface. The admin object returned by this operation can only be accessed by the session.- Returns:
- The admin interface proxy.
-
getAdminAsync
Get the admin interface. The admin object returned by this operation can only be accessed by the session.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The admin interface proxy.
-
getAdminCallbackTemplate
Get a "template" proxy for admin callback objects. An Admin client uses this proxy to set the category of its callback objects, and the published endpoints of the object adapter hosting the admin callback objects.- Returns:
- A template proxy. The returned proxy is null when the Admin session was established using Glacier2.
-
getAdminCallbackTemplate
Get a "template" proxy for admin callback objects. An Admin client uses this proxy to set the category of its callback objects, and the published endpoints of the object adapter hosting the admin callback objects.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- A template proxy. The returned proxy is null when the Admin session was established using Glacier2.
-
getAdminCallbackTemplateAsync
Get a "template" proxy for admin callback objects. An Admin client uses this proxy to set the category of its callback objects, and the published endpoints of the object adapter hosting the admin callback objects.- Returns:
- A template proxy. The returned proxy is null when the Admin session was established using Glacier2.
-
getAdminCallbackTemplateAsync
Get a "template" proxy for admin callback objects. An Admin client uses this proxy to set the category of its callback objects, and the published endpoints of the object adapter hosting the admin callback objects.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- A template proxy. The returned proxy is null when the Admin session was established using Glacier2.
-
setObservers
default void setObservers(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs) throws ObserverAlreadyRegisteredException Set the observer proxies that receive notifications when the state of the registry or nodes changes.- Parameters:
registryObs
- The registry observer.nodeObs
- The node observer.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.- Throws:
ObserverAlreadyRegisteredException
- Raised if an observer is already registered with this registry.
-
setObservers
default void setObservers(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs, Map<String, String> context) throws ObserverAlreadyRegisteredExceptionSet the observer proxies that receive notifications when the state of the registry or nodes changes.- Parameters:
registryObs
- The registry observer.nodeObs
- The node observer.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.context
- The Context map to send with the invocation.- Throws:
ObserverAlreadyRegisteredException
- Raised if an observer is already registered with this registry.
-
setObserversAsync
default CompletableFuture<Void> setObserversAsync(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs) Set the observer proxies that receive notifications when the state of the registry or nodes changes.- Parameters:
registryObs
- The registry observer.nodeObs
- The node observer.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.- Returns:
- A future that will be completed when the invocation completes.
-
setObserversAsync
default CompletableFuture<Void> setObserversAsync(RegistryObserverPrx registryObs, NodeObserverPrx nodeObs, ApplicationObserverPrx appObs, AdapterObserverPrx adptObs, ObjectObserverPrx objObs, Map<String, String> context) Set the observer proxies that receive notifications when the state of the registry or nodes changes.- Parameters:
registryObs
- The registry observer.nodeObs
- The node observer.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
setObserversByIdentity
default void setObserversByIdentity(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs) throws ObserverAlreadyRegisteredException Set the observer identities that receive notifications the state of the registry or nodes changes. This operation should be used by clients that are using a bidirectional connection to communicate with the session.- Parameters:
registryObs
- The registry observer identity.nodeObs
- The node observer identity.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.- Throws:
ObserverAlreadyRegisteredException
- Raised if an observer is already registered with this registry.
-
setObserversByIdentity
default void setObserversByIdentity(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs, Map<String, String> context) throws ObserverAlreadyRegisteredExceptionSet the observer identities that receive notifications the state of the registry or nodes changes. This operation should be used by clients that are using a bidirectional connection to communicate with the session.- Parameters:
registryObs
- The registry observer identity.nodeObs
- The node observer identity.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.context
- The Context map to send with the invocation.- Throws:
ObserverAlreadyRegisteredException
- Raised if an observer is already registered with this registry.
-
setObserversByIdentityAsync
default CompletableFuture<Void> setObserversByIdentityAsync(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs) Set the observer identities that receive notifications the state of the registry or nodes changes. This operation should be used by clients that are using a bidirectional connection to communicate with the session.- Parameters:
registryObs
- The registry observer identity.nodeObs
- The node observer identity.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.- Returns:
- A future that will be completed when the invocation completes.
-
setObserversByIdentityAsync
default CompletableFuture<Void> setObserversByIdentityAsync(Identity registryObs, Identity nodeObs, Identity appObs, Identity adptObs, Identity objObs, Map<String, String> context) Set the observer identities that receive notifications the state of the registry or nodes changes. This operation should be used by clients that are using a bidirectional connection to communicate with the session.- Parameters:
registryObs
- The registry observer identity.nodeObs
- The node observer identity.appObs
- The application observer.adptObs
- The adapter observer.objObs
- The object observer.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
startUpdate
Acquires an exclusive lock to start updating the registry applications.- Returns:
- The current serial.
- Throws:
AccessDeniedException
- Raised if the exclusive lock can't be acquired. This might happen if the lock is currently acquired by another session.
-
startUpdate
Acquires an exclusive lock to start updating the registry applications.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The current serial.
- Throws:
AccessDeniedException
- Raised if the exclusive lock can't be acquired. This might happen if the lock is currently acquired by another session.
-
startUpdateAsync
Acquires an exclusive lock to start updating the registry applications.- Returns:
- The current serial.
-
startUpdateAsync
Acquires an exclusive lock to start updating the registry applications.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The current serial.
-
finishUpdate
Finish updating the registry and release the exclusive lock.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock.
-
finishUpdate
Finish updating the registry and release the exclusive lock.- Parameters:
context
- The Context map to send with the invocation.- Throws:
AccessDeniedException
- Raised if the session doesn't hold the exclusive lock.
-
finishUpdateAsync
Finish updating the registry and release the exclusive lock.- Returns:
- A future that will be completed when the invocation completes.
-
finishUpdateAsync
Finish updating the registry and release the exclusive lock.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
getReplicaName
Get the name of the registry replica hosting this session.- Returns:
- The replica name of the registry.
-
getReplicaName
Get the name of the registry replica hosting this session.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The replica name of the registry.
-
getReplicaNameAsync
Get the name of the registry replica hosting this session.- Returns:
- The replica name of the registry.
-
getReplicaNameAsync
Get the name of the registry replica hosting this session.- Parameters:
context
- The Context map to send with the invocation.- Returns:
- The replica name of the registry.
-
openServerLog
default FileIteratorPrx openServerLog(String id, String path, int count) throws DeploymentException, FileNotAvailableException, NodeUnreachableException, ServerNotExistException Open the given server log file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.path
- The path of the log file. A log file can be opened only if it's declared in the server or service deployment descriptor.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.FileNotAvailableException
- Raised if the file can't be read.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
openServerLog
default FileIteratorPrx openServerLog(String id, String path, int count, Map<String, String> context) throws DeploymentException, FileNotAvailableException, NodeUnreachableException, ServerNotExistExceptionOpen the given server log file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.path
- The path of the log file. A log file can be opened only if it's declared in the server or service deployment descriptor.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.FileNotAvailableException
- Raised if the file can't be read.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
openServerLogAsync
Open the given server log file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.path
- The path of the log file. A log file can be opened only if it's declared in the server or service deployment descriptor.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
-
openServerLogAsync
default CompletableFuture<FileIteratorPrx> openServerLogAsync(String id, String path, int count, Map<String, String> context) Open the given server log file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.path
- The path of the log file. A log file can be opened only if it's declared in the server or service deployment descriptor.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
-
openServerStdErr
default FileIteratorPrx openServerStdErr(String id, int count) throws DeploymentException, FileNotAvailableException, NodeUnreachableException, ServerNotExistException Open the given server stderr file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.FileNotAvailableException
- Raised if the file can't be read.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
openServerStdErr
default FileIteratorPrx openServerStdErr(String id, int count, Map<String, String> context) throws DeploymentException, FileNotAvailableException, NodeUnreachableException, ServerNotExistExceptionOpen the given server stderr file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.FileNotAvailableException
- Raised if the file can't be read.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
openServerStdErrAsync
Open the given server stderr file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
-
openServerStdErrAsync
default CompletableFuture<FileIteratorPrx> openServerStdErrAsync(String id, int count, Map<String, String> context) Open the given server stderr file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
-
openServerStdOut
default FileIteratorPrx openServerStdOut(String id, int count) throws DeploymentException, FileNotAvailableException, NodeUnreachableException, ServerNotExistException Open the given server stdout file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.FileNotAvailableException
- Raised if the file can't be read.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
openServerStdOut
default FileIteratorPrx openServerStdOut(String id, int count, Map<String, String> context) throws DeploymentException, FileNotAvailableException, NodeUnreachableException, ServerNotExistExceptionOpen the given server stdout file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
- Throws:
DeploymentException
- Raised if the server couldn't be deployed on the node.FileNotAvailableException
- Raised if the file can't be read.NodeUnreachableException
- Raised if the node could not be reached.ServerNotExistException
- Raised if the server doesn't exist.
-
openServerStdOutAsync
Open the given server stdout file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
-
openServerStdOutAsync
default CompletableFuture<FileIteratorPrx> openServerStdOutAsync(String id, int count, Map<String, String> context) Open the given server stdout file for reading. The file can be read with the returned file iterator.- Parameters:
id
- The server id.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
-
openNodeStdErr
default FileIteratorPrx openNodeStdErr(String name, int count) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableException Open the given node stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
openNodeStdErr
default FileIteratorPrx openNodeStdErr(String name, int count, Map<String, String> context) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableExceptionOpen the given node stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
openNodeStdErrAsync
Open the given node stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
-
openNodeStdErrAsync
default CompletableFuture<FileIteratorPrx> openNodeStdErrAsync(String name, int count, Map<String, String> context) Open the given node stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
-
openNodeStdOut
default FileIteratorPrx openNodeStdOut(String name, int count) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableException Open the given node stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
openNodeStdOut
default FileIteratorPrx openNodeStdOut(String name, int count, Map<String, String> context) throws FileNotAvailableException, NodeNotExistException, NodeUnreachableExceptionOpen the given node stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.NodeNotExistException
- Raised if the node doesn't exist.NodeUnreachableException
- Raised if the node could not be reached.
-
openNodeStdOutAsync
Open the given node stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
-
openNodeStdOutAsync
default CompletableFuture<FileIteratorPrx> openNodeStdOutAsync(String name, int count, Map<String, String> context) Open the given node stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The node name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
-
openRegistryStdErr
default FileIteratorPrx openRegistryStdErr(String name, int count) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableException Open the given registry stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
openRegistryStdErr
default FileIteratorPrx openRegistryStdErr(String name, int count, Map<String, String> context) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableExceptionOpen the given registry stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
openRegistryStdErrAsync
Open the given registry stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
-
openRegistryStdErrAsync
default CompletableFuture<FileIteratorPrx> openRegistryStdErrAsync(String name, int count, Map<String, String> context) Open the given registry stderr file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
-
openRegistryStdOut
default FileIteratorPrx openRegistryStdOut(String name, int count) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableException Open the given registry stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
openRegistryStdOut
default FileIteratorPrx openRegistryStdOut(String name, int count, Map<String, String> context) throws FileNotAvailableException, RegistryNotExistException, RegistryUnreachableExceptionOpen the given registry stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
- Throws:
FileNotAvailableException
- Raised if the file can't be read.RegistryNotExistException
- Raised if the registry doesn't exist.RegistryUnreachableException
- Raised if the registry could not be reached.
-
openRegistryStdOutAsync
Open the given registry stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.- Returns:
- An iterator to read the file.
-
openRegistryStdOutAsync
default CompletableFuture<FileIteratorPrx> openRegistryStdOutAsync(String name, int count, Map<String, String> context) Open the given registry stdout file for reading. The file can be read with the returned file iterator.- Parameters:
name
- The registry name.count
- Specifies where to start reading the file. If negative, the file is read from the begining. If 0 or positive, the file is read from the lastcount
lines.context
- The Context map to send with the invocation.- Returns:
- An iterator to read the file.
-
checkedCast
Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.context
- The Context map to send with the invocation.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.context
- The Context map to send with the invocation.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
uncheckedCast
Downcasts the given proxy to this type without contacting the remote server.- Parameters:
obj
- The untyped proxy.- Returns:
- A proxy for this type.
-
uncheckedCast
Downcasts the given proxy to this type without contacting the remote server.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.- Returns:
- A proxy for this type.
-
ice_context
Returns a proxy that is identical to this proxy, except for the per-proxy context.- Specified by:
ice_context
in interfaceObjectPrx
- Specified by:
ice_context
in interfaceSessionPrx
- Parameters:
newContext
- The context for the new proxy.- Returns:
- A proxy with the specified per-proxy context.
-
ice_adapterId
Returns a proxy that is identical to this proxy, except for the adapter ID.- Specified by:
ice_adapterId
in interfaceObjectPrx
- Specified by:
ice_adapterId
in interfaceSessionPrx
- Parameters:
newAdapterId
- The adapter ID for the new proxy.- Returns:
- A proxy with the specified adapter ID.
-
ice_endpoints
Returns a proxy that is identical to this proxy, except for the endpoints.- Specified by:
ice_endpoints
in interfaceObjectPrx
- Specified by:
ice_endpoints
in interfaceSessionPrx
- Parameters:
newEndpoints
- The endpoints for the new proxy.- Returns:
- A proxy with the specified endpoints.
-
ice_locatorCacheTimeout
Returns a proxy that is identical to this proxy, except for the locator cache timeout.- Specified by:
ice_locatorCacheTimeout
in interfaceObjectPrx
- Specified by:
ice_locatorCacheTimeout
in interfaceSessionPrx
- Parameters:
newTimeout
- The new locator cache timeout (in seconds).- Returns:
- A proxy with the specified locator cache timeout.
- See Also:
-
ice_invocationTimeout
Returns a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeout
in interfaceObjectPrx
- Specified by:
ice_invocationTimeout
in interfaceSessionPrx
- Parameters:
newTimeout
- The new invocation timeout (in seconds).- Returns:
- A proxy with the specified invocation timeout.
-
ice_connectionCached
Returns a proxy that is identical to this proxy, except for connection caching.- Specified by:
ice_connectionCached
in interfaceObjectPrx
- Specified by:
ice_connectionCached
in interfaceSessionPrx
- Parameters:
newCache
-true
if the new proxy should cache connections;false
otherwise.- Returns:
- A proxy with the specified caching policy.
-
ice_endpointSelection
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.- Specified by:
ice_endpointSelection
in interfaceObjectPrx
- Specified by:
ice_endpointSelection
in interfaceSessionPrx
- Parameters:
newType
- The new endpoint selection policy.- Returns:
- A proxy with the specified endpoint selection policy.
- See Also:
-
ice_secure
Returns a proxy that is identical to this proxy, except for how it selects endpoints.- Specified by:
ice_secure
in interfaceObjectPrx
- Specified by:
ice_secure
in interfaceSessionPrx
- Parameters:
b
- Ifb
istrue
, only endpoints that use a secure transport are used by the new proxy. Ifb
is false, the returned proxy uses both secure and insecure endpoints.- Returns:
- A proxy with the specified selection policy.
-
ice_encodingVersion
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.- Specified by:
ice_encodingVersion
in interfaceObjectPrx
- Specified by:
ice_encodingVersion
in interfaceSessionPrx
- Parameters:
e
- The encoding version to use to marshal request parameters.- Returns:
- A proxy with the specified encoding version.
-
ice_preferSecure
Returns a proxy that is identical to this proxy, except for its endpoint selection policy.- Specified by:
ice_preferSecure
in interfaceObjectPrx
- Specified by:
ice_preferSecure
in interfaceSessionPrx
- Parameters:
b
- Ifb
istrue
, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. Ifb
isfalse
, the proxy prefers insecure endpoints to secure ones.- Returns:
- A proxy with the specified selection policy.
-
ice_router
Returns a proxy that is identical to this proxy, except for the router.- Specified by:
ice_router
in interfaceObjectPrx
- Specified by:
ice_router
in interfaceSessionPrx
- Parameters:
router
- The router for the new proxy.- Returns:
- A proxy with the specified router.
-
ice_locator
Returns a proxy that is identical to this proxy, except for the locator.- Specified by:
ice_locator
in interfaceObjectPrx
- Specified by:
ice_locator
in interfaceSessionPrx
- Parameters:
locator
- The locator for the new proxy.- Returns:
- A proxy with the specified locator.
-
ice_collocationOptimized
Returns a proxy that is identical to this proxy, except for collocation optimization.- Specified by:
ice_collocationOptimized
in interfaceObjectPrx
- Specified by:
ice_collocationOptimized
in interfaceSessionPrx
- Parameters:
b
-true
if the new proxy enables collocation optimization;false
otherwise.- Returns:
- A proxy with the specified collocation optimization.
-
ice_twoway
Returns a proxy that is identical to this proxy, but uses twoway invocations.- Specified by:
ice_twoway
in interfaceObjectPrx
- Specified by:
ice_twoway
in interfaceSessionPrx
- Returns:
- A proxy that uses twoway invocations.
-
ice_oneway
Returns a proxy that is identical to this proxy, but uses oneway invocations.- Specified by:
ice_oneway
in interfaceObjectPrx
- Specified by:
ice_oneway
in interfaceSessionPrx
- Returns:
- A proxy that uses oneway invocations.
-
ice_batchOneway
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.- Specified by:
ice_batchOneway
in interfaceObjectPrx
- Specified by:
ice_batchOneway
in interfaceSessionPrx
- Returns:
- A proxy that uses batch oneway invocations.
-
ice_datagram
Returns a proxy that is identical to this proxy, but uses datagram invocations.- Specified by:
ice_datagram
in interfaceObjectPrx
- Specified by:
ice_datagram
in interfaceSessionPrx
- Returns:
- A proxy that uses datagram invocations.
-
ice_batchDatagram
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.- Specified by:
ice_batchDatagram
in interfaceObjectPrx
- Specified by:
ice_batchDatagram
in interfaceSessionPrx
- Returns:
- A proxy that uses batch datagram invocations.
-
ice_compress
Returns a proxy that is identical to this proxy, except for compression.- Specified by:
ice_compress
in interfaceObjectPrx
- Specified by:
ice_compress
in interfaceSessionPrx
- Parameters:
co
-true
enables compression for the new proxy;false
disables compression.- Returns:
- A proxy with the specified compression setting.
-
ice_timeout
Returns a proxy that is identical to this proxy, except for its connection timeout setting.- Specified by:
ice_timeout
in interfaceObjectPrx
- Specified by:
ice_timeout
in interfaceSessionPrx
- Parameters:
t
- The connection timeout for the proxy in milliseconds.- Returns:
- A proxy with the specified timeout.
-
ice_connectionId
Returns a proxy that is identical to this proxy, except for its connection ID.- Specified by:
ice_connectionId
in interfaceObjectPrx
- Specified by:
ice_connectionId
in interfaceSessionPrx
- Parameters:
connectionId
- The connection ID for the new proxy. An empty string removes the connection ID.- Returns:
- A proxy with the specified connection ID.
-
ice_fixed
Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.- Specified by:
ice_fixed
in interfaceObjectPrx
- Specified by:
ice_fixed
in interfaceSessionPrx
- Parameters:
connection
- The fixed proxy connection.- Returns:
- A fixed proxy bound to the given connection.
-
ice_staticId
Description copied from interface:ObjectPrx
Returns the Slice type ID associated with this type.- Returns:
- The Slice type ID.
-