Class AdminPrx

Provides administrative access to an IceGrid deployment.

Remarks

The Slice compiler generated this proxy class from Slice interface ::IceGrid::Admin.

Hierarchy (View Summary)

ObjectPrx
- AdminPrx

Index

Constructors

constructor

Methods

addApplication addObject addObjectWithType enableServer equals getAdapterInfo getAllAdapterIds getAllApplicationNames getAllNodeNames getAllObjectInfos getAllRegistryNames getAllServerIds getApplicationInfo getDefaultApplicationDescriptor getNodeAdmin getNodeHostname getNodeInfo getNodeLoad getNodeProcessorSocketCount getObjectInfo getObjectInfosByType getRegistryAdmin getRegistryInfo getServerAdmin getServerAdminCategory getServerInfo getServerPid getServerState ice_adapterId ice_batchOneway ice_connectionCached ice_connectionId ice_context ice_encodingVersion ice_endpoints ice_endpointSelection ice_facet ice_fixed ice_flushBatchRequests ice_getAdapterId ice_getCachedConnection ice_getCommunicator ice_getConnection ice_getConnectionId ice_getContext ice_getEncodingVersion ice_getEndpoints ice_getEndpointSelection ice_getFacet ice_getIdentity ice_getInvocationTimeout ice_getLocator ice_getLocatorCacheTimeout ice_getRouter ice_id ice_identity ice_ids ice_invocationTimeout ice_isA ice_isBatchOneway ice_isConnectionCached ice_isFixed ice_isOneway ice_isTwoway ice_locator ice_locatorCacheTimeout ice_oneway ice_ping ice_router ice_toString ice_twoway instantiateServer isServerEnabled pingNode pingRegistry removeAdapter removeApplication removeObject sendSignal shutdown shutdownNode shutdownRegistry startServer stopServer syncApplication syncApplicationWithoutRestart updateApplication updateApplicationWithoutRestart updateObject checkedCast ice_staticId uncheckedCast

Constructors

constructor

new AdminPrx(communicator: Communicator, proxyString: string): AdminPrx
Constructs a new AdminPrx proxy.
Parameters
- communicator: Communicator
  The communicator for the new proxy.
- proxyString: string
  The string representation of the proxy.
Returns AdminPrx
The new AdminPrx proxy.

Throws
ParseException - Thrown if the proxyString is not a valid proxy string.

Overrides ObjectPrx.constructor

Methods

addApplication

addApplication(
descriptor: ApplicationDescriptor,
context?: Map<string, string>,
): AsyncResult<void>
Adds an application to IceGrid.
Parameters
- descriptor: ApplicationDescriptor
  The application descriptor.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

addObject

addObject(obj: ObjectPrx, context?: Map<string, string>): AsyncResult<void>
Adds an object to the object registry. IceGrid gets the object type by calling ice_id on obj. The object must be reachable.
Parameters
- obj: ObjectPrx
  A proxy to the object. This proxy is never null.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.DeploymentException Thrown when the object can't be added.

Throws
IceGrid.ObjectExistsException Thrown when the object is already registered.

addObjectWithType

addObjectWithType(
    obj: ObjectPrx,
    type: string,
    context?: Map<string, string>,
): AsyncResult<void>
Adds an object to the object registry and explicitly specifies its type.
Parameters
- obj: ObjectPrx
  The object to be added to the registry. The proxy is never null.
- type: string
  The type name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

Throws
IceGrid.ObjectExistsException Thrown when the object is already registered.

enableServer

enableServer(
    id: string,
    enabled: boolean,
    context?: Map<string, string>,
): AsyncResult<void>
Enables or disables a server. A disabled server can't be started on demand or administratively. The enable state of the server is not persistent: if the node is shut down and restarted, the server will be enabled by default.
Parameters
- id: string
  The server ID.
- enabled: boolean
  true to enable the server, false to disable it.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

equals

equals(other: ObjectPrx): boolean
Checks whether the specified object is equal to this object.
Parameters
- other: ObjectPrx
  The object to compare with.
Returns boolean
true if the specified object is equal to this object, false otherwise.

Inherited from ObjectPrx.equals

getAdapterInfo

getAdapterInfo(
id: string,
context?: Map<string, string>,
): AsyncResult<AdapterInfo[]>
Gets adapter information for the replica group or adapter with the given ID.
Parameters
- id: string
  The adapter or replica group ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<AdapterInfo[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.AdapterInfo[] : A sequence of AdapterInfo. If id refers to an adapter, this sequence contains a single element. If id refers to a replica group, this sequence contains adapter information for each member of the replica group.
Throws
IceGrid.AdapterNotExistException Thrown when the adapter or replica group doesn't exist.

getAllAdapterIds

getAllAdapterIds(context?: Map<string, string>): AsyncResult<string[]>
Gets the IDs of all adapters registered with IceGrid.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<string[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- string[] : The adapter IDs.

getAllApplicationNames

getAllApplicationNames(context?: Map<string, string>): AsyncResult<string[]>
Gets all the IceGrid applications currently registered.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<string[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- string[] : The application names.

getAllNodeNames

getAllNodeNames(context?: Map<string, string>): AsyncResult<string[]>
Gets the names of all IceGrid nodes currently registered.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<string[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- string[] : The node names.

getAllObjectInfos

getAllObjectInfos(
expr: string,
context?: Map<string, string>,
): AsyncResult<ObjectInfo[]>
Gets the object info of all the registered objects whose stringified identities match the given expression.
Parameters
- expr: string
  The expression to match against the stringified identities of registered objects. The expression may contain a trailing wildcard (*) character.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectInfo[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.ObjectInfo[] : All the object infos with a stringified identity matching the given expression.

getAllRegistryNames

getAllRegistryNames(context?: Map<string, string>): AsyncResult<string[]>
Gets the names of all the IceGrid registries currently registered.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<string[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- string[] : The registry names.

getAllServerIds

getAllServerIds(context?: Map<string, string>): AsyncResult<string[]>
Gets the IDs of all the servers registered with IceGrid.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<string[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- string[] : The server IDs.

getApplicationInfo

getApplicationInfo(
name: string,
context?: Map<string, string>,
): AsyncResult<ApplicationInfo>
Gets an application descriptor.
Parameters
- name: string
  The application name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ApplicationInfo>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.ApplicationInfo : The application descriptor.
Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

getDefaultApplicationDescriptor

getDefaultApplicationDescriptor(
context?: Map<string, string>,
): AsyncResult<ApplicationDescriptor>
Gets the default application descriptor.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ApplicationDescriptor>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.ApplicationDescriptor : The default application descriptor.
Throws
IceGrid.DeploymentException Thrown when the default application descriptor is invalid or unreachable.

getNodeAdmin

getNodeAdmin(
name: string,
context?: Map<string, string>,
): AsyncResult<ObjectPrx>
Gets a proxy to the admin object of an IceGrid node.
Parameters
- name: string
  The IceGrid node name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectPrx>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- Ice.ObjectPrx | null : A proxy to the IceGrid node's admin object. This proxy is never null.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

getNodeHostname

getNodeHostname(
name: string,
context?: Map<string, string>,
): AsyncResult<string>
Get the hostname of a node.
Parameters
- name: string
  The node name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<string>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- string : The node hostname.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

getNodeInfo

getNodeInfo(name: string, context?: Map<string, string>): AsyncResult<NodeInfo>
Gets the node information of a node.
Parameters
- name: string
  The node name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<NodeInfo>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.NodeInfo : The node information.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

getNodeLoad

getNodeLoad(name: string, context?: Map<string, string>): AsyncResult<LoadInfo>
Gets the load averages of a node.
Parameters
- name: string
  The node name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<LoadInfo>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.LoadInfo : The node load information.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

getNodeProcessorSocketCount

getNodeProcessorSocketCount(
name: string,
context?: Map<string, string>,
): AsyncResult<number>
Gets the number of physical processor sockets in the computer where an IceGrid node is deployed. Note that this operation returns 1 on operating systems where this can't be automatically determined and where the IceGrid.Node.ProcessorSocketCount property for the node is not set.
Parameters
- name: string
  The node name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<number>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- number : The number of processor sockets or 1 if the number of sockets can't be determined.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

getObjectInfo

getObjectInfo(
id: Identity,
context?: Map<string, string>,
): AsyncResult<ObjectInfo>
Gets the object info for the object.
Parameters
- id: Identity
  The identity of the object.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectInfo>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.ObjectInfo : The object info.
Throws
IceGrid.ObjectNotRegisteredException Thrown when the object isn't registered with the registry.

getObjectInfosByType

getObjectInfosByType(
type: string,
context?: Map<string, string>,
): AsyncResult<ObjectInfo[]>
Gets the object info of all the registered objects with a given type.
Parameters
- type: string
  The type name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectInfo[]>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.ObjectInfo[] : The object infos.

getRegistryAdmin

getRegistryAdmin(
name: string,
context?: Map<string, string>,
): AsyncResult<ObjectPrx>
Gets a proxy to the admin object of an IceGrid registry.
Parameters
- name: string
  The registry name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectPrx>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- Ice.ObjectPrx | null : A proxy to the admin object of an IceGrid registry. This proxy is never null.
Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

getRegistryInfo

getRegistryInfo(
name: string,
context?: Map<string, string>,
): AsyncResult<RegistryInfo>
Gets the registry information of an IceGrid registry.
Parameters
- name: string
  The registry name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<RegistryInfo>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.RegistryInfo : The registry information.
Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

Throws
IceGrid.RegistryUnreachableException Thrown when the registry is unreachable.

getServerAdmin

getServerAdmin(
id: string,
context?: Map<string, string>,
): AsyncResult<ObjectPrx>
Gets a proxy to the admin object of a server.
Parameters
- id: string
  The server ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ObjectPrx>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- Ice.ObjectPrx | null : A proxy to the admin object of the server. This proxy is never null.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

getServerAdminCategory

getServerAdminCategory(context?: Map<string, string>): AsyncResult<string>
Gets the category for server admin objects. You can manufacture a server admin proxy from the admin proxy by changing its identity: use the server ID as name and the returned category as category.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<string>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- string : The category for server admin objects.

getServerInfo

getServerInfo(
id: string,
context?: Map<string, string>,
): AsyncResult<ServerInfo>
Gets information about a server.
Parameters
- id: string
  The server ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ServerInfo>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.ServerInfo : The server information.
Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

getServerPid

getServerPid(id: string, context?: Map<string, string>): AsyncResult<number>
Gets the system process ID of a server. The process ID is operating system dependent.
Parameters
- id: string
  The server ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<number>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- number : The process ID.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

getServerState

getServerState(
id: string,
context?: Map<string, string>,
): AsyncResult<ServerState>
Gets the state of a server.
Parameters
- id: string
  The server ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<ServerState>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- IceGrid.ServerState : The server state.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

ice_adapterId

ice_adapterId(id: string): this
Creates a proxy that is identical to this proxy, except for the adapter ID.
Parameters
- id: string
  The adapter ID for the new proxy.
Returns this
A proxy with the new adapter ID.

Inherited from ObjectPrx.ice_adapterId

ice_batchOneway

ice_batchOneway(): this
Creates a proxy that is identical to this proxy, but uses batch oneway invocations.

Returns this
A proxy that uses batch oneway invocations.

Inherited from ObjectPrx.ice_batchOneway

ice_connectionCached

ice_connectionCached(cache: boolean): this
Creates a proxy that is identical to this proxy, except for connection caching.
Parameters
- cache: boolean
  true if the new proxy should cache connections, false otherwise.
Returns this
A proxy with the specified caching policy.

Inherited from ObjectPrx.ice_connectionCached

ice_connectionId

ice_connectionId(connectionId: string): this
Creates a proxy that is identical to this proxy, except for its connection ID.
Parameters
- connectionId: string
  The connection ID for the new proxy. An empty string removes the connection ID.
Returns this
A proxy with the specified connection ID.

Inherited from ObjectPrx.ice_connectionId

ice_context

ice_context(context: Map<string, string>): this
Creates a proxy that is identical to this proxy, except for the per-proxy context.
Parameters
- context: Map<string, string>
  The context for the new proxy.
Returns this
A proxy with the new per-proxy context.

Inherited from ObjectPrx.ice_context

ice_encodingVersion

ice_encodingVersion(version: EncodingVersion): this
Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
Parameters
- version: EncodingVersion
  The encoding version to use to marshal request parameters.
Returns this
A proxy with the specified encoding version.

Inherited from ObjectPrx.ice_encodingVersion

ice_endpoints

ice_endpoints(endpoints: Endpoint[]): this
Creates a proxy that is identical to this proxy, except for the endpoints.
Parameters
- endpoints: Endpoint[]
  The endpoints for the new proxy.
Returns this
A proxy with the new endpoints.

Inherited from ObjectPrx.ice_endpoints

ice_endpointSelection

ice_endpointSelection(type: EndpointSelectionType): this
Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
Parameters
- type: EndpointSelectionType
  The new endpoint selection policy.
Returns this
A proxy with the specified endpoint selection policy.

Inherited from ObjectPrx.ice_endpointSelection

ice_facet

ice_facet(facet: string): this
Creates a proxy that is identical to this proxy, except for the facet.
Parameters
- facet: string
  The facet for the new proxy.
Returns this
A proxy with the new facet.

Inherited from ObjectPrx.ice_facet

ice_fixed

ice_fixed(connection: Connection): this
Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
Parameters
- connection: Connection
  The fixed proxy connection.
Returns this
A fixed proxy bound to the given connection.

Inherited from ObjectPrx.ice_fixed

ice_flushBatchRequests

ice_flushBatchRequests(): AsyncResult<void>
Flushes any pending batched requests for this proxy.

Returns AsyncResult<void>
An asynchronous result that is resolved when the pending batched requests for this proxy are flushed.

Inherited from ObjectPrx.ice_flushBatchRequests

ice_getAdapterId

ice_getAdapterId(): string
Gets the adapter ID for this proxy.

Returns string
The adapter ID. If the proxy does not have an adapter ID, the return value is the empty string.

Inherited from ObjectPrx.ice_getAdapterId

ice_getCachedConnection

ice_getCachedConnection(): Connection
Gets the cached Connection for this proxy. If the proxy does not yet have an established connection, it does not attempt to create a connection.

Returns Connection
The cached connection for this proxy, or null if the proxy does not have an established connection.

Inherited from ObjectPrx.ice_getCachedConnection

ice_getCommunicator

ice_getCommunicator(): Communicator
Gets the communicator that created this proxy.

Returns Communicator
The communicator that created this proxy.

Inherited from ObjectPrx.ice_getCommunicator

ice_getConnection

ice_getConnection(): AsyncResult<Connection>
Gets the connection ID of this proxy.

Returns AsyncResult<Connection>
An asynchronous result that resolves to the connection used by this proxy.

Remarks
You can call this function to establish a connection or associate the proxy with an existing connection.

Inherited from ObjectPrx.ice_getConnection

ice_getConnectionId

ice_getConnectionId(): string
Gets the connection ID of this proxy.

Returns string
The connection ID.

Inherited from ObjectPrx.ice_getConnectionId

ice_getContext

ice_getContext(): Map<string, string>
Gets the per-proxy context for this proxy.

Returns Map<string, string>
The per-proxy context.

Inherited from ObjectPrx.ice_getContext

ice_getEncodingVersion

ice_getEncodingVersion(): EncodingVersion
Gets the encoding version used to marshal request parameters.

Returns EncodingVersion
The encoding version.

Inherited from ObjectPrx.ice_getEncodingVersion

ice_getEndpoints

ice_getEndpoints(): Endpoint[]
Gets the endpoints used by this proxy.

Returns Endpoint[]
The endpoints used by this proxy.

Inherited from ObjectPrx.ice_getEndpoints

ice_getEndpointSelection

ice_getEndpointSelection(): EndpointSelectionType
Gets the endpoint selection policy for this proxy (randomly or ordered).

Returns EndpointSelectionType
The endpoint selection policy.

Inherited from ObjectPrx.ice_getEndpointSelection

ice_getFacet

ice_getFacet(): string
Gets the facet for this proxy.

Returns string
The facet for this proxy. If the proxy uses the default facet, the return value is the empty string.

Inherited from ObjectPrx.ice_getFacet

ice_getIdentity

ice_getIdentity(): Identity
Gets the identity embedded in this proxy.

Returns Identity
The identity of the target object.

Inherited from ObjectPrx.ice_getIdentity

ice_getInvocationTimeout

ice_getInvocationTimeout(): number
Gets the invocation timeout of this proxy.

Returns number
The invocation timeout value.

Inherited from ObjectPrx.ice_getInvocationTimeout

ice_getLocator

ice_getLocator(): Ice.LocatorPrx
Gets the locator for this proxy.

Returns Ice.LocatorPrx
The locator for this proxy. If no locator is configured, the return value is null.

Inherited from ObjectPrx.ice_getLocator

ice_getLocatorCacheTimeout

ice_getLocatorCacheTimeout(): number
Gets the locator cache timeout of this proxy.

Returns number
The locator cache timeout value.

Inherited from ObjectPrx.ice_getLocatorCacheTimeout

ice_getRouter

ice_getRouter(): Ice.RouterPrx
Gets the router for this proxy.

Returns Ice.RouterPrx
The router for the proxy. If no router is configured for the proxy, the return value is null.

Inherited from ObjectPrx.ice_getRouter

ice_id

ice_id(context?: Map<string, string>): AsyncResult<string>
Gets the type ID of the most-derived Slice interface supported by this object.
Parameters
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<string>
An asynchronous result that resolves to the Slice type ID of the most-derived interface.

Inherited from ObjectPrx.ice_id

ice_identity

ice_identity(id: Identity): this
Creates a proxy that is identical to this proxy, except for the identity.
Parameters
- id: Identity
  The identity for the new proxy.
Returns this
A proxy with the new identity.

Inherited from ObjectPrx.ice_identity

ice_ids

ice_ids(context?: Map<string, string>): AsyncResult<string[]>
Gets the Slice interfaces supported by this object as a list of Slice type IDs.
Parameters
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<string[]>
An asynchronous result that resolves to an array of the Slice type IDs of the interfaces supported by this object, in alphabetical order

Inherited from ObjectPrx.ice_ids

ice_invocationTimeout

ice_invocationTimeout(timeout: number): this
Creates a proxy that is identical to this proxy, except for the invocation timeout.
Parameters
- timeout: number
  The new invocation timeout (in milliseconds).
Returns this
A proxy with the new timeout.

Inherited from ObjectPrx.ice_invocationTimeout

ice_isA

ice_isA(typeId: string, context?: Map<string, string>): AsyncResult<boolean>
Tests whether this object supports a specific Slice interface.
Parameters
- typeId: string
  The type ID of the Slice interface to test against.
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<boolean>
An asynchronous result that resolves to true if the target object implements the Slice interface specified by typeId or implements a derived interface, false otherwise.

Inherited from ObjectPrx.ice_isA

ice_isBatchOneway

ice_isBatchOneway(): boolean
Determines whether this proxy uses batch oneway invocations.

Returns boolean
true if this proxy uses batch oneway invocations, false otherwise.

Inherited from ObjectPrx.ice_isBatchOneway

ice_isConnectionCached

ice_isConnectionCached(): boolean
Determines whether this proxy caches connections.

Returns boolean
true if this proxy caches connections, false otherwise.

Inherited from ObjectPrx.ice_isConnectionCached

ice_isFixed

ice_isFixed(): boolean
Determines whether this proxy is a fixed proxy.

Returns boolean
true if this proxy is a fixed proxy, false otherwise.

Inherited from ObjectPrx.ice_isFixed

ice_isOneway

ice_isOneway(): boolean
Determines whether this proxy uses oneway invocations.

Returns boolean
true if this proxy uses oneway invocations, false otherwise.

Inherited from ObjectPrx.ice_isOneway

ice_isTwoway

ice_isTwoway(): boolean
Determines whether this proxy uses twoway invocations.

Returns boolean
true if this proxy uses twoway invocations, false otherwise.

Inherited from ObjectPrx.ice_isTwoway

ice_locator

ice_locator(locator: Ice.LocatorPrx): this
Creates a proxy that is identical to this proxy, except for the locator.
Parameters
- locator: Ice.LocatorPrx
  The locator for the new proxy.
Returns this
A proxy with the specified locator.

Inherited from ObjectPrx.ice_locator

ice_locatorCacheTimeout

ice_locatorCacheTimeout(timeout: number): this
Creates a proxy that is identical to this proxy, except for the locator cache timeout.
Parameters
- timeout: number
  The new locator cache timeout (in seconds).
Returns this
A proxy with the new timeout.

Inherited from ObjectPrx.ice_locatorCacheTimeout

ice_oneway

ice_oneway(): this
Creates a proxy that is identical to this proxy, but uses oneway invocations.

Returns this
A proxy that uses oneway invocations.

Inherited from ObjectPrx.ice_oneway

ice_ping

ice_ping(context?: Map<string, string>): AsyncResult<void>
Tests whether the target object of this proxy can be reached.
Parameters
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<void>
An asynchronous result that resolves when the ping operation completes.

Inherited from ObjectPrx.ice_ping

ice_router

ice_router(router: Ice.RouterPrx): this
Creates a proxy that is identical to this proxy, except for the router.
Parameters
- router: Ice.RouterPrx
  The router for the new proxy.
Returns this
A proxy with the specified router.

Inherited from ObjectPrx.ice_router

ice_toString

ice_toString(): string
Creates a stringified version of this proxy.

Returns string
A stringified proxy.

Inherited from ObjectPrx.ice_toString

ice_twoway

ice_twoway(): this
Creates a proxy that is identical to this proxy, but uses twoway invocations.

Returns this
A proxy that uses twoway invocations.

Inherited from ObjectPrx.ice_twoway

instantiateServer

instantiateServer(
    application: string,
    node: string,
    desc: ServerInstanceDescriptor,
    context?: Map<string, string>,
): AsyncResult<void>
Instantiates a server template.
Parameters
- application: string
  The application name.
- node: string
  The name of the node where the server will be deployed.
- desc: ServerInstanceDescriptor
  The descriptor of the server instance to deploy.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

isServerEnabled

isServerEnabled(id: string, context?: Map<string, string>): AsyncResult<boolean>
Checks if the server is enabled or disabled.
Parameters
- id: string
  The server ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<boolean>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- boolean : true if the server is enabled, false otherwise.
Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

pingNode

pingNode(name: string, context?: Map<string, string>): AsyncResult<boolean>
Pings an IceGrid node to see if it is active.
Parameters
- name: string
  The node name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<boolean>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- boolean : true if the node ping succeeded, false otherwise.
Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

pingRegistry

pingRegistry(name: string, context?: Map<string, string>): AsyncResult<boolean>
Pings an IceGrid registry to see if it is active.
Parameters
- name: string
  The registry name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<boolean>
An Ice.AsyncResult object representing the result of the invocation, which resolves to:
- boolean : true if the registry ping succeeded, false otherwise.
Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

removeAdapter

removeAdapter(id: string, context?: Map<string, string>): AsyncResult<void>
Removes the adapter with the given ID.
Parameters
- id: string
  The adapter ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AdapterNotExistException Thrown when the adapter doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

removeApplication

removeApplication(
name: string,
context?: Map<string, string>,
): AsyncResult<void>
Removes an application from IceGrid.
Parameters
- name: string
  The application name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

removeObject

removeObject(id: Identity, context?: Map<string, string>): AsyncResult<void>
Removes an object from the object registry. Only objects added with this interface can be removed with this operation. Objects added with deployment descriptors should be removed with the deployment mechanism.
Parameters
- id: Identity
  The identity of the object to remove.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.DeploymentException Thrown when the object can't be removed.

Throws
IceGrid.ObjectNotRegisteredException Thrown when the object isn't registered with the registry.

sendSignal

sendSignal(
    id: string,
    signal: string,
    context?: Map<string, string>,
): AsyncResult<void>
Sends a signal to a server.
Parameters
- id: string
  The server ID.
- signal: string
  The signal, for example SIGTERM or 15.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.BadSignalException Thrown when the signal is not recognized by the target server.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

shutdown

shutdown(context?: Map<string, string>): AsyncResult<void>
Shuts down the IceGrid registry.
Parameters
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

shutdownNode

shutdownNode(name: string, context?: Map<string, string>): AsyncResult<void>
Shuts down an IceGrid node.
Parameters
- name: string
  The node name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.NodeNotExistException Thrown when the node doesn't exist.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

shutdownRegistry

shutdownRegistry(name: string, context?: Map<string, string>): AsyncResult<void>
Shuts down an IceGrid registry.
Parameters
- name: string
  The registry name.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.RegistryNotExistException Thrown when the registry doesn't exist.

Throws
IceGrid.RegistryUnreachableException Thrown when the registry is unreachable.

startServer

startServer(id: string, context?: Map<string, string>): AsyncResult<void>
Starts a server and waits for its activation.
Parameters
- id: string
  The server id.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

Throws
IceGrid.ServerStartException Thrown when the server startup failed.

stopServer

stopServer(id: string, context?: Map<string, string>): AsyncResult<void>
Stops a server.
Parameters
- id: string
  The server ID.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.DeploymentException Thrown when the deployment of the server failed.

Throws
IceGrid.NodeUnreachableException Thrown when the node is unreachable.

Throws
IceGrid.ServerNotExistException Thrown when the server doesn't exist.

Throws
IceGrid.ServerStopException Thrown when the server stop failed.

syncApplication

syncApplication(
descriptor: ApplicationDescriptor,
context?: Map<string, string>,
): AsyncResult<void>
Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor.
Parameters
- descriptor: ApplicationDescriptor
  The new application descriptor.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

syncApplicationWithoutRestart

syncApplicationWithoutRestart(
descriptor: ApplicationDescriptor,
context?: Map<string, string>,
): AsyncResult<void>
Synchronizes a deployed application. This operation replaces the current descriptor with a new descriptor only if no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
Parameters
- descriptor: ApplicationDescriptor
  The application descriptor.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

updateApplication

updateApplication(
descriptor: ApplicationUpdateDescriptor,
context?: Map<string, string>,
): AsyncResult<void>
Updates a deployed application.
Parameters
- descriptor: ApplicationUpdateDescriptor
  The update descriptor.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

updateApplicationWithoutRestart

updateApplicationWithoutRestart(
descriptor: ApplicationUpdateDescriptor,
context?: Map<string, string>,
): AsyncResult<void>
Updates a deployed application. This operation succeeds only when no server restarts are necessary for the update of the application. If some servers need to be restarted, the synchronization is rejected with a DeploymentException.
Parameters
- descriptor: ApplicationUpdateDescriptor
  The update descriptor.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.AccessDeniedException Thrown when the session doesn't hold the exclusive lock or when another session is holding the lock.

Throws
IceGrid.ApplicationNotExistException Thrown when the application doesn't exist.

Throws
IceGrid.DeploymentException Thrown when the application deployment failed.

updateObject

updateObject(obj: ObjectPrx, context?: Map<string, string>): AsyncResult<void>
Updates an object in the object registry. Only objects added with this interface can be updated with this operation. Objects added with deployment descriptors should be updated with the deployment mechanism.
Parameters
- obj: ObjectPrx
  A proxy to the object. This proxy is never null.
- Optionalcontext: Map<string, string>
  The Context map to send with the invocation.
Returns AsyncResult<void>
An Ice.AsyncResult object representing the result of the invocation.

Throws
IceGrid.DeploymentException Thrown when the object can't be updated.

Throws
IceGrid.ObjectNotRegisteredException Thrown when the object isn't registered with the registry.

`Static`checkedCast

checkedCast(
    prx: ObjectPrx,
    facet?: string,
    context?: Map<string, string>,
): AsyncResult<AdminPrx>
Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
Parameters
- prx: ObjectPrx
  The source proxy.
- Optionalfacet: string
  An optional facet name.
- Optionalcontext: Map<string, string>
  The request context.
Returns AsyncResult<AdminPrx>
A proxy with the requested type and facet, or null if the target object does not support the requested type.

Overrides ObjectPrx.checkedCast

`Static`ice_staticId

ice_staticId(): string
Returns the Slice type ID associated with this type.

Returns string
The Slice type ID.

Inherited from ObjectPrx.ice_staticId

`Static`uncheckedCast

uncheckedCast(prx: ObjectPrx, facet?: string): AdminPrx
Creates a new proxy from an existing proxy.
Parameters
- prx: ObjectPrx
  The source proxy.
- Optionalfacet: string
  An optional facet name.
Returns AdminPrx
A new proxy with the requested type and facet, or null if the source proxy is null.

Overrides ObjectPrx.uncheckedCast
uncheckedCast(prx: ObjectPrx, facet?: string): AdminPrx
Creates a new proxy from an existing proxy.
Parameters
- prx: ObjectPrx
  The source proxy.
- Optionalfacet: string
  An optional facet name.
Returns AdminPrx
A new proxy with the requested type and facet, or null if the source proxy is null.

Overrides ObjectPrx.uncheckedCast

Class AdminPrx

Remarks

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AdminPrx

Throws

Methods

addApplication

Parameters

Returns AsyncResult<void>

Throws

Throws

addObject

Parameters

Returns AsyncResult<void>

Throws

Throws

addObjectWithType

Parameters

Returns AsyncResult<void>

Throws

Throws

enableServer

Parameters

Returns AsyncResult<void>

Throws

Throws

Throws

equals

Parameters

Returns boolean

getAdapterInfo

Parameters

Returns AsyncResult<AdapterInfo[]>

Throws

getAllAdapterIds

Parameters

Returns AsyncResult<string[]>

getAllApplicationNames

Parameters

Returns AsyncResult<string[]>

getAllNodeNames

Parameters

Returns AsyncResult<string[]>

getAllObjectInfos

Parameters

Returns AsyncResult<ObjectInfo[]>

getAllRegistryNames

Parameters

Returns AsyncResult<string[]>

getAllServerIds

Parameters

Returns AsyncResult<string[]>

getApplicationInfo

Parameters

Returns AsyncResult<ApplicationInfo>

Throws

getDefaultApplicationDescriptor

Parameters

Returns AsyncResult<ApplicationDescriptor>

Throws

getNodeAdmin

Parameters

Returns AsyncResult<ObjectPrx>

Throws

Throws

getNodeHostname

Parameters

Returns AsyncResult<string>

Throws

Throws

getNodeInfo

Parameters

Returns AsyncResult<NodeInfo>

Throws