diff --git a/repository/src/main/java/org/alfresco/repo/action/ActionExecutionContext.java b/repository/src/main/java/org/alfresco/repo/action/ActionExecutionContext.java
new file mode 100644
index 0000000000..43f88b7037
--- /dev/null
+++ b/repository/src/main/java/org/alfresco/repo/action/ActionExecutionContext.java
@@ -0,0 +1,93 @@
+/*
+ * #%L
+ * Alfresco Repository
+ * %%
+ * Copyright (C) 2022 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail. Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * Alfresco 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.
+ *
+ * Alfresco 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see .
+ * #L%
+ */
+package org.alfresco.repo.action;
+
+import java.util.Objects;
+
+/**
+ * Instances of this class are responsible for holding an action id with additional data used to identify the action's
+ * execution context like:
+ *
+ * - REST API
+ * - rules execution
+ * - ...
+ *
+ */
+public class ActionExecutionContext
+{
+ private final String actionId;
+ private final String executionSource;
+
+ private ActionExecutionContext(String actionId, String executionSource)
+ {
+ this.actionId = actionId;
+ this.executionSource = executionSource;
+ }
+
+ String getActionId()
+ {
+ return actionId;
+ }
+
+ String getExecutionSource()
+ {
+ return executionSource;
+ }
+
+ boolean isExecutionSourceKnown()
+ {
+ return Objects.nonNull(executionSource);
+ }
+
+ public static Builder builder(final String actionId)
+ {
+ Objects.requireNonNull(actionId);
+ return new Builder(actionId);
+ }
+
+ public static class Builder
+ {
+ private final String actionId;
+ private String executionSource;
+
+ private Builder(String actionId)
+ {
+ this.actionId = actionId;
+ }
+
+ public ActionExecutionContext build()
+ {
+ return new ActionExecutionContext(actionId, executionSource);
+ }
+
+ public Builder withExecutionSource(final String executionSource)
+ {
+ Objects.requireNonNull(executionSource);
+ this.executionSource = executionSource;
+ return this;
+ }
+ }
+}
diff --git a/repository/src/main/java/org/alfresco/repo/action/ActionServiceImpl.java b/repository/src/main/java/org/alfresco/repo/action/ActionServiceImpl.java
index 23d0bfdcf2..ec9de682f9 100644
--- a/repository/src/main/java/org/alfresco/repo/action/ActionServiceImpl.java
+++ b/repository/src/main/java/org/alfresco/repo/action/ActionServiceImpl.java
@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
- * Copyright (C) 2005 - 2020 Alfresco Software Limited
+ * Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
@@ -33,7 +33,14 @@ import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Properties;
import java.util.Set;
+import java.util.function.Function;
+import java.util.function.Predicate;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.evaluator.ActionConditionEvaluator;
@@ -120,6 +127,8 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
private ActionTrackingService actionTrackingService;
private PolicyComponent policyComponent;
private ActionServiceMonitor monitor;
+ private Properties configProperties;
+ private ActionExecutionValidator actionExecutionValidator;
/**
* The asynchronous action execution queues map of name, queue
@@ -236,7 +245,17 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
{
this.asynchronousActionExecutionQueues = asynchronousActionExecutionQueues;
}
-
+
+ public void setConfigurationProperties(Properties properties)
+ {
+ this.configProperties = properties;
+ }
+
+ protected Properties getConfigurationProperties()
+ {
+ return configProperties;
+ }
+
/**
* This method registers an {@link AsynchronousActionExecutionQueue} with the {@link ActionService}.
* @param key String
@@ -256,6 +275,11 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
ActionModel.TYPE_ACTION_PARAMETER, new JavaBehaviour(this, "getCopyCallback"));
this.policyComponent.bindClassBehaviour(QName.createQName(NamespaceService.ALFRESCO_URI, "onCopyComplete"),
ActionModel.TYPE_ACTION_PARAMETER, new JavaBehaviour(this, "onCopyComplete"));
+ if (configProperties == null)
+ {
+ configProperties = applicationContext.getBean("global-properties", Properties.class);
+ }
+ actionExecutionValidator = new ActionExecutionValidator(configProperties::getProperty, actionDefinitions::containsKey);
}
/**
@@ -1870,5 +1894,58 @@ public class ActionServiceImpl implements ActionService, RuntimeActionService, A
LoggingAwareExecuter executer = (LoggingAwareExecuter) this.applicationContext.getBean(action.getActionDefinitionName());
return executer.onLogException(logger,t, message);
}
-
+
+ @Override
+ public boolean isExposed(ActionExecutionContext actionExecutionContext)
+ {
+ return actionExecutionValidator.isExposed(actionExecutionContext);
+ }
+
+ static class ActionExecutionValidator
+ {
+ private final Function config;
+ private final Predicate isPublic;
+
+ ActionExecutionValidator(Function config, Predicate isPublic)
+ {
+ this.config = Objects.requireNonNull(config);
+ this.isPublic = Objects.requireNonNull(isPublic);
+ }
+
+ boolean isExposed(ActionExecutionContext actionExecutionContext)
+ {
+ Objects.requireNonNull(actionExecutionContext);
+ return isExposedInConfig(actionExecutionContext).orElseGet(() -> isPublic(actionExecutionContext));
+ }
+
+ private Optional isExposedInConfig(ActionExecutionContext actionExecutionContext)
+ {
+ return getConfigKeys(actionExecutionContext).
+ map(config).
+ filter(Objects::nonNull).
+ map(Boolean::parseBoolean).
+ findFirst();
+ }
+
+ private Boolean isPublic(ActionExecutionContext actionExecutionContext)
+ {
+ return isPublic.test(actionExecutionContext.getActionId());
+ }
+
+ private static Stream getConfigKeys(ActionExecutionContext actionExecutionContext)
+ {
+ if (actionExecutionContext.isExecutionSourceKnown())
+ {
+ return Stream.of(
+ getConfigKey(actionExecutionContext.getExecutionSource(), actionExecutionContext.getActionId()),
+ getConfigKey(actionExecutionContext.getActionId()));
+ }
+ return Stream.of(getConfigKey(actionExecutionContext.getActionId()));
+ }
+
+ static String getConfigKey(String... parts)
+ {
+ return Stream.of(parts).collect(Collectors.joining(".", "org.alfresco.repo.action.", ".exposed"));
+ }
+ }
}
diff --git a/repository/src/main/java/org/alfresco/repo/action/RuntimeActionService.java b/repository/src/main/java/org/alfresco/repo/action/RuntimeActionService.java
index d4c5f30de7..0b1b50035a 100644
--- a/repository/src/main/java/org/alfresco/repo/action/RuntimeActionService.java
+++ b/repository/src/main/java/org/alfresco/repo/action/RuntimeActionService.java
@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
- * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * Copyright (C) 2005 - 2022 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
@@ -125,4 +125,14 @@ public interface RuntimeActionService
* @return true if it was handled, false for default handling
*/
public boolean onLogException(Action action, Log logger, Throwable t, String message);
+
+ /**
+ * Allows you to check if an action can be executed/used in a given execution context
+ * @param actionExecutionContext describes action and its execution context
+ * @return true if action can be executed, false otherwise
+ */
+ default boolean isExposed(ActionExecutionContext actionExecutionContext)
+ {
+ return true;
+ }
}
diff --git a/repository/src/main/resources/alfresco/action-services-context.xml b/repository/src/main/resources/alfresco/action-services-context.xml
index 8c7f5258b4..3e55065a58 100644
--- a/repository/src/main/resources/alfresco/action-services-context.xml
+++ b/repository/src/main/resources/alfresco/action-services-context.xml
@@ -75,6 +75,9 @@