Deprecate the old base

This commit is contained in:
alandavis
2022-08-03 12:41:14 +01:00
parent 331d9655fa
commit 9e2952d4fd
36 changed files with 121 additions and 24 deletions

View File

@@ -99,6 +99,8 @@ import static org.springframework.http.MediaType.MULTIPART_FORM_DATA_VALUE;
import static org.springframework.util.StringUtils.getFilenameExtension;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* <p>Abstract Controller, provides structure and helper methods to sub-class transformer controllers. Sub classes
* should implement {@link #transformImpl(String, String, String, Map, File, File)} and unimplemented methods from
* {@link TransformController}.</p>
@@ -128,6 +130,7 @@ import static org.springframework.util.StringUtils.getFilenameExtension;
* <p>Provides methods to help super classes perform /transform requests. Also responses to /version, /ready and /live
* requests.</p>
*/
@Deprecated
public abstract class AbstractTransformerController implements TransformController
{
private static final Logger logger = LoggerFactory.getLogger(

View File

@@ -50,6 +50,8 @@ import org.springframework.jms.support.converter.MessageConversionException;
import org.springframework.stereotype.Component;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Queue Transformer service.
* This service reads all the requests for the particular engine, forwards them to the worker
* component (at this time the injected controller - to be refactored) and sends back the reply
@@ -58,6 +60,7 @@ import org.springframework.stereotype.Component;
* @author Lucian Tuca
* created on 18/12/2018
*/
@Deprecated
@Component
@ConditionalOnProperty(name = "activemq.url")
public class QueueTransformService

View File

@@ -54,11 +54,14 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* TransformController interface.
* <br/>
* It contains much of the common boilerplate code that each of
* its concrete implementations need as default methods.
*/
@Deprecated
public interface TransformController
{
Logger logger = LoggerFactory.getLogger(TransformController.class);

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -37,10 +37,13 @@ import org.alfresco.transformer.logging.LogEntry;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* TransformInterceptor
* <br/>
* Handles ThreadLocal Log entries for each request.
*/
@Deprecated
public class TransformInterceptor extends HandlerInterceptorAdapter
{
@Override

View File

@@ -50,8 +50,11 @@ import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.core.io.ResourceLoader;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Used by clients to work out if a transformation is supported based on the engine_config.json.
*/
@Deprecated
public class TransformRegistryImpl extends AbstractTransformRegistry
{
private static final Logger log = LoggerFactory.getLogger(TransformRegistryImpl.class);

View File

@@ -45,8 +45,11 @@ import org.springframework.web.client.HttpClientErrorException;
import org.springframework.web.client.RestTemplate;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Simple Rest client that call Alfresco Shared File Store
*/
@Deprecated
public class AlfrescoSharedFileStoreClient
{
@Value("${fileStoreUrl}")

View File

@@ -40,6 +40,10 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import static org.alfresco.transform.common.RequestParamMap.ENDPOINT_TRANSFORM;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*/
@Deprecated
@Configuration
public class WebApplicationConfig implements WebMvcConfigurer
{

View File

@@ -36,8 +36,9 @@ import java.util.Map;
import org.alfresco.transform.common.TransformException;
/**
*
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*/
@Deprecated
public abstract class AbstractCommandExecutor implements CommandExecutor
{
protected RuntimeExec transformCommand = createTransformCommand();

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2020 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -33,10 +33,13 @@ import java.util.HashMap;
import java.util.Map;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Basic interface for executing transformations via Shell commands
*
* @author Cezar Leahu
*/
@Deprecated
public interface CommandExecutor extends Transformer
{
void run(Map<String, String> properties, File targetFile, Long timeout);

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -35,6 +35,8 @@ import java.util.Objects;
import java.util.StringTokenizer;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* DUPLICATED FROM *alfresco-core*.
*
* This class is used to tokenize strings used as parameters for {@link RuntimeExec} objects.
@@ -61,6 +63,7 @@ import java.util.StringTokenizer;
* @author Neil Mc Erlean
* @since 3.4.2
*/
@Deprecated
public class ExecParameterTokenizer
{
/**

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2020 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -29,11 +29,14 @@ package org.alfresco.transformer.executors;
import java.io.File;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Basic interface for executing transformations inside Java/JVM.
*
* @author Cezar Leahu
* @author adavis
*/
@Deprecated
public interface JavaExecutor extends Transformer
{
void call(File sourceFile, File targetFile, String... args) throws Exception;

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -50,6 +50,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* DUPLICATED FROM *alfresco-core*.
*
* This acts as a session similar to the <code>java.lang.Process</code>, but
@@ -100,6 +102,7 @@ import org.slf4j.LoggerFactory;
*
* @author Derek Hulley
*/
@Deprecated
public class RuntimeExec
{
private static final Logger logger = LoggerFactory.getLogger(RuntimeExec.class);

View File

@@ -39,10 +39,13 @@ import static org.springframework.http.HttpStatus.BAD_REQUEST;
import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Basic interface for executing transforms and metadata extract or embed actions.
*
* @author adavis
*/
@Deprecated
public interface Transformer
{
/**

View File

@@ -53,8 +53,9 @@ import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.util.UriUtils;
/**
*
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*/
@Deprecated
public class FileManager
{
public static final String SOURCE_FILE = "sourceFile";

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -40,11 +40,14 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Provides setter and getter methods to allow the current Thread to set various log properties and for these
* values to be retrieved. The {@link #complete()} method should be called at the end of a request to flush the
* current entry to an internal log Collection of the latest entries. The {@link #getLog()} method is used to obtain
* access to this collection.
*/
@Deprecated
public final class LogEntry
{
private static final Logger logger = LoggerFactory.getLogger(LogEntry.class);

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -26,6 +26,10 @@
*/
package org.alfresco.transformer.logging;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*/
@Deprecated
public interface StandardMessages
{
String LICENCE =

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -46,12 +46,15 @@ import org.springframework.messaging.handler.annotation.support.DefaultMessageHa
import org.springframework.transaction.PlatformTransactionManager;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* JMS and messaging configuration for the T-Engines. Contains the basic config in order to have the
* T-Engine able to read from queues and send a reply back.
*
* @author Lucian Tuca
* created on 18/12/2018
*/
@Deprecated
@Configuration
@ConditionalOnProperty(name = "activemq.url")
public class MessagingConfig implements JmsListenerConfigurer

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2020 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -34,10 +34,13 @@ import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Prints JMS status information at application startup.
*
* @author Cezar Leahu
*/
@Deprecated
@Configuration
public class MessagingInfo
{

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -44,11 +44,14 @@ import javax.jms.Message;
import javax.jms.Session;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* TODO: Duplicated from the Router
* Custom wrapper over MappingJackson2MessageConverter for T-Request/T-Reply objects.
*
* @author Cezar Leahu
*/
@Deprecated
@Service
public class TransformMessageConverter implements MessageConverter
{

View File

@@ -36,6 +36,8 @@ import org.springframework.jms.core.JmsTemplate;
import org.springframework.stereotype.Component;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* TODO: Duplicated from the Router
* TransformReplySender Bean
* <p/>
@@ -43,6 +45,7 @@ import org.springframework.stereotype.Component;
*
* @author Cezar Leahu
*/
@Deprecated
@Component
public class TransformReplySender
{

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005-2021 Alfresco Software Limited
* Copyright (C) 2005-2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -49,6 +49,8 @@ import java.util.StringTokenizer;
import java.util.TreeMap;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Helper methods for metadata extract and embed.
* <p>
* <i>Much of the code is based on AbstractMappingMetadataExtracter from the
@@ -91,6 +93,7 @@ import java.util.TreeMap;
* @author Derek Hulley
* @author adavis
*/
@Deprecated
public abstract class AbstractMetadataExtractor
{
private static final String EXTRACT = "extract";

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -29,10 +29,13 @@ package org.alfresco.transformer.model;
import java.util.Objects;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* TODO: Copied from org.alfresco.store.entity (alfresco-shared-file-store). To be discussed
*
* POJO that represents content reference ({@link java.util.UUID})
*/
@Deprecated
public class FileRefEntity
{
private String fileRef;

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -27,10 +27,13 @@
package org.alfresco.transformer.model;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* TODO: Copied from org.alfresco.store.entity (alfresco-shared-file-store). To be discussed
*
* POJO that describes the ContentRefEntry response, contains {@link FileRefEntity} according to API spec
*/
@Deprecated
public class FileRefResponse
{
private FileRefEntity entry;

View File

@@ -51,6 +51,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Provides the logic performing test transformations by the live and ready probes.
*
* <p><b>K8s probes</b>: A readiness probe indicates if the pod should accept request. <b>It does not indicate that a pod is
@@ -72,6 +74,7 @@ import org.slf4j.LoggerFactory;
* <li>maxTransformSeconds - the maximum time for a transformation, including failed ones.</li>
* </ul>
*/
@Deprecated
public abstract class ProbeTestTransform
{
private final Logger logger = LoggerFactory.getLogger(ProbeTestTransform.class);

View File

@@ -27,9 +27,12 @@
package org.alfresco.transformer.util;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Extends the list of transform options with historic request parameters or 'extra' parameters used in testing
* or communication in the all-in-one transformer.
*/
@Deprecated
public interface RequestParamMap extends org.alfresco.transform.common.RequestParamMap
{
// This property can be sent by acs repository's legacy transformers to force a transform,

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -26,6 +26,10 @@
*/
package org.alfresco.transformer.util;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*/
@Deprecated
public class Util
{
/**

View File

@@ -43,9 +43,12 @@ import org.springframework.http.ResponseEntity;
import org.springframework.util.LinkedMultiValueMap;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Super class for testing controllers with a server. Includes tests for the AbstractTransformerController itself.
* Note: Currently uses json rather than HTML as json is returned by this spring boot test harness.
*/
@Deprecated
public abstract class AbstractHttpRequestTest
{
@LocalServerPort

View File

@@ -47,6 +47,8 @@ import org.springframework.core.io.Resource;
import org.springframework.http.ResponseEntity;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Super class of metadata integration tests. Sub classes should provide the following:
* <p>
* <ul>
@@ -72,6 +74,7 @@ import org.springframework.http.ResponseEntity;
* @author adavis
* @author dedwards
*/
@Deprecated
public abstract class AbstractMetadataExtractsIT
{
private static final String ENGINE_URL = "http://localhost:8090";

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2021 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -39,9 +39,12 @@ import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.jms.core.JmsTemplate;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* @author Lucian Tuca
* created on 15/01/2019
*/
@Deprecated
@SpringBootTest(properties = {"activemq.url=nio://localhost:61616"})
public abstract class AbstractQueueTransformServiceIT
{

View File

@@ -95,8 +95,11 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Super class for testing controllers without a server. Includes tests for the AbstractTransformerController itself.
*/
@Deprecated
public abstract class AbstractTransformerControllerTest
{
@TempDir // added as part of ATS-702 to allow test resources to be read from the imported jar files to prevent test resource duplication

View File

@@ -23,8 +23,11 @@ import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestTemplate;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* @author Cezar Leahu
*/
@Deprecated
public class EngineClient
{
private static final RestTemplate REST_TEMPLATE = new RestTemplate();

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2021 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -55,6 +55,10 @@ import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.jms.support.converter.MessageConversionException;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*/
@Deprecated
public class QueueTransformServiceTest
{
@Mock

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -29,10 +29,13 @@ package org.alfresco.transformer;
import java.util.Objects;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
*
* Source & Target media type pair
*
* @author Cezar Leahu
*/
@Deprecated
public class SourceTarget
{
public final String source;

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Transform Core
* %%
* Copyright (C) 2005 - 2019 Alfresco Software Limited
* Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
@@ -27,8 +27,10 @@
package org.alfresco.transformer;
/**
* @deprecated will be removed in a future release. Replaced by alfresco-base-t-engine.
* @author Cezar Leahu
*/
@Deprecated
public class TestFileInfo
{
private final String mimeType;

View File

@@ -35,8 +35,6 @@ import java.util.Objects;
import java.util.StringTokenizer;
/**
* DUPLICATED FROM *alfresco-core*.
*
* This class is used to tokenize strings used as parameters for {@link RuntimeExec} objects.
* Examples of such strings are as follows (ImageMagick-like parameters):
* <ul>

View File

@@ -50,8 +50,6 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* DUPLICATED FROM *alfresco-core*.
*
* This acts as a session similar to the <code>java.lang.Process</code>, but
* logs the system standard and error streams.
* <p>