diff --git a/README.md b/README.md index 834938a2..936169cc 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,14 @@ Contains the common transformer (T-Engine) code, plus a few implementations. * `model` - library packaged as a jar file which contains the data model of json configuration files and messages sent between clients, T-Engines and T-Router. Also contains code to to combine and then work out which transform to use for a combination of source and target mimetypes - and transform options. + and transform options. **See the deprecated [README](https://github.com/Alfresco/alfresco-transform-core/blob/master/deprecated/alfresco-base-t-engine/README.md) + as some `model` classes have moved package.** * `engines/base` - contains code common to t-engines, packaged as a jar. [README](https://github.com/Alfresco/alfresco-transform-core/blob/master/engines/base/README.md) * `engines/` - multiple T-Engines, which extend the `engines/base`; each one builds a SpringBoot jar and a [Docker image](https://github.com/Alfresco/alfresco-transform-core#docker) * `deprecated/alfresco-base-t-engine` - The original t-engine base, which may still be used, - but has been replaced by the simpler `engines/base` - [README](https://github.com/Alfresco/alfresco-transform-core/blob/master/deprecated/alfresco-base-t-engine/README.md) + but has been replaced by the simpler `engines/base`. ### Documentation diff --git a/deprecated/alfresco-transformer-base/README.md b/deprecated/alfresco-transformer-base/README.md index be84a310..2a22a603 100644 --- a/deprecated/alfresco-transformer-base/README.md +++ b/deprecated/alfresco-transformer-base/README.md @@ -4,6 +4,10 @@ This project holds the original code that was common to all ACS T-Engine transfo it is still possible to create T-Engines this way, the newer `engine/base` project provides a simpler way to do it. +> When upgrading to 3.0.0, you will find that a number of classes in the alfresco-transform-model +have moved. See the [alfresco-transform-model README](https://github.com/Alfresco/alfresco-transform-core/blob/master/model/README.md) + + This project provides a base Spring Boot process (optionally within their own Docker containers). It performs common actions such as logging, throttling requests and handling the streaming of content to and from the container. diff --git a/deprecated/alfresco-transformer-base/pom.xml b/deprecated/alfresco-transformer-base/pom.xml index 2ea7b9d5..9fe53cbe 100644 --- a/deprecated/alfresco-transformer-base/pom.xml +++ b/deprecated/alfresco-transformer-base/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transformer/util/RequestParamMap.java b/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transformer/util/RequestParamMap.java index 985669ff..b9e06566 100644 --- a/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transformer/util/RequestParamMap.java +++ b/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transformer/util/RequestParamMap.java @@ -33,7 +33,7 @@ package org.alfresco.transformer.util; * or communication in the all-in-one transformer. */ @Deprecated -public interface RequestParamMap extends org.alfresco.transform.common.RequestParamMap +public interface RequestParamMap extends org.alfresco.transform.client.util.RequestParamMap { // This property can be sent by acs repository's legacy transformers to force a transform, // instead of letting this T-Engine determine it based on the request parameters. diff --git a/engines/aio/pom.xml b/engines/aio/pom.xml index cdd7dfb4..96776abc 100644 --- a/engines/aio/pom.xml +++ b/engines/aio/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/engines/base/pom.xml b/engines/base/pom.xml index 787730a6..2ff3c485 100644 --- a/engines/base/pom.xml +++ b/engines/base/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/engines/example/pom.xml b/engines/example/pom.xml index e58e2960..438a9299 100644 --- a/engines/example/pom.xml +++ b/engines/example/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/engines/imagemagick/pom.xml b/engines/imagemagick/pom.xml index d0c4a6f9..ea0cf9e1 100644 --- a/engines/imagemagick/pom.xml +++ b/engines/imagemagick/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/engines/libreoffice/pom.xml b/engines/libreoffice/pom.xml index 09e6617c..c9dbe6bb 100644 --- a/engines/libreoffice/pom.xml +++ b/engines/libreoffice/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/engines/misc/pom.xml b/engines/misc/pom.xml index 63848380..44b35212 100644 --- a/engines/misc/pom.xml +++ b/engines/misc/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/engines/pdfrenderer/pom.xml b/engines/pdfrenderer/pom.xml index 70d2d11e..29204fe5 100644 --- a/engines/pdfrenderer/pom.xml +++ b/engines/pdfrenderer/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/engines/tika/pom.xml b/engines/tika/pom.xml index 3997679e..4f0a486a 100644 --- a/engines/tika/pom.xml +++ b/engines/tika/pom.xml @@ -7,7 +7,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT ../../pom.xml diff --git a/model/README.md b/model/README.md index a3352263..29eac6f3 100644 --- a/model/README.md +++ b/model/README.md @@ -1,4 +1,52 @@ # alfresco-transform-model Alfresco Transform Model - Contains the data model of json configuration files -and messages sent between clients, T-Engines and T-Router. Also contains code to -work out which transform should be used for a combination of configuration files. \ No newline at end of file +and messages sent between clients, T-Engines and T-Router. It also contains code to +work out which transform should be used for a combination of configuration files. + +## Upgrade to 3.0.0 +When upgrading to 3.0.0, you will find that a number of classes in the alfresco-transform-model +have moved. Hopefully they are now located in more logical packages. Most classes will not have been +used in existing t-engines (based on the deprecated alfresco-transform-base), other than possibly for +testing. The following table identifies these moves: + +| class | original package | new package | +|---------------------------------|--------------------------------------------|-----------------------------------| +| ExtensionService ± | org/alfresco/transform/router | org.alfresco.transform.common | +| Mimetype ± | org/alfresco/transform/client/model | org.alfresco.transform.common | +| RepositoryClientData | org/alfresco/transform/router | org.alfresco.transform.common | +| RequestParamMap ± | org/alfresco/transform/client/util | org.alfresco.transform.common | +| TransformerDebug | org/alfresco/transform/router | org.alfresco.transform.common | +| | | | +| AbstractTransformOption | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| AddSupported | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| CoreFunction | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| CoreVersionDecorator | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| OverrideSupported | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| RemoveSupported | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| SupportedDefaults | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| SupportedSourceAndTarget | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| TransformConfig | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| TransformOption | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| TransformOptionGroup | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| TransformOptionValue | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| TransformStep | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| Transformer | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| TransformerAndTypes | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| TransformerTypesSizeAndPriority | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| Types | org/alfresco/transform/client/model/config | org.alfresco.transform.config | +| | | | +| TransformRequestValidator | org/alfresco/transform/client/model | org.alfresco.transform.messages | +| TransformStack | org/alfresco/transform/router | org.alfresco.transform.messages | +| | | | +| AbstractTransformRegistry | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| CombinedTransformConfig | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| Defaults | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| Origin | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| SupportedTransform | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| TransformCache | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| TransformRegistryHelper | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| TransformServiceRegistry | org/alfresco/transform/client/registry | org.alfresco.transform.registry | +| TransformerAndSourceType | org/alfresco/transform/client/registry | org.alfresco.transform.registry | + +± Classes also have a deprecated class with the same name in the original location as they are +more likely to have been used in existing transformers. diff --git a/model/pom.xml b/model/pom.xml index 6596fa7d..88758a77 100644 --- a/model/pom.xml +++ b/model/pom.xml @@ -8,7 +8,7 @@ org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT diff --git a/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/client/model/Mimetype.java b/model/src/main/java/org/alfresco/transform/client/model/Mimetype.java similarity index 71% rename from deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/client/model/Mimetype.java rename to model/src/main/java/org/alfresco/transform/client/model/Mimetype.java index 9aeeb902..994d5ca5 100644 --- a/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/client/model/Mimetype.java +++ b/model/src/main/java/org/alfresco/transform/client/model/Mimetype.java @@ -22,12 +22,9 @@ package org.alfresco.transform.client.model; /** - * @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine. - * - * This interface previously existed in the alfresco-transform-model. It now exists in the deprecated - * alfresco-transform-base and extends the new class. This should to make it easier to use the deprecated module - * by custom transformers that have not been converted to the new base. + * @deprecated will be removed in a future release when the deprecated alfresco-transform-model is removed. */ +@Deprecated public interface Mimetype extends org.alfresco.transform.common.Mimetype { } diff --git a/model/src/main/java/org/alfresco/transform/client/util/RequestParamMap.java b/model/src/main/java/org/alfresco/transform/client/util/RequestParamMap.java new file mode 100644 index 00000000..7757594a --- /dev/null +++ b/model/src/main/java/org/alfresco/transform/client/util/RequestParamMap.java @@ -0,0 +1,30 @@ +/* + * #%L + * Alfresco Transform Model + * %% + * Copyright (C) 2005 - 2022 Alfresco Software Limited + * %% + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * . + * #L% + */ +package org.alfresco.transform.client.util; + +/** + * @deprecated will be removed in a future release when the deprecated alfresco-transform-model is removed. + */ +@Deprecated +public interface RequestParamMap extends org.alfresco.transform.common.RequestParamMap +{ +} diff --git a/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/router/ExtensionService.java b/model/src/main/java/org/alfresco/transform/router/ExtensionService.java similarity index 72% rename from deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/router/ExtensionService.java rename to model/src/main/java/org/alfresco/transform/router/ExtensionService.java index ac64299e..d9b94594 100644 --- a/deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/router/ExtensionService.java +++ b/model/src/main/java/org/alfresco/transform/router/ExtensionService.java @@ -22,12 +22,9 @@ package org.alfresco.transform.router; /** - * @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine. - * - * This class previously existed in the alfresco-transform-model. It now exists in the deprecated - * alfresco-transform-base and extends the new class. This should to make it easier to use the deprecated module - * by custom transformers that have not been converted to the new base. + * @deprecated will be removed in a future release when the deprecated alfresco-transform-model is removed. */ +@Deprecated public class ExtensionService extends org.alfresco.transform.common.ExtensionService { private ExtensionService() diff --git a/pom.xml b/pom.xml index fbd8d548..9b4ab8df 100644 --- a/pom.xml +++ b/pom.xml @@ -3,7 +3,7 @@ 4.0.0 org.alfresco alfresco-transform-core - 0.0.2-HXP-SNAPSHOT + 3.0.0-HXP-A8-SNAPSHOT Alfresco Transform Core pom