inteligr8/alfresco-transform-core
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-transform-core.git synced 2025-08-14 17:58:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Go back to 3.0.0-HXP-A8-SNAPSHOT as the version must be > 2.6.0 for the tests to work.

Browse Source 
Also add duplicate classes into the t-model
This commit is contained in:
alandavis
2022-09-12 19:56:24 +01:00
parent 7f2e76e33c
commit 6cf0287674
18 changed files with 103 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -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/<name>` - 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

4
deprecated/alfresco-transformer-base/README.md
View File

@@ -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.

2
deprecated/alfresco-transformer-base/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transformer/util/RequestParamMap.java
View File

@@ -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.

2
engines/aio/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
engines/base/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
engines/example/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
engines/imagemagick/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
engines/libreoffice/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
engines/misc/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
engines/pdfrenderer/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

2
engines/tika/pom.xml
View File

@@ -7,7 +7,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

52
model/README.md
View File

@@ -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.
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.

2
model/pom.xml
View File

@@ -8,7 +8,7 @@
<parent>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
</parent>
<properties>

7
deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/client/model/Mimetype.java → model/src/main/java/org/alfresco/transform/client/model/Mimetype.java
View File

@@ -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
{
}

30
model/src/main/java/org/alfresco/transform/client/util/RequestParamMap.java Normal file
View File

@@ -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
* <http://www.gnu.org/licenses/lgpl-3.0.html>.
* #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
{
}

7
deprecated/alfresco-transformer-base/src/main/java/org/alfresco/transform/router/ExtensionService.java → model/src/main/java/org/alfresco/transform/router/ExtensionService.java
View File

@@ -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()

2
pom.xml
View File

@@ -3,7 +3,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.alfresco</groupId>
<artifactId>alfresco-transform-core</artifactId>
<version>0.0.2-HXP-SNAPSHOT</version>
<version>3.0.0-HXP-A8-SNAPSHOT</version>
<name>Alfresco Transform Core</name>
<packaging>pom</packaging>