com.gigaspaces.internal.io

Class IOUtils

java.lang.Object

com.gigaspaces.internal.io.IOUtils

public class IOUtils
extends Object

This class provides a set of static utility methods used for I/O manipulations (convert data to streams, socket ports).

Version:

4.5

Author:

Igor Goldenberg, Guy Korland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOUtils.NoHeaderObjectInputStream
static class	IOUtils.NoHeaderObjectOutputStream

Constructor Summary

Constructors

Constructor and Description
IOUtils()

Method Summary

Modifier and Type	Method and Description
static Object	deepClone(Object obj) A deep copy makes a distinct copy of each of the object's fields, recursing through the entire graph of other objects referenced by the object being copied.
static void	deserializeSupportCodeChangeCollection(ObjectInput in, Collection collection) Complement of serializeSupportCodeChangeCollection(ObjectOutput out, Collection objects)
static int	getAnonymousPort() Get an anonymous socket port.
static Map<Class<?>,IClassSerializer<?>>	getClassSerializers()
static IClassSerializer<?>	getDefaultSerializer()
static boolean	isArchive(String fileName)
static boolean	isPortBusy(int port, String bindAddr) Checks whether a supplied socket port is busy.
static void	marshalValue(Class type, Object value, ObjectOutput out) Marshals value to an ObjectOutputStream stream, out, using RMI's serialization format for arguments or return values.
static Object	objectFromByteBuffer(byte[] buffer) Creates an object from a byte buffer.
static byte[]	objectToByteBuffer(Object obj) Serializes an object into a byte buffer.
static boolean[]	readBooleanArray(ObjectInput in)
static byte[]	readByteArray(ObjectInput in)
static IEntryPacket[]	readEntryPacketArray(ObjectInput in)
static Exception[]	readExceptionArray(ObjectInput in)
static int	readInt(ObjectInput in)
static int[]	readIntegerArray(ObjectInput in)
static List	readList(ObjectInput in)
static List<String>	readListString(ObjectInput in)
static long	readLong(ObjectInput in)
static long[]	readLongArray(ObjectInput in)
static <T> Map<String,T>	readMapRepetitiveKeys(ObjectInput in)
static Map<String,Object>	readMapStringObject(ObjectInput in)
static Map<String,String>	readMapStringString(ObjectInput in)
static <T extends ISwapExternalizable> T	readNullableSwapExternalizableObject(ObjectInput in)
static <T> T	readObject(ObjectInput in)
static Object	readObject(ObjectInput in, SupportCodeChangeAnnotationContainer supportCodeChangeAnnotationContainer, boolean useIOUtilsReadObject) Tasks are loaded with a fresh class loader.
static Object[]	readObjectArray(ObjectInput in)
static Object[]	readObjectArrayCompressed(ObjectInput in)
static <T> T	readRepetitiveObject(ObjectInput in) Objects read and written with repetitive must be immutable (cannot be changed as they are kept in underlying map, changing them will affect the next repetitiveRead/Write
static String	readRepetitiveString(ObjectInput in) Read strings that were Shrinked using writeRepetitiveString(ObjectOutput, String)
static String[]	readRepetitiveStringArray(ObjectInput in)
static short	readShort(ObjectInput in)
static short[]	readShortArray(ObjectInput in)
static String	readString(ObjectInput in)
static String[]	readStringArray(ObjectInput in)
static Set<String>	readStringSet(ObjectInput in)
static <T extends ISwapExternalizable> T	readSwapExternalizableObject(ObjectInput in)
static ITemplatePacket[]	readTemplatePacketArray(ObjectInput in)
static Throwable[]	readThrowableArray(ObjectInput in)
static UUID	readUUID(ObjectInput in)
static <T> T	readWithCachedStubs(ObjectInput in)
static void	serializeSupportCodeChangeCollection(ObjectOutput out, Collection collection) Complement of #deserializeSupportCodeChangeCollection(ObjectInput in, Collection collection))
static Object	unmarshalValue(Class type, ObjectInput in) Unmarshals a value of the specified type from the ObjectInputStream stream, in, using RMI's serialization format for arguments or return values and returns the result.
static void	writeBooleanArray(ObjectOutput out, boolean[] array)
static void	writeByteArray(ObjectOutput out, byte[] array)
static void	writeInt(ObjectOutput out, int value)
static void	writeIntegerArray(ObjectOutput out, int[] array)
static void	writeList(ObjectOutput out, List list)
static void	writeListString(ObjectOutput out, List<String> list)
static void	writeLong(ObjectOutput out, long value)
static void	writeLongArray(ObjectOutput out, long[] array)
static <T> void	writeMapRepetitiveKeys(ObjectOutput out, Map<String,T> map)
static void	writeMapStringObject(ObjectOutput out, Map<String,Object> map)
static void	writeMapStringString(ObjectOutput out, Map<String,String> map)
static void	writeNullableSwapExternalizableObject(ObjectOutput out, ISwapExternalizable swapExternalizable)
static void	writeObject(ObjectOutput out, Object obj)
static void	writeObjectArray(ObjectOutput out, Object[] array)
static void	writeObjectArrayCompressed(ObjectOutput out, Object[] array)
static void	writeRepetitiveObject(ObjectOutput out, Object obj) Should only be used for objects that their class is known to SystemJars.DATA_GRID_JAR, meaning at SystemJars.DATA_GRID_JAR, its dependencies or JDK Objects read and written with repetitive must be immutable (cannot be changed as they are kept in underlying map, changing them will affect the next repetitiveRead/Write
static void	writeRepetitiveString(ObjectOutput out, String s) Shrink string over the wire, should be used for constant number of strings which are repetitive (i.e space names, class names)
static void	writeRepetitiveStringArray(ObjectOutput out, String[] array)
static void	writeShort(ObjectOutput out, short value)
static void	writeShortArray(ObjectOutput out, short[] array)
static void	writeString(ObjectOutput out, String s)
static void	writeStringArray(ObjectOutput out, String[] array)
static void	writeStringSet(ObjectOutput out, Set<String> set)
static void	writeSwapExternalizableObject(ObjectOutput out, ISwapExternalizable swapExternalizable)
static void	writeUUID(ObjectOutput out, UUID value)
static void	writeWithCachedStubs(ObjectOutput out, Object obj)

Methods inherited from class java.lang.Object

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

Constructor Detail

IOUtils

public IOUtils()

Method Detail

isArchive

public static boolean isArchive(String fileName)

objectFromByteBuffer

public static Object objectFromByteBuffer(byte[] buffer)
                                   throws Exception

Creates an object from a byte buffer.

Throws:

Exception

objectToByteBuffer

public static byte[] objectToByteBuffer(Object obj)
                                 throws Exception

Serializes an object into a byte buffer. The object has to implement interface Serializable or Externalizable.

Throws:

Exception

deepClone

public static Object deepClone(Object obj)

A deep copy makes a distinct copy of each of the object's fields, recursing through the entire graph of other objects referenced by the object being copied. Deep clone by serialize and deserialize the object and return the deserialized version. A deep copy/clone, assuming everything in the tree is serializable. NOTE: This method is very expensive!, don't use this method if you need performance.

Parameters:

obj - the object to clone, the object and object context must implement java.io.Serializable.

Returns:

the copied object include all object references.

Throws:

IllegalArgumentException - Failed to perform deep clone. The object of the context object is not implements java.io.Serializable.

writeUUID

public static void writeUUID(ObjectOutput out,
                             UUID value)
                      throws IOException

Throws:

IOException

readUUID

public static UUID readUUID(ObjectInput in)
                     throws IOException

Throws:

IOException

marshalValue

public static void marshalValue(Class type,
                                Object value,
                                ObjectOutput out)
                         throws IOException

Marshals value to an ObjectOutputStream stream, out, using RMI's serialization format for arguments or return values. For primitive types, the primitive type's class should be specified (i.e., for the type int, specify int.class), and the primitive value should be wrapped in instances of the appropriate wrapper class, such as java.lang.Integer or java.lang.Boolean.

Parameters:

type - Class object for the value to be marshalled

value - value to marshal

out - stream to which the value is marshalled

Throws:

IOException - if an I/O error occurs marshalling the value to the output stream

unmarshalValue

public static Object unmarshalValue(Class type,
                                    ObjectInput in)
                             throws IOException,
                                    ClassNotFoundException

Unmarshals a value of the specified type from the ObjectInputStream stream, in, using RMI's serialization format for arguments or return values and returns the result. For primitive types, the primitive type's class should be specified (i.e., for the primitive type int, specify int.class).

Parameters:

type - Class object for the value to be unmarshalled

in - stream from which the value is unmarshalled

Returns:

value unmarshalled from the input stream

Throws:

IOException - if an I/O error occurs marshalling the value to the output stream

ClassNotFoundException - if the type's class could not be found

isPortBusy

public static boolean isPortBusy(int port,
                                 String bindAddr)
                          throws UnknownHostException

Checks whether a supplied socket port is busy. The port must be between 0 and 65535, inclusive.

Parameters:

port - the port to check.

bindAddr - check if port busy on specific InetAddress, If bindAddr is null, it will default accepting connections on any/all local addresses

Returns:

true if supplied port is busy, otherwise false.

Throws:

UnknownHostException - if no IP address for the host could be found, or if a scope_id was specified for a global IPv6 address.

getAnonymousPort

public static int getAnonymousPort()
                            throws IOException

Get an anonymous socket port.

Returns:

An anonymous port created by instantiating a java.net.ServerSocket with a port of 0

Throws:

IOException

writeShortArray

public static void writeShortArray(ObjectOutput out,
                                   short[] array)
                            throws IOException

Throws:

IOException

readShortArray

public static short[] readShortArray(ObjectInput in)
                              throws IOException

Throws:

IOException

writeIntegerArray

public static void writeIntegerArray(ObjectOutput out,
                                     int[] array)
                              throws IOException

Throws:

IOException

readIntegerArray

public static int[] readIntegerArray(ObjectInput in)
                              throws IOException

Throws:

IOException

writeLongArray

public static void writeLongArray(ObjectOutput out,
                                  long[] array)
                           throws IOException

Throws:

IOException

readLongArray

public static long[] readLongArray(ObjectInput in)
                            throws IOException

Throws:

IOException

writeByteArray

public static void writeByteArray(ObjectOutput out,
                                  byte[] array)
                           throws IOException

Throws:

IOException

readByteArray

public static byte[] readByteArray(ObjectInput in)
                            throws IOException

Throws:

IOException

writeBooleanArray

public static void writeBooleanArray(ObjectOutput out,
                                     boolean[] array)
                              throws IOException

Throws:

IOException

readBooleanArray

public static boolean[] readBooleanArray(ObjectInput in)
                                  throws IOException

Throws:

IOException

writeRepetitiveString

public static void writeRepetitiveString(ObjectOutput out,
                                         String s)
                                  throws IOException

Shrink string over the wire, should be used for constant number of strings which are repetitive (i.e space names, class names)

Throws:

IOException

readRepetitiveString

public static String readRepetitiveString(ObjectInput in)
                                   throws IOException,
                                          ClassNotFoundException

Read strings that were Shrinked using writeRepetitiveString(ObjectOutput, String)

Throws:

IOException

ClassNotFoundException

writeString

public static void writeString(ObjectOutput out,
                               String s)
                        throws IOException

Throws:

IOException

readString

public static String readString(ObjectInput in)
                         throws IOException,
                                ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeStringArray

public static void writeStringArray(ObjectOutput out,
                                    String[] array)
                             throws IOException

Throws:

IOException

readStringArray

public static String[] readStringArray(ObjectInput in)
                                throws IOException,
                                       ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeStringSet

public static void writeStringSet(ObjectOutput out,
                                  Set<String> set)
                           throws IOException

Throws:

IOException

readStringSet

public static Set<String> readStringSet(ObjectInput in)
                                 throws IOException,
                                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeRepetitiveStringArray

public static void writeRepetitiveStringArray(ObjectOutput out,
                                              String[] array)
                                       throws IOException

Throws:

IOException

readRepetitiveStringArray

public static String[] readRepetitiveStringArray(ObjectInput in)
                                          throws IOException,
                                                 ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeList

public static void writeList(ObjectOutput out,
                             List list)
                      throws IOException

Throws:

IOException

readList

public static List readList(ObjectInput in)
                     throws IOException,
                            ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeListString

public static void writeListString(ObjectOutput out,
                                   List<String> list)
                            throws IOException

Throws:

IOException

readListString

public static List<String> readListString(ObjectInput in)
                                   throws IOException,
                                          ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeMapStringString

public static void writeMapStringString(ObjectOutput out,
                                        Map<String,String> map)
                                 throws IOException

Throws:

IOException

readMapStringString

public static Map<String,String> readMapStringString(ObjectInput in)
                                              throws IOException,
                                                     ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeMapStringObject

public static void writeMapStringObject(ObjectOutput out,
                                        Map<String,Object> map)
                                 throws IOException

Throws:

IOException

readMapStringObject

public static Map<String,Object> readMapStringObject(ObjectInput in)
                                              throws IOException,
                                                     ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeMapRepetitiveKeys

public static <T> void writeMapRepetitiveKeys(ObjectOutput out,
                                              Map<String,T> map)
                                       throws IOException

Throws:

IOException

readMapRepetitiveKeys

public static <T> Map<String,T> readMapRepetitiveKeys(ObjectInput in)
                                               throws IOException,
                                                      ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeRepetitiveObject

public static void writeRepetitiveObject(ObjectOutput out,
                                         Object obj)
                                  throws IOException

Should only be used for objects that their class is known to SystemJars.DATA_GRID_JAR, meaning at SystemJars.DATA_GRID_JAR, its dependencies or JDK Objects read and written with repetitive must be immutable (cannot be changed as they are kept in underlying map, changing them will affect the next repetitiveRead/Write

Throws:

IOException

writeObject

public static void writeObject(ObjectOutput out,
                               Object obj)
                        throws IOException

Throws:

IOException

readRepetitiveObject

public static <T> T readRepetitiveObject(ObjectInput in)
                                  throws IOException,
                                         ClassNotFoundException

Objects read and written with repetitive must be immutable (cannot be changed as they are kept in underlying map, changing them will affect the next repetitiveRead/Write

Throws:

IOException

ClassNotFoundException

readObject

public static <T> T readObject(ObjectInput in)
                        throws IOException,
                               ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObjectArray

public static void writeObjectArray(ObjectOutput out,
                                    Object[] array)
                             throws IOException

Throws:

IOException

readObjectArray

public static Object[] readObjectArray(ObjectInput in)
                                throws IOException,
                                       ClassNotFoundException

Throws:

IOException

ClassNotFoundException

readThrowableArray

public static Throwable[] readThrowableArray(ObjectInput in)
                                      throws IOException,
                                             ClassNotFoundException

Throws:

IOException

ClassNotFoundException

readExceptionArray

public static Exception[] readExceptionArray(ObjectInput in)
                                      throws IOException,
                                             ClassNotFoundException

Throws:

IOException

ClassNotFoundException

readEntryPacketArray

public static IEntryPacket[] readEntryPacketArray(ObjectInput in)
                                           throws IOException,
                                                  ClassNotFoundException

Throws:

IOException

ClassNotFoundException

readTemplatePacketArray

public static ITemplatePacket[] readTemplatePacketArray(ObjectInput in)
                                                 throws IOException,
                                                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObjectArrayCompressed

public static void writeObjectArrayCompressed(ObjectOutput out,
                                              Object[] array)
                                       throws IOException

Throws:

IOException

readObjectArrayCompressed

public static Object[] readObjectArrayCompressed(ObjectInput in)
                                          throws IOException,
                                                 ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeSwapExternalizableObject

public static void writeSwapExternalizableObject(ObjectOutput out,
                                                 ISwapExternalizable swapExternalizable)
                                          throws IOException

Throws:

IOException

readSwapExternalizableObject

public static <T extends ISwapExternalizable> T readSwapExternalizableObject(ObjectInput in)
                                                                      throws IOException,
                                                                             ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeNullableSwapExternalizableObject

public static void writeNullableSwapExternalizableObject(ObjectOutput out,
                                                         ISwapExternalizable swapExternalizable)
                                                  throws IOException

Throws:

IOException

readNullableSwapExternalizableObject

public static <T extends ISwapExternalizable> T readNullableSwapExternalizableObject(ObjectInput in)
                                                                              throws IOException,
                                                                                     ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeWithCachedStubs

public static void writeWithCachedStubs(ObjectOutput out,
                                        Object obj)
                                 throws IOException

Throws:

IOException

readWithCachedStubs

public static <T> T readWithCachedStubs(ObjectInput in)
                                 throws IOException,
                                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

readObject

public static Object readObject(ObjectInput in,
                                SupportCodeChangeAnnotationContainer supportCodeChangeAnnotationContainer,
                                boolean useIOUtilsReadObject)
                         throws ClassNotFoundException,
                                IOException

Tasks are loaded with a fresh class loader. When the task is done this fresh class loader is removed. This will make it possible to load a modified version of this class GS-12351- Running Distributed Task can throw ClassNotFoundException, if this task was loaded by a client that already shutdown aInternalSpaceTaskWrapper.java:155nd the class has more dependencies to load. GS-12352 - Distributed Task class is not unloaded after the task finish. GS-12295 - Distributed task - improve class loading mechanism.

Throws:

ClassNotFoundException

IOException

See Also:

SpaceImpl.executeTask(SpaceTask, Transaction, SpaceContext, boolean)

serializeSupportCodeChangeCollection

public static void serializeSupportCodeChangeCollection(ObjectOutput out,
                                                        Collection collection)
                                                 throws IOException

Complement of #deserializeSupportCodeChangeCollection(ObjectInput in, Collection collection))

Throws:

IOException

deserializeSupportCodeChangeCollection

public static void deserializeSupportCodeChangeCollection(ObjectInput in,
                                                          Collection collection)
                                                   throws IOException,
                                                          ClassNotFoundException

Complement of serializeSupportCodeChangeCollection(ObjectOutput out, Collection objects)

Throws:

IOException

ClassNotFoundException

writeShort

public static void writeShort(ObjectOutput out,
                              short value)
                       throws IOException

Throws:

IOException

writeInt

public static void writeInt(ObjectOutput out,
                            int value)
                     throws IOException

Throws:

IOException

writeLong

public static void writeLong(ObjectOutput out,
                             long value)
                      throws IOException

Throws:

IOException

readShort

public static short readShort(ObjectInput in)
                       throws IOException

Throws:

IOException

readInt

public static int readInt(ObjectInput in)
                   throws IOException

Throws:

IOException

readLong

public static long readLong(ObjectInput in)
                     throws IOException

Throws:

IOException

getClassSerializers

public static Map<Class<?>,IClassSerializer<?>> getClassSerializers()

getDefaultSerializer

public static IClassSerializer<?> getDefaultSerializer()