updated javadoc and readme
Project: http://git-wip-us.apache.org/repos/asf/ode/repo Commit: http://git-wip-us.apache.org/repos/asf/ode/commit/565ccda6 Tree: http://git-wip-us.apache.org/repos/asf/ode/tree/565ccda6 Diff: http://git-wip-us.apache.org/repos/asf/ode/diff/565ccda6 Branch: refs/heads/ODE-912 Commit: 565ccda6a476fa85a864aca7e4f154b268804f81 Parents: c4c7ed6 Author: fangzhen <[email protected]> Authored: Mon Aug 11 16:29:49 2014 +0800 Committer: fangzhen <[email protected]> Committed: Mon Aug 11 16:29:49 2014 +0800 ---------------------------------------------------------------------- bpel-nobj/Readme.md | 71 +++++++++++--------- .../bpel/obj/migrate/DomElementComparator.java | 4 ++ .../bpel/obj/migrate/EqualityComparator.java | 13 +++- .../obj/migrate/ExtensibeImplEqualityComp.java | 4 ++ .../obj/migrate/LegacySerializerAdapter.java | 18 +++-- .../apache/ode/bpel/obj/migrate/OmOld2new.java | 2 +- .../ode/bpel/obj/migrate/OmUpgradeVisitor.java | 5 ++ .../ode/bpel/obj/migrate/UpgradeChecker.java | 6 ++ .../apache/ode/bpel/obj/serde/DeSerializer.java | 7 +- .../bpel/obj/serde/JavaSerOmDeserializer.java | 7 +- .../ode/bpel/obj/serde/JavaSerOmSerializer.java | 5 ++ .../ode/bpel/obj/serde/JsonOmDeserializer.java | 24 ++++++- .../ode/bpel/obj/serde/JsonOmSerializer.java | 21 +++++- .../ode/bpel/obj/serde/OmDeserializer.java | 6 ++ .../ode/bpel/obj/serde/OmSerdeFactory.java | 3 +- .../apache/ode/bpel/obj/serde/OmSerializer.java | 8 ++- .../ode/bpel/obj/serde/SmileOmDeserializer.java | 9 ++- .../ode/bpel/obj/serde/SmileOmSerializer.java | 4 ++ 18 files changed, 168 insertions(+), 49 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/Readme.md ---------------------------------------------------------------------- diff --git a/bpel-nobj/Readme.md b/bpel-nobj/Readme.md index 553c687..a9b4874 100644 --- a/bpel-nobj/Readme.md +++ b/bpel-nobj/Readme.md @@ -1,32 +1,41 @@ -OModel +OModel ===== - Basically, the OModel class uses a map as container of all fields, and use jackson for serialization to / deserialization from json/smile. - When serialize, the map are serialized on behalf of the class it stands. When deserialize, the whole json are deserialized to OProcessWrapper, - and then construct OModel classes from map container(i.e. when getters are called). - a simple example of serialized json: - - { - "MAGIC":"VTVTAE9GSCAUBSk=", - "FORMAT":16, - "COMPILE_TIME":1401935206665, - "OTHER_HEADERS":{}, - "PROCESS":{ - ... - } - } - - So, getters and setters are responsible for the map <-> OModel class transition. More precisely, getField() method will locate the field in map - and construct the OModel class from its value. setField(OBase obj) will extract the map representation of obj and put it into the map. - For example, getters and setters might like this: - - OProcess getProcess(){ - Map process = fieldContainer.get("PROCESS"); - return new OProcess(process); - } - - void setProcess(OProcess oProcess){ - Map process = oProcess.getMapRepr(); - fieldContainer.put("PROCESS", process); - } - - Please refer to the source for more information :). \ No newline at end of file +Basically, the OModel class uses a map as container of all fields, +and handles different serialization format\: java, json, smile. the latter +two are with help with jackson. + +Migration and upgrade are also handled in this module. Testcases of +Serialization and migration are involved with compiler, so main testcases +are in bpel-compile module. + +Serialization File Format +--------- +New OModel has the same magic number and is different with old OModel. +Deserializer tell if it's old or new OModel by it's magic number. Magic +number and some other infomation are stored in file header. Serialized files +are as following: + +``` + | Magic number | + |---------------| + | other headers | + |---------------| + | OProcess | + +``` +The magic number can be used to distinct new and old omodel. +<code>Deserializer</code> is responsible for (de)serialize the while file. +Since old serialization format serialize magic number the same position as +we had here, <code>DeSerializer</code> can handle both old and new cbp files. + +The new OModel support three format to (de)serialize OProcess. which are java, +json and smile. Corresponding <code>OmSerializer</code> and <code>OmDeserializer +</code> are implemented respectly. +format information are stored in file header. When deserialize, it will +seek for corresponding deserializer. File extensions are not used to +specify format. The default serialization format is java currently. Hope to +be configurable soon. + +Migrations are done when deserialize Old omodel. upgrade to newest new omodel +are checked and done(if necessary) when deserialize. And if specified, the +upgraded OProcess will be writeback. (problems with the caller yet) http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/DomElementComparator.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/DomElementComparator.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/DomElementComparator.java index 05ebb1d..92b496c 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/DomElementComparator.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/DomElementComparator.java @@ -16,6 +16,10 @@ import org.w3c.dom.Element; import org.w3c.dom.ls.DOMImplementationLS; import org.w3c.dom.ls.LSSerializer; +/** + * DeepEqual of two DomElement. + * @see DeepEqualityHelper + */ public class DomElementComparator implements EqualityComparator{ private static final Log __log = LogFactory.getLog(DomElementComparator.class); private DeepEqualityHelper deepEquality; http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/EqualityComparator.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/EqualityComparator.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/EqualityComparator.java index 6783969..69ad056 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/EqualityComparator.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/EqualityComparator.java @@ -1,8 +1,19 @@ package org.apache.ode.bpel.obj.migrate; +/** + * Used by {@link DeepEqualityHelper} for custom comparator. + */ public interface EqualityComparator { - + /** + * return true if specified obj1 and obj2 are equal, false otherwise. + */ Boolean objectsEqual(Object obj1, Object obj2); + + /** + * decide if the comparator can handle the specified object. + * Usually called before {@link EqualityComparator#objectsEqual(Object, Object)} are invoked. + */ Boolean canHanle(Object obj); + void setDeepEquality(DeepEqualityHelper deepEquality); } http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/ExtensibeImplEqualityComp.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/ExtensibeImplEqualityComp.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/ExtensibeImplEqualityComp.java index e0be0d1..17a14d9 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/ExtensibeImplEqualityComp.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/ExtensibeImplEqualityComp.java @@ -12,6 +12,10 @@ import org.apache.ode.bpel.obj.DebugInfo; import org.apache.ode.bpel.obj.ExtensibleImpl; import org.apache.ode.bpel.obj.OProcess; +/** + * DeepEquality comparator for OModel classes. It will compare backed map recursively. + * @see DeepEqualityHelper + */ public class ExtensibeImplEqualityComp implements EqualityComparator{ private static final Log __log = LogFactory.getLog(ExtensibeImplEqualityComp.class); private DeepEqualityHelper deepEquality; http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/LegacySerializerAdapter.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/LegacySerializerAdapter.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/LegacySerializerAdapter.java index 20e53a5..307dcef 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/LegacySerializerAdapter.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/LegacySerializerAdapter.java @@ -7,22 +7,30 @@ import org.apache.ode.bpel.obj.OProcess; import org.apache.ode.bpel.obj.serde.OmDeserializer; import org.apache.ode.bpel.obj.serde.SerializaionRtException; -public class LegacySerializerAdapter implements OmDeserializer{ - private InputStream in; +/** + * Adaptor for legacy Omodel serializer. Used to deserialize and migrate + * old format compiled bpels. + * @see Serializer + */ +public class LegacySerializerAdapter implements OmDeserializer { private Serializer serializer; + public LegacySerializerAdapter(InputStream in) { - this.in = in; serializer = new Serializer(); serializer._inputStream = in; } - + + /** + * Read the old OModel and migrate it to new omodel. + */ @Override public OProcess deserialize() throws SerializaionRtException { org.apache.ode.bpel.o.OProcess old; try { old = serializer.readOProcess(); } catch (Exception e) { - throw new SerializaionRtException("Error when deserializing old OModle classes"); + throw new SerializaionRtException( + "Error when deserializing old OModle classes"); } //migrate to new OModel OmOld2new mig = new OmOld2new(); http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmOld2new.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmOld2new.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmOld2new.java index 4f79a80..31f5280 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmOld2new.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmOld2new.java @@ -19,7 +19,7 @@ import org.apache.ode.bpel.obj.ExtensibleImpl; /** * Migrate from old Omodel classes to new ones. * @author fangzhen - * + * @see ObjectTraverser */ public class OmOld2new extends AbstractObjectVisitor{ private static final Log __log = LogFactory.getLog(OmOld2new.class); http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmUpgradeVisitor.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmUpgradeVisitor.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmUpgradeVisitor.java index f0cde52..f92b36f 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmUpgradeVisitor.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/OmUpgradeVisitor.java @@ -6,6 +6,11 @@ import java.util.List; import org.apache.ode.bpel.obj.Extensible; +/** + * Upgrade Omodel Object to newest version. Used as + * visitor of {@link ObjectTraverser} + * @see ObjectTraverser + */ public class OmUpgradeVisitor extends AbstractObjectVisitor{ @Override http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/UpgradeChecker.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/UpgradeChecker.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/UpgradeChecker.java index 26eabf7..41809d8 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/UpgradeChecker.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/migrate/UpgradeChecker.java @@ -7,6 +7,12 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.ode.bpel.obj.ExtensibleImpl; +/** + * Check if the specified OModel Object is newest. Used as a visitor of + * {@link ObjectTraverser}. + * + * @see ObjectTraverser + */ public class UpgradeChecker extends AbstractObjectVisitor{ private static final Log __log = LogFactory.getLog(UpgradeChecker.class); http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/DeSerializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/DeSerializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/DeSerializer.java index 24ec9fa..cdea0d5 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/DeSerializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/DeSerializer.java @@ -26,6 +26,12 @@ import org.apache.ode.bpel.obj.migrate.OmUpgradeVisitor; import org.apache.ode.bpel.obj.migrate.UpgradeChecker; import org.apache.ode.bpel.obj.serde.OmSerdeFactory.SerializeFormat; +/** + * Main Serializer and Deserializer of OModel classes. This class handles different + * serialization format. (De)Serialize header information. It will upgrade the deserialized + * OProcess to newest version. And write it back if the write back file is specified. + * @see OmSerdeFactory + */ public class DeSerializer { private static final Log __log = LogFactory.getLog(DeSerializer.class); @@ -163,5 +169,4 @@ public class DeSerializer { public void setWriteBackFile(File writeBack) { this.writeBackFile = writeBack; } - } http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmDeserializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmDeserializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmDeserializer.java index 5f774c2..a210a7d 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmDeserializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmDeserializer.java @@ -4,9 +4,12 @@ import java.io.InputStream; import java.io.ObjectInputStream; import org.apache.ode.bpel.obj.OProcess; -import org.apache.ode.bpel.obj.migrate.ObjectTraverser; -import org.apache.ode.bpel.obj.migrate.OmUpgradeVisitor; +/** + * OModel deserializer that use java serializtion mechanism. + * Corresponding to format {@link OmSerdeFactory.SerializeFormat#FORMAT_SERIALIZED_JAVA} + * @see JavaSerOmSerializer + */ public class JavaSerOmDeserializer implements OmDeserializer { private InputStream is; public JavaSerOmDeserializer(InputStream is) { http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmSerializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmSerializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmSerializer.java index 5357a26..0a413f2 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmSerializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JavaSerOmSerializer.java @@ -5,6 +5,11 @@ import java.io.OutputStream; import org.apache.ode.bpel.obj.OProcess; +/** + * OModel Serializer that use java serializtion mechanism. + * Corresponding to format {@link OmSerdeFactory.SerializeFormat#FORMAT_SERIALIZED_JAVA} + * @see JavaSerOmDeserializer + */ public class JavaSerOmSerializer implements OmSerializer { private OutputStream out; OProcess process; http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmDeserializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmDeserializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmDeserializer.java index e9f955d..d8918d7 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmDeserializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmDeserializer.java @@ -41,6 +41,11 @@ import com.fasterxml.jackson.databind.ser.BeanPropertyWriter; import com.fasterxml.jackson.module.jaxb.deser.DomElementJsonDeserializer; import com.ibm.wsdl.AbstractWSDLElement; import com.ibm.wsdl.MessageImpl; +/** + * OModel Serializer that deserialize process from json using jackson. + * Corresponding to format {@link OmSerdeFactory.SerializeFormat#FORMAT_SERIALIZED_JSON} + * @see JsonOmSerializer + */ public class JsonOmDeserializer implements OmDeserializer { protected static final Log __log = LogFactory .getLog(JsonOmDeserializer.class); @@ -118,6 +123,9 @@ public class JsonOmDeserializer implements OmDeserializer { this.is = is; } + /** + * @see JsonOmSerializer.OperationTypeSerializer + */ public static class OperationTypeDeserializer extends StdScalarDeserializer<OperationType> { private static final long serialVersionUID = 2015036061829834379L; @@ -154,6 +162,11 @@ public class JsonOmDeserializer implements OmDeserializer { } } + /** + * Add type info to {@link org.w3c.dom.Element}. + * + * @see DomElementJsonDeserializer + */ public static class DomElementDeserializerHack extends DomElementJsonDeserializer{ private static final long serialVersionUID = 2447322357224915181L; @@ -174,7 +187,9 @@ public class JsonOmDeserializer implements OmDeserializer { return value; } } - + /** + * @see JsonOmSerializer.NSContextSerializer + */ public static class NSContextDeserializer extends StdScalarDeserializer<NSContext>{ private static final long serialVersionUID = -4581782525089784968L; @@ -194,6 +209,9 @@ public class JsonOmDeserializer implements OmDeserializer { } + /** + * @see JsonOmSerializer.MessageSerializer + */ public static class MessageDeserializer extends StdScalarDeserializer<MessageImpl>{ protected MessageDeserializer(Class<?> vc) { @@ -233,6 +251,10 @@ public class JsonOmDeserializer implements OmDeserializer { } + /** + * BeanDeserializerModifier to deserialize {@link AbstractWSDLElement} extensibilityElements + * property as field to avoid settlessProperities bug [FastXML/jackson-databind#501]. + */ public static class WsdlElementDeserModifier extends BeanDeserializerModifier{ public static class MyBeanPropertyWriter extends BeanPropertyWriter{ public MyBeanPropertyWriter(BeanPropertyWriter origi, String newName){ http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmSerializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmSerializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmSerializer.java index 69c5c4b..9f0c762 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmSerializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/JsonOmSerializer.java @@ -32,7 +32,11 @@ import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer; import com.fasterxml.jackson.module.jaxb.ser.DomElementJsonSerializer; import com.ibm.wsdl.MessageImpl; - +/** + * OModel Serializer that serialize process to json using jackson. + * Corresponding to format {@link OmSerdeFactory.SerializeFormat#FORMAT_SERIALIZED_JSON} + * @see JsonOmDeserializer + */ public class JsonOmSerializer implements OmSerializer { protected static final Log __log = LogFactory .getLog(JsonOmSerializer.class); @@ -110,6 +114,10 @@ public class JsonOmSerializer implements OmSerializer { this.os = os; } + /** + * Custom jackson serializer for {@link OperationType} + * @see JsonOmDeserializer.OperationTypeDeserializer + */ public static class OperationTypeSerializer extends StdScalarSerializer<OperationType> { @@ -154,7 +162,10 @@ public class JsonOmSerializer implements OmSerializer { jgen.writeEndArray(); } } - + /** + * Custom {@link NSContext} serializer. Serialize it's map representation. + * @see NSContext JsonOmDeserializer.NSContextDeserializer + */ public static class NSContextSerializer extends StdScalarSerializer<NSContext>{ @@ -172,6 +183,12 @@ public class JsonOmSerializer implements OmSerializer { } + /** + * custom serializer for {@link MessageImpl}. Additional private field + * (@link MessageImpl#additionOrderOfParts} are serialized. + * + * @see JsonOmDeserializer.MessageDeserializer + */ public static class MessageSerializer extends StdScalarSerializer<MessageImpl>{ protected MessageSerializer(Class<MessageImpl> class1) { http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmDeserializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmDeserializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmDeserializer.java index c3f9745..26ef989 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmDeserializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmDeserializer.java @@ -3,5 +3,11 @@ package org.apache.ode.bpel.obj.serde; import org.apache.ode.bpel.obj.OProcess; public interface OmDeserializer { + /** + * Deserialize to process instance. Instances should be + * created and built by {@link OmSerdeFactory} + * @return Deserialized {@link OProcess}. + * @throws SerializaionRtException + */ public OProcess deserialize() throws SerializaionRtException; } http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerdeFactory.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerdeFactory.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerdeFactory.java index 81941bf..b6d0412 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerdeFactory.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerdeFactory.java @@ -7,6 +7,7 @@ import org.apache.ode.bpel.obj.OProcess; import org.apache.ode.bpel.obj.migrate.LegacySerializerAdapter; public class OmSerdeFactory { + /**default serialization format */ public static final SerializeFormat FORMAT_SERIALIZED_DEFAULT = SerializeFormat.FORMAT_SERIALIZED_JAVA; private SerializeFormat format = FORMAT_SERIALIZED_DEFAULT; @@ -64,7 +65,7 @@ public class OmSerdeFactory { FORMAT_SERIALIZED_SMILE(0x11), FORMAT_SERIALIZED_JAVA(0x20), - //convenient for legacy format + /**convenient for legacy format */ FORMAT_SERIALIZED_LEGACY(0x90); private int code; http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerializer.java index 27efdba..419da10 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/OmSerializer.java @@ -1,7 +1,13 @@ package org.apache.ode.bpel.obj.serde; -import java.io.IOException; +import org.apache.ode.bpel.obj.OProcess; + public interface OmSerializer { + /** + * Serialize the {@link OProcess} instance + * @throws SerializaionRtException + * @see OmSerdeFactory + */ public void serialize() throws SerializaionRtException; } http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmDeserializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmDeserializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmDeserializer.java index 5bdb5cb..d032cd7 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmDeserializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmDeserializer.java @@ -4,13 +4,16 @@ import java.io.InputStream; import com.fasterxml.jackson.dataformat.smile.SmileFactory; +/** OModel Serializer that corresponding to {@link OmSerdeFactory.SerializeFormat#FORMAT_SERIALIZED_SMILE} + * @see JsonOmSerializer +*/ public class SmileOmDeserializer extends JsonOmDeserializer { - public SmileOmDeserializer(){ + public SmileOmDeserializer() { super(); factory = new SmileFactory(); } - - public SmileOmDeserializer(InputStream is){ + + public SmileOmDeserializer(InputStream is) { super(is, new SmileFactory()); } } http://git-wip-us.apache.org/repos/asf/ode/blob/565ccda6/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmSerializer.java ---------------------------------------------------------------------- diff --git a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmSerializer.java b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmSerializer.java index 3ec5916..9232630 100644 --- a/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmSerializer.java +++ b/bpel-nobj/src/main/java/org/apache/ode/bpel/obj/serde/SmileOmSerializer.java @@ -6,6 +6,10 @@ import org.apache.ode.bpel.obj.OProcess; import com.fasterxml.jackson.dataformat.smile.SmileFactory; +/** + * OModel Serializer that corresponding to {@link OmSerdeFactory.SerializeFormat#FORMAT_SERIALIZED_SMILE} + * @see JsonOmDeserializer + */ public class SmileOmSerializer extends JsonOmSerializer{ public SmileOmSerializer(){ super();
