Package org.apache.mina.filter.codec.serialization

Class ObjectSerializationCodecFactory

java.lang.Object
org.apache.mina.filter.codec.serialization.ObjectSerializationCodecFactory
All Implemented Interfaces:
ProtocolCodecFactory
public class ObjectSerializationCodecFactory extends Object implements ProtocolCodecFactory
A ProtocolCodecFactory that serializes and deserializes Java objects. This codec is very useful when you have to prototype your application rapidly without any specific codec.

  • Field Details

  • Constructor Details

    • ObjectSerializationCodecFactory

      public ObjectSerializationCodecFactory()
      Creates a new instance with the ClassLoader of the current thread.

    • ObjectSerializationCodecFactory

      public ObjectSerializationCodecFactory(ClassLoader classLoader)
      Creates a new instance with the specified ClassLoader.
      Parameters:
      classLoader - The class loader to use

  • Method Details

    • getEncoder

      public ProtocolEncoder getEncoder(IoSession session)
      Returns a new (or reusable) instance of ProtocolEncoder which encodes message objects into binary or protocol-specific data.
      Specified by:
      getEncoder in interface ProtocolCodecFactory
      Parameters:
      session - The current session
      Returns:
      The encoder instance

    • getDecoder

      public ProtocolDecoder getDecoder(IoSession session)
      Returns a new (or reusable) instance of ProtocolDecoder which decodes binary or protocol-specific data into message objects.
      Specified by:
      getDecoder in interface ProtocolCodecFactory
      Parameters:
      session - The current session
      Returns:
      The decoder instance

    • getEncoderMaxObjectSize

      public int getEncoderMaxObjectSize()
      Returns:
      the allowed maximum size of the encoded object. If the size of the encoded object exceeds this value, the encoder will throw a IllegalArgumentException. The default value is Integer.MAX_VALUE.

      This method does the same job with ObjectSerializationEncoder.getMaxObjectSize().

    • setEncoderMaxObjectSize

      public void setEncoderMaxObjectSize(int maxObjectSize)
      Sets the allowed maximum size of the encoded object. If the size of the encoded object exceeds this value, the encoder will throw a IllegalArgumentException. The default value is Integer.MAX_VALUE.

      This method does the same job with ObjectSerializationEncoder.setMaxObjectSize(int).

      Parameters:
      maxObjectSize - The maximum size of the encoded object

    • getDecoderMaxObjectSize

      public int getDecoderMaxObjectSize()
      Returns:
      the allowed maximum size of the object to be decoded. If the size of the object to be decoded exceeds this value, the decoder will throw a BufferDataException. The default value is 1048576 (1MB).

      This method does the same job with ObjectSerializationDecoder.getMaxObjectSize().

    • setDecoderMaxObjectSize

      public void setDecoderMaxObjectSize(int maxObjectSize)
      Sets the allowed maximum size of the object to be decoded. If the size of the object to be decoded exceeds this value, the decoder will throw a BufferDataException. The default value is 1048576 (1MB).

      This method does the same job with ObjectSerializationDecoder.setMaxObjectSize(int).

      Parameters:
      maxObjectSize - The maximum size of the decoded object

    • accept

      public void accept(ClassNameMatcher classNameMatcher)
      Accept class names where the supplied ClassNameMatcher matches for deserialization, unless they are otherwise rejected.
      Parameters:
      classNameMatcher - the matcher to use

    • accept

      public void accept(Pattern pattern)
      Accept class names that match the supplied pattern for deserialization, unless they are otherwise rejected.
      Parameters:
      pattern - standard Java regexp

    • accept

      public void accept(String... patterns)
      Accept the wildcard specified classes for deserialization, unless they are otherwise rejected.
      Parameters:
      patterns - Wildcard file name patterns as defined by org.apache.commons.io.FilenameUtils#wildcardMatch(String, String)