Package com.zeroc.Ice

Interface ProcessPrx

All Superinterfaces:

ObjectPrx

public interface ProcessPrx
extends ObjectPrx

An administrative interface for process management. Managed servers must implement this interface.

A servant implementing this interface is a potential target for denial-of-service attacks, therefore proper security precautions should be taken. For example, the servant can use a UUID to make its identity harder to guess, and be registered in an object adapter with a secured endpoint.

Field Summary

Fields inherited from interface com.zeroc.Ice.ObjectPrx

ice_staticId, noExplicitContext

Method Summary

Modifier and Type	Method	Description
static ProcessPrx	checkedCast(ObjectPrx obj)	Contacts the remote server to verify that the object implements this type.
static ProcessPrx	checkedCast(ObjectPrx obj, String facet)	Contacts the remote server to verify that a facet of the object implements this type.
static ProcessPrx	checkedCast(ObjectPrx obj, String facet, Map<String,String> context)	Contacts the remote server to verify that a facet of the object implements this type.
static ProcessPrx	checkedCast(ObjectPrx obj, Map<String,String> context)	Contacts the remote server to verify that the object implements this type.
default ProcessPrx	ice_adapterId(String newAdapterId)	Returns a proxy that is identical to this proxy, except for the adapter ID.
default ProcessPrx	ice_batchDatagram()	Returns a proxy that is identical to this proxy, but uses batch datagram invocations.
default ProcessPrx	ice_batchOneway()	Returns a proxy that is identical to this proxy, but uses batch oneway invocations.
default ProcessPrx	ice_collocationOptimized(boolean b)	Returns a proxy that is identical to this proxy, except for collocation optimization.
default ProcessPrx	ice_compress(boolean co)	Returns a proxy that is identical to this proxy, except for compression.
default ProcessPrx	ice_connectionCached(boolean newCache)	Returns a proxy that is identical to this proxy, except for connection caching.
default ProcessPrx	ice_connectionId(String connectionId)	Returns a proxy that is identical to this proxy, except for its connection ID.
default ProcessPrx	ice_context(Map<String,String> newContext)	Returns a proxy that is identical to this proxy, except for the per-proxy context.
default ProcessPrx	ice_datagram()	Returns a proxy that is identical to this proxy, but uses datagram invocations.
default ProcessPrx	ice_encodingVersion(EncodingVersion e)	Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
default ProcessPrx	ice_endpoints(Endpoint[] newEndpoints)	Returns a proxy that is identical to this proxy, except for the endpoints.
default ProcessPrx	ice_endpointSelection(EndpointSelectionType newType)	Returns a proxy that is identical to this proxy, except for the endpoint selection policy.
default ProcessPrx	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 ProcessPrx	ice_invocationTimeout(int newTimeout)	Returns a proxy that is identical to this proxy, except for the invocation timeout.
default ProcessPrx	ice_locator(LocatorPrx locator)	Returns a proxy that is identical to this proxy, except for the locator.
default ProcessPrx	ice_locatorCacheTimeout(int newTimeout)	Returns a proxy that is identical to this proxy, except for the locator cache timeout.
default ProcessPrx	ice_oneway()	Returns a proxy that is identical to this proxy, but uses oneway invocations.
default ProcessPrx	ice_preferSecure(boolean b)	Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
default ProcessPrx	ice_router(RouterPrx router)	Returns a proxy that is identical to this proxy, except for the router.
default ProcessPrx	ice_secure(boolean b)	Returns a proxy that is identical to this proxy, except for how it selects endpoints.
static String	ice_staticId()	Returns the Slice type ID associated with this type.
default ProcessPrx	ice_timeout(int t)	Returns a proxy that is identical to this proxy, except for its connection timeout setting.
default ProcessPrx	ice_twoway()	Returns a proxy that is identical to this proxy, but uses twoway invocations.
default void	shutdown()	Initiate a graceful shut-down.
default void	shutdown(Map<String,String> context)	Initiate a graceful shut-down.
default CompletableFuture<Void>	shutdownAsync()	Initiate a graceful shut-down.
default CompletableFuture<Void>	shutdownAsync(Map<String,String> context)	Initiate a graceful shut-down.
static ProcessPrx	uncheckedCast(ObjectPrx obj)	Downcasts the given proxy to this type without contacting the remote server.
static ProcessPrx	uncheckedCast(ObjectPrx obj, String facet)	Downcasts the given proxy to this type without contacting the remote server.
default void	writeMessage(String message, int fd)	Write a message on the process' stdout or stderr.
default void	writeMessage(String message, int fd, Map<String,String> context)	Write a message on the process' stdout or stderr.
default CompletableFuture<Void>	writeMessageAsync(String message, int fd)	Write a message on the process' stdout or stderr.
default CompletableFuture<Void>	writeMessageAsync(String message, int fd, Map<String,String> context)	Write a message on the process' stdout or stderr.

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

Method Details

shutdown

default void shutdown()

Initiate a graceful shut-down.

See Also:

• Communicator.shutdown()

shutdown

default void shutdown(Map<String,String> context)

Initiate a graceful shut-down.

Parameters:

context - The Context map to send with the invocation.

See Also:

• Communicator.shutdown()

shutdownAsync

default CompletableFuture<Void> shutdownAsync()

Initiate a graceful shut-down.

Returns:

A future that will be completed when the invocation completes.

See Also:

• Communicator.shutdown()

shutdownAsync

default CompletableFuture<Void> shutdownAsync(Map<String,String> context)

Initiate a graceful shut-down.

Parameters:

context - The Context map to send with the invocation.

Returns:

A future that will be completed when the invocation completes.

See Also:

• Communicator.shutdown()

writeMessage

default void writeMessage(String message,
 int fd)

Write a message on the process' stdout or stderr.

Parameters:

message - The message.

fd - 1 for stdout, 2 for stderr.

writeMessage

default void writeMessage(String message,
 int fd,
 Map<String,String> context)

Write a message on the process' stdout or stderr.

Parameters:

message - The message.

fd - 1 for stdout, 2 for stderr.

context - The Context map to send with the invocation.

writeMessageAsync

default CompletableFuture<Void> writeMessageAsync(String message,
 int fd)

Write a message on the process' stdout or stderr.

Parameters:

message - The message.

fd - 1 for stdout, 2 for stderr.

Returns:

A future that will be completed when the invocation completes.

writeMessageAsync

default CompletableFuture<Void> writeMessageAsync(String message,
 int fd,
 Map<String,String> context)

Write a message on the process' stdout or stderr.

Parameters:

message - The message.

fd - 1 for stdout, 2 for stderr.

context - The Context map to send with the invocation.

Returns:

A future that will be completed when the invocation completes.

checkedCast

static ProcessPrx checkedCast(ObjectPrx obj)

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

static ProcessPrx checkedCast(ObjectPrx obj,
 Map<String,String> context)

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

static ProcessPrx checkedCast(ObjectPrx obj,
 String facet)

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

static ProcessPrx checkedCast(ObjectPrx obj,
 String facet,
 Map<String,String> context)

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

static ProcessPrx uncheckedCast(ObjectPrx obj)

Downcasts the given proxy to this type without contacting the remote server.

Parameters:

obj - The untyped proxy.

Returns:

A proxy for this type.

uncheckedCast

static ProcessPrx uncheckedCast(ObjectPrx obj,
 String facet)

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

default ProcessPrx ice_context(Map<String,String> newContext)

Returns a proxy that is identical to this proxy, except for the per-proxy context.

Specified by:

ice_context in interface ObjectPrx

Parameters:

newContext - The context for the new proxy.

Returns:

A proxy with the specified per-proxy context.

ice_adapterId

default ProcessPrx ice_adapterId(String newAdapterId)

Returns a proxy that is identical to this proxy, except for the adapter ID.

Specified by:

ice_adapterId in interface ObjectPrx

Parameters:

newAdapterId - The adapter ID for the new proxy.

Returns:

A proxy with the specified adapter ID.

ice_endpoints

default ProcessPrx ice_endpoints(Endpoint[] newEndpoints)

Returns a proxy that is identical to this proxy, except for the endpoints.

Specified by:

ice_endpoints in interface ObjectPrx

Parameters:

newEndpoints - The endpoints for the new proxy.

Returns:

A proxy with the specified endpoints.

ice_locatorCacheTimeout

default ProcessPrx ice_locatorCacheTimeout(int newTimeout)

Returns a proxy that is identical to this proxy, except for the locator cache timeout.

Specified by:

ice_locatorCacheTimeout in interface ObjectPrx

Parameters:

newTimeout - The new locator cache timeout (in seconds).

Returns:

A proxy with the specified locator cache timeout.

See Also:

• Locator

ice_invocationTimeout

default ProcessPrx ice_invocationTimeout(int newTimeout)

Returns a proxy that is identical to this proxy, except for the invocation timeout.

Specified by:

ice_invocationTimeout in interface ObjectPrx

Parameters:

newTimeout - The new invocation timeout (in milliseconds).

Returns:

A proxy with the specified invocation timeout.

ice_connectionCached

default ProcessPrx ice_connectionCached(boolean newCache)

Returns a proxy that is identical to this proxy, except for connection caching.

Specified by:

ice_connectionCached in interface ObjectPrx

Parameters:

newCache - true if the new proxy should cache connections; false otherwise.

Returns:

A proxy with the specified caching policy.

ice_endpointSelection

default ProcessPrx ice_endpointSelection(EndpointSelectionType newType)

Returns a proxy that is identical to this proxy, except for the endpoint selection policy.

Specified by:

ice_endpointSelection in interface ObjectPrx

Parameters:

newType - The new endpoint selection policy.

Returns:

A proxy with the specified endpoint selection policy.

See Also:

• EndpointSelectionType

ice_secure

default ProcessPrx ice_secure(boolean b)

Returns a proxy that is identical to this proxy, except for how it selects endpoints.

Specified by:

ice_secure in interface ObjectPrx

Parameters:

b - If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints.

Returns:

A proxy with the specified selection policy.

ice_encodingVersion

default ProcessPrx ice_encodingVersion(EncodingVersion e)

Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.

Specified by:

ice_encodingVersion in interface ObjectPrx

Parameters:

e - The encoding version to use to marshal request parameters.

Returns:

A proxy with the specified encoding version.

ice_preferSecure

default ProcessPrx ice_preferSecure(boolean b)

Returns a proxy that is identical to this proxy, except for its endpoint selection policy.

Specified by:

ice_preferSecure in interface ObjectPrx

Parameters:

b - If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones.

Returns:

A proxy with the specified selection policy.

ice_router

default ProcessPrx ice_router(RouterPrx router)

Returns a proxy that is identical to this proxy, except for the router.

Specified by:

ice_router in interface ObjectPrx

Parameters:

router - The router for the new proxy.

Returns:

A proxy with the specified router.

ice_locator

default ProcessPrx ice_locator(LocatorPrx locator)

Returns a proxy that is identical to this proxy, except for the locator.

Specified by:

ice_locator in interface ObjectPrx

Parameters:

locator - The locator for the new proxy.

Returns:

A proxy with the specified locator.

ice_collocationOptimized

default ProcessPrx ice_collocationOptimized(boolean b)

Returns a proxy that is identical to this proxy, except for collocation optimization.

Specified by:

ice_collocationOptimized in interface ObjectPrx

Parameters:

b - true if the new proxy enables collocation optimization; false otherwise.

Returns:

A proxy with the specified collocation optimization.

ice_twoway

default ProcessPrx ice_twoway()

Returns a proxy that is identical to this proxy, but uses twoway invocations.

Specified by:

ice_twoway in interface ObjectPrx

Returns:

A proxy that uses twoway invocations.

ice_oneway

default ProcessPrx ice_oneway()

Returns a proxy that is identical to this proxy, but uses oneway invocations.

Specified by:

ice_oneway in interface ObjectPrx

Returns:

A proxy that uses oneway invocations.

ice_batchOneway

default ProcessPrx ice_batchOneway()

Returns a proxy that is identical to this proxy, but uses batch oneway invocations.

Specified by:

ice_batchOneway in interface ObjectPrx

Returns:

A proxy that uses batch oneway invocations.

ice_datagram

default ProcessPrx ice_datagram()

Returns a proxy that is identical to this proxy, but uses datagram invocations.

Specified by:

ice_datagram in interface ObjectPrx

Returns:

A proxy that uses datagram invocations.

ice_batchDatagram

default ProcessPrx ice_batchDatagram()

Returns a proxy that is identical to this proxy, but uses batch datagram invocations.

Specified by:

ice_batchDatagram in interface ObjectPrx

Returns:

A proxy that uses batch datagram invocations.

ice_compress

default ProcessPrx ice_compress(boolean co)

Returns a proxy that is identical to this proxy, except for compression.

Specified by:

ice_compress in interface ObjectPrx

Parameters:

co - true enables compression for the new proxy; false disables compression.

Returns:

A proxy with the specified compression setting.

ice_timeout

default ProcessPrx ice_timeout(int t)

Returns a proxy that is identical to this proxy, except for its connection timeout setting.

Specified by:

ice_timeout in interface ObjectPrx

Parameters:

t - The connection timeout for the proxy in milliseconds.

Returns:

A proxy with the specified timeout.

ice_connectionId

default ProcessPrx ice_connectionId(String connectionId)

Returns a proxy that is identical to this proxy, except for its connection ID.

Specified by:

ice_connectionId in interface ObjectPrx

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

default ProcessPrx 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.

Specified by:

ice_fixed in interface ObjectPrx

Parameters:

connection - The fixed proxy connection.

Returns:

A fixed proxy bound to the given connection.

ice_staticId

static String ice_staticId()

Description copied from interface: ObjectPrx

Returns the Slice type ID associated with this type.

Returns:

The Slice type ID.