Top Description Inners Fields Constructors Methods
com.sun.faces.spi

public Class SerializationProviderFactory

extends Object
Class Inheritance
Imports
java.io.IOException, .InputStream, .ObjectInputStream, .ObjectOutputStream, .OutputStream, java.util.logging.Level, .Logger, com.sun.faces.RIConstants, com.sun.faces.config.WebConfiguration, .WebConfiguration.WebContextInitParameter, com.sun.faces.renderkit.ApplicationObjectInputStream, com.sun.faces.util.FacesLogger, .Util, jakarta.faces.context.ExternalContext

A factory for creating SerializationProvider instances.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
SerializationProviderFactory.JavaSerializationProvider

An implementation of SerializationProvider which uses standard Java serialization.

Field Summary

Modifier and TypeField and Description
private static final SerializationProvider
JAVA_PROVIDER

Our default SerializationProvider.

private static final Logger
private static final String
SERIALIZATION_PROVIDER_PROPERTY

The system property that will be checked for alternate SerializationProvider implementations.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static SerializationProvider

Returns:

an implementation of the InjectionProvider interfaces
createInstance
(ExternalContext
the ExternalContext for this application
extContext
)

Creates a new instance of the class specified by the com.sun.faces.InjectionProvider system property.

private static String

Returns:

The provider class name specified in the container configuration, or null if not found.
findProviderClass
(ExternalContext
The ExternalContext for this request
extContext
)

Tries to find a provider class in a web context parameter.

private static SerializationProvider
private static boolean

Returns:

true if clazz implements the SerializationProvider interface
implementsSerializationProvider
(Class<?>
the class in question
clazz
)

Determine if the specified class implements the SerializationProvider interfaces.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

JAVA_PROVIDERback to summary
private static final SerializationProvider JAVA_PROVIDER

Our default SerializationProvider.

LOGGERback to summary
private static final Logger LOGGER
SERIALIZATION_PROVIDER_PROPERTYback to summary
private static final String SERIALIZATION_PROVIDER_PROPERTY

The system property that will be checked for alternate SerializationProvider implementations.

Constructor Detail

SerializationProviderFactoryback to summary
public SerializationProviderFactory()

Method Detail

createInstanceback to summary
public static SerializationProvider createInstance(ExternalContext extContext)

Creates a new instance of the class specified by the com.sun.faces.InjectionProvider system property. If this propery is not defined, then a default, no-op, InjectionProvider will be returned.

Parameters
extContext:ExternalContext

the ExternalContext for this application

Returns:SerializationProvider

an implementation of the InjectionProvider interfaces

findProviderClassback to summary
private static String findProviderClass(ExternalContext extContext)

Tries to find a provider class in a web context parameter. If not present it tries to find it as a System property. If still not found returns null.

Parameters
extContext:ExternalContext

The ExternalContext for this request

Returns:String

The provider class name specified in the container configuration, or null if not found.

getProviderInstanceback to summary
private static SerializationProvider getProviderInstance(String className)
implementsSerializationProviderback to summary
private static boolean implementsSerializationProvider(Class<?> clazz)

Determine if the specified class implements the SerializationProvider interfaces.

Parameters
clazz:Class<?>

the class in question

Returns:boolean

true if clazz implements the SerializationProvider interface

com.sun.faces.spi back to summary

private final Class SerializationProviderFactory.JavaSerializationProvider

extends Object
implements SerializationProvider
Class Inheritance
  • java.lang.Object
  • com.sun.faces.spi.SerializationProviderFactory.JavaSerializationProvider
All Implemented Interfaces
com.sun.faces.spi.SerializationProvider

An implementation of SerializationProvider which uses standard Java serialization.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public ObjectInputStream

Returns:

an ObjectInputStream
createObjectInputStream
(InputStream
the source stream from which to read the Object(s) from
source
)

Implements com.sun.faces.spi.SerializationProvider.createObjectInputStream.

Creates a new ObjectInputStream wrapping the specified source.

public ObjectOutputStream

Returns:

an ObjectOutputStream
createObjectOutputStream
(OutputStream
the destination of the serialized Object(s)
destination
)

Implements com.sun.faces.spi.SerializationProvider.createObjectOutputStream.

Creates a new ObjectOutputStream wrapping the specified destination.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

JavaSerializationProviderback to summary
private JavaSerializationProvider()

Method Detail

createObjectInputStreamback to summary
public ObjectInputStream createObjectInputStream(InputStream source) throws IOException

Implements com.sun.faces.spi.SerializationProvider.createObjectInputStream.

Creates a new ObjectInputStream wrapping the specified source.

Parameters
source:InputStream

the source stream from which to read the Object(s) from

Returns:ObjectInputStream

an ObjectInputStream

Annotations
@Override
Exceptions
IOException:

Doc from com.sun.faces.spi.SerializationProvider.createObjectInputStream.

if an error occurs when creating the input stream

createObjectOutputStreamback to summary
public ObjectOutputStream createObjectOutputStream(OutputStream destination) throws IOException

Implements com.sun.faces.spi.SerializationProvider.createObjectOutputStream.

Creates a new ObjectOutputStream wrapping the specified destination.

Parameters
destination:OutputStream

the destination of the serialized Object(s)

Returns:ObjectOutputStream

an ObjectOutputStream

Annotations
@Override
Exceptions
IOException:

Doc from com.sun.faces.spi.SerializationProvider.createObjectOutputStream.

if an error occurs when creating the output stream