oracle.toplink.essentials.mappings.converters.SerializedObjectConverter Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.mappings.converters;
import java.io.*;
import oracle.toplink.essentials.mappings.*;
import oracle.toplink.essentials.exceptions.*;
import oracle.toplink.essentials.internal.helper.*;
import oracle.toplink.essentials.mappings.foundation.AbstractDirectMapping;
import oracle.toplink.essentials.sessions.*;
import oracle.toplink.essentials.internal.sessions.AbstractSession;
/**
* Purpose: The serialized object converter can be used to store an arbitrary object or set of objects into a database blob field.
* It uses the Java serializer so the target must be serializable.
*
* @author James Sutherland
* @since OracleAS TopLink 10g (10.0.3)
*/
public class SerializedObjectConverter implements Converter {
protected DatabaseMapping mapping;
/**
* PUBLIC:
* Default constructor.
*/
public SerializedObjectConverter() {
}
/**
* PUBLIC:
* Default constructor.
*/
public SerializedObjectConverter(DatabaseMapping mapping) {
this.mapping = mapping;
}
/**
* INTERNAL:
* The fieldValue will be a byte array. Create a ByteArrayInputStream
* on the fieldValue. Create an ObjectInputStream on the ByteArrayInputStream
* to read in the objects.
*/
public Object convertDataValueToObjectValue(Object fieldValue, Session session) throws DescriptorException {
byte[] bytes;
try {
bytes = (byte[])((AbstractSession)session).getDatasourcePlatform().convertObject(fieldValue, ClassConstants.APBYTE);
} catch (ConversionException e) {
throw ConversionException.couldNotBeConverted(mapping, mapping.getDescriptor(), e);
}
if ((bytes == null) || (bytes.length == 0)) {
return null;
}
ByteArrayInputStream byteIn = new ByteArrayInputStream(bytes);
Object object = null;
try {
// BUG# 2813583
CustomObjectInputStream objectIn = new CustomObjectInputStream(byteIn, session);
object = objectIn.readObject();
} catch (Exception exception) {
throw DescriptorException.notDeserializable(getMapping(), exception);
}
return object;
}
/**
* INTERNAL:
* Convert the object to a byte array through serialize.
*/
public Object convertObjectValueToDataValue(Object attributeValue, Session session) {
ByteArrayOutputStream byteOut = new ByteArrayOutputStream();
try {
ObjectOutputStream objectOut = new ObjectOutputStream(byteOut);
objectOut.writeObject(attributeValue);
objectOut.flush();
} catch (IOException exception) {
throw DescriptorException.notSerializable(getMapping(), exception);
}
return byteOut.toByteArray();
}
/**
* INTERNAL:
* Set the mapping.
*/
public void initialize(DatabaseMapping mapping, Session session) {
this.mapping = mapping;
// CR#... Mapping must also have the field classification.
if (getMapping().isDirectToFieldMapping()) {
AbstractDirectMapping directMapping = (AbstractDirectMapping)getMapping();
// Allow user to specify field type to override computed value. (i.e. blob, nchar)
if (directMapping.getFieldClassification() == null) {
directMapping.setFieldClassification(ClassConstants.APBYTE);
}
}
}
/**
* INTERNAL:
* Return the mapping.
*/
protected DatabaseMapping getMapping() {
return mapping;
}
/**
* INTERNAL:
* If the converter converts the value to a non-atomic value, i.e.
* a value that can have its' parts changed without being replaced,
* then it must return false, serialization can be non-atomic.
*/
public boolean isMutable() {
return true;
}
}