Ice

Class Util

java.lang.Object

Ice.Util

public final class Util
extends java.lang.Object

Utility methods for the Ice run time.

Field Summary

Fields

Modifier and Type	Field and Description
static EncodingVersion	Encoding_1_0
static EncodingVersion	Encoding_1_1
static ProtocolVersion	Protocol_1_0

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static InputStream	createInputStream(Communicator communicator, byte[] bytes) Creates an input stream for dynamic invocation and dispatch.
static InputStream	createInputStream(Communicator communicator, byte[] bytes, EncodingVersion v) Creates an input stream for dynamic invocation and dispatch.
static OutputStream	createOutputStream(Communicator communicator) Creates an output stream for dynamic invocation and dispatch.
static OutputStream	createOutputStream(Communicator communicator, EncodingVersion v) Creates an output stream for dynamic invocation and dispatch.
static Properties	createProperties() Creates a new empty property set.
static Properties	createProperties(java.lang.String[] args) Creates a property set initialized from an argument vector.
static Properties	createProperties(java.lang.String[] args, Properties defaults) Creates a property set initialized from an argument vector.
static Properties	createProperties(StringSeqHolder args) Creates a property set initialized from an argument vector.
static Properties	createProperties(StringSeqHolder args, Properties defaults) Creates a property set initialized from an argument vector.
static EncodingVersion	currentEncoding() Returns the supported Ice encoding version.
static ProtocolVersion	currentProtocol() Returns the supported Ice protocol version.
static java.lang.String	encodingVersionToString(EncodingVersion v) Converts an encoding version to a string.
static Logger	getProcessLogger() Returns the process-wide logger.
static java.lang.String	identityToString(Identity ident) Converts an object identity to a string.
static Communicator	initialize() Creates a communicator using a default configuration.
static Communicator	initialize(InitializationData initData) Creates a communicator.
static Communicator	initialize(java.lang.String[] args) Creates a communicator.
static Communicator	initialize(java.lang.String[] args, InitializationData initData) Creates a communicator.
static Communicator	initialize(StringSeqHolder args) Creates a communicator.
static Communicator	initialize(StringSeqHolder args, InitializationData initData) Creates a communicator.
static int	intVersion() Returns the Ice version as an integer in the form A.BB.CC, where A indicates the major version, BB indicates the minor version, and CC indicates the patch level.
static java.lang.String	protocolVersionToString(ProtocolVersion v) Converts a protocol version to a string.
static int	proxyIdentityAndFacetCompare(ObjectPrx lhs, ObjectPrx rhs) Compares the object identities and facets of two proxies.
static int	proxyIdentityCompare(ObjectPrx lhs, ObjectPrx rhs) Compares the object identities of two proxies.
static void	setProcessLogger(Logger logger) Changes the process-wide logger.
static EncodingVersion	stringToEncodingVersion(java.lang.String version) Converts a string to an encoding version.
static Identity	stringToIdentity(java.lang.String s) Converts a string to an object identity.
static ProtocolVersion	stringToProtocolVersion(java.lang.String version) Converts a string to a protocol version.
static java.lang.String	stringVersion() Returns the Ice version in the form A.B.C, where A indicates the major version, B indicates the minor version, and C indicates the patch level.
static InputStream	wrapInputStream(Communicator communicator, byte[] bytes) Wraps encoded data with an input stream for dynamic invocation and dispatch.
static InputStream	wrapInputStream(Communicator communicator, byte[] bytes, EncodingVersion v) Wraps encoded data with an input stream for dynamic invocation and dispatch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Protocol_1_0

public static final ProtocolVersion Protocol_1_0

Encoding_1_0

public static final EncodingVersion Encoding_1_0

Encoding_1_1

public static final EncodingVersion Encoding_1_1

Constructor Detail

Util

public Util()

Method Detail

createProperties

public static Properties createProperties()

Creates a new empty property set.

Returns:

A new empty property set.

createProperties

public static Properties createProperties(StringSeqHolder args)

Creates a property set initialized from an argument vector.

Parameters:

args - A command-line argument vector, possibly containing options to set properties. If the command-line options include a --Ice.Config option, the corresponding configuration files are parsed. If the same property is set in a configuration file and in the argument vector, the argument vector takes precedence.

This method modifies the argument vector by removing any Ice-related options.

Returns:

A property set initialized with the property settings that were removed from args.

createProperties

public static Properties createProperties(StringSeqHolder args,
                                          Properties defaults)

Creates a property set initialized from an argument vector.

Parameters:

args - A command-line argument vector, possibly containing options to set properties. If the command-line options include a --Ice.Config option, the corresponding configuration files are parsed. If the same property is set in a configuration file and in the argument vector, the argument vector takes precedence.

This method modifies the argument vector by removing any Ice-related options.

defaults - Default values for the property set. Settings in configuration files and args override these defaults.

Returns:

An initalized property set.

createProperties

public static Properties createProperties(java.lang.String[] args)

Creates a property set initialized from an argument vector.

Parameters:

args - A command-line argument vector, possibly containing options to set properties. If the command-line options include a --Ice.Config option, the corresponding configuration files are parsed. If the same property is set in a configuration file and in the argument vector, the argument vector takes precedence.

Returns:

A property set initialized with the property settings in args.

createProperties

public static Properties createProperties(java.lang.String[] args,
                                          Properties defaults)

Creates a property set initialized from an argument vector.

Parameters:

args - A command-line argument vector, possibly containing options to set properties. If the command-line options include a --Ice.Config option, the corresponding configuration files are parsed. If the same property is set in a configuration file and in the argument vector, the argument vector takes precedence.

defaults - Default values for the property set. Settings in configuration files and args override these defaults.

Returns:

An initalized property set.

initialize

public static Communicator initialize(StringSeqHolder args)

Creates a communicator.

Parameters:

args - A command-line argument vector. Any Ice-related options in this vector are used to intialize the communicator. This method modifies the argument vector by removing any Ice-related options.

Returns:

The initialized communicator.

initialize

public static Communicator initialize(java.lang.String[] args)

Creates a communicator.

Parameters:

args - A command-line argument vector. Any Ice-related options in this vector are used to intialize the communicator.

Returns:

The initialized communicator.

initialize

public static Communicator initialize(StringSeqHolder args,
                                      InitializationData initData)

Creates a communicator.

Parameters:

args - A command-line argument vector. Any Ice-related options in this vector are used to intialize the communicator. This method modifies the argument vector by removing any Ice-related options.

initData - Additional intialization data. Property settings in args override property settings in initData.

Returns:

The initialized communicator.

See Also:

InitializationData

initialize

public static Communicator initialize(java.lang.String[] args,
                                      InitializationData initData)

Creates a communicator.

Parameters:

args - A command-line argument vector. Any Ice-related options in this vector are used to intialize the communicator.

initData - Additional intialization data. Property settings in args override property settings in initData.

Returns:

The initialized communicator.

See Also:

InitializationData

initialize

public static Communicator initialize(InitializationData initData)

Creates a communicator.

Parameters:

initData - Additional intialization data.

Returns:

The initialized communicator.

See Also:

InitializationData

initialize

public static Communicator initialize()

Creates a communicator using a default configuration.

Returns:

The initialized communicator.

stringToIdentity

public static Identity stringToIdentity(java.lang.String s)

Converts a string to an object identity.

Parameters:

s - The string to convert.

Returns:

The converted object identity.

identityToString

public static java.lang.String identityToString(Identity ident)

Converts an object identity to a string.

Parameters:

ident - The object identity to convert.

Returns:

The string representation of the object identity.

proxyIdentityCompare

public static int proxyIdentityCompare(ObjectPrx lhs,
                                       ObjectPrx rhs)

Compares the object identities of two proxies.

Parameters:

lhs - A proxy.

rhs - A proxy.

Returns:

-1 if the identity in lhs compares less than the identity in rhs; 0 if the identities compare equal; 1, otherwise.

See Also:

ProxyIdentityKey, ProxyIdentityFacetKey, proxyIdentityAndFacetCompare(Ice.ObjectPrx, Ice.ObjectPrx)

proxyIdentityAndFacetCompare

public static int proxyIdentityAndFacetCompare(ObjectPrx lhs,
                                               ObjectPrx rhs)

Compares the object identities and facets of two proxies.

Parameters:

lhs - A proxy.

rhs - A proxy.

Returns:

-1 if the identity and facet in lhs compare less than the identity and facet in rhs; 0 if the identities and facets compare equal; 1, otherwise.

See Also:

ProxyIdentityFacetKey, ProxyIdentityKey, proxyIdentityCompare(Ice.ObjectPrx, Ice.ObjectPrx)

createInputStream

public static InputStream createInputStream(Communicator communicator,
                                            byte[] bytes)

Creates an input stream for dynamic invocation and dispatch. The stream uses the communicator's default encoding version.

Parameters:

communicator - The communicator for the stream.

bytes - An encoded request or reply.

Returns:

The input stream.

createInputStream

public static InputStream createInputStream(Communicator communicator,
                                            byte[] bytes,
                                            EncodingVersion v)

Creates an input stream for dynamic invocation and dispatch. The stream uses the given encoding version.

Parameters:

communicator - The communicator for the stream.

bytes - An encoded request or reply.

v - The desired encoding version.

Returns:

The input stream.

wrapInputStream

public static InputStream wrapInputStream(Communicator communicator,
                                          byte[] bytes)

Wraps encoded data with an input stream for dynamic invocation and dispatch. The stream uses the communicator's default encoding version.

Parameters:

communicator - The communicator for the stream.

bytes - An encoded request or reply.

Returns:

The input stream.

wrapInputStream

public static InputStream wrapInputStream(Communicator communicator,
                                          byte[] bytes,
                                          EncodingVersion v)

Wraps encoded data with an input stream for dynamic invocation and dispatch. The stream uses the given encoding version.

Parameters:

communicator - The communicator for the stream.

bytes - An encoded request or reply.

v - The desired encoding version.

Returns:

The input stream.

createOutputStream

public static OutputStream createOutputStream(Communicator communicator)

Creates an output stream for dynamic invocation and dispatch. The stream uses the communicator's default encoding version.

Parameters:

communicator - The communicator for the stream.

Returns:

The output stream.

createOutputStream

public static OutputStream createOutputStream(Communicator communicator,
                                              EncodingVersion v)

Creates an output stream for dynamic invocation and dispatch. The stream uses the given encoding version.

Parameters:

communicator - The communicator for the stream.

v - The desired encoding version.

Returns:

The output stream.

getProcessLogger

public static Logger getProcessLogger()

Returns the process-wide logger.

Returns:

The process-wide logger.

setProcessLogger

public static void setProcessLogger(Logger logger)

Changes the process-wide logger.

Parameters:

logger - The new process-wide logger.

stringVersion

public static java.lang.String stringVersion()

Returns the Ice version in the form A.B.C, where A indicates the major version, B indicates the minor version, and C indicates the patch level.

Returns:

The Ice version.

intVersion

public static int intVersion()

Returns the Ice version as an integer in the form A.BB.CC, where A indicates the major version, BB indicates the minor version, and CC indicates the patch level. For example, for Ice 3.3.1, the returned value is 30301.

Returns:

The Ice version.

stringToProtocolVersion

public static ProtocolVersion stringToProtocolVersion(java.lang.String version)

Converts a string to a protocol version.

Parameters:

version - The string to convert.

Returns:

The converted protocol version.

stringToEncodingVersion

public static EncodingVersion stringToEncodingVersion(java.lang.String version)

Converts a string to an encoding version.

Parameters:

version - The string to convert.

Returns:

The converted object identity.

protocolVersionToString

public static java.lang.String protocolVersionToString(ProtocolVersion v)

Converts a protocol version to a string.

Parameters:

v - The protocol version to convert.

Returns:

The converted string.

encodingVersionToString

public static java.lang.String encodingVersionToString(EncodingVersion v)

Converts an encoding version to a string.

Parameters:

v - The encoding version to convert.

Returns:

The converted string.

currentProtocol

public static ProtocolVersion currentProtocol()

Returns the supported Ice protocol version.

Returns:

The Ice protocol version.

currentEncoding

public static EncodingVersion currentEncoding()

Returns the supported Ice encoding version.

Returns:

The Ice encoding version.