diff --git a/README.md b/README.md index 936169cc..300cdfa4 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,15 @@ Contains the common transformer (T-Engine) code, plus a few implementations. +> 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) + ### Sub-projects * `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. **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.** + and transform options. * `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 diff --git a/deprecated/alfresco-transformer-base/README.md b/deprecated/alfresco-transformer-base/README.md index 2a22a603..caceb46e 100644 --- a/deprecated/alfresco-transformer-base/README.md +++ b/deprecated/alfresco-transformer-base/README.md @@ -7,7 +7,6 @@ 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/model/README.md b/model/README.md index 29eac6f3..335d3c61 100644 --- a/model/README.md +++ b/model/README.md @@ -9,44 +9,44 @@ have moved. Hopefully they are now located in more logical packages. Most classe 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 | +| 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.