Acs 1865 impl configs for da us (#634)

* ACS-1781 Config set up and validation

* ACS-1781 Unit tests for config validation

* ACS-1865 Code tidy up

* ACS-1865 Updates from PR review

* ACS-1865 Updates from review

remote-api/src/main/java/org/alfresco/rest/api/impl/directurl/RestApiDirectUrlConfig.java

@@ -0,0 +1,93 @@
+/*
+ * #%L
+ * Alfresco Repository
+ * %%
+ * Copyright (C) 2005 - 2021 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 <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.impl.directurl;
+
+import org.alfresco.repo.content.directurl.AbstractDirectUrlConfig;
+import org.alfresco.repo.content.directurl.InvalidDirectAccessUrlConfigException;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+/**
+ * REST API direct access URL configuration settings.
+ *
+ * @author Sara Aspery
+ */
+public class RestApiDirectUrlConfig extends AbstractDirectUrlConfig
+{
+    private static final Log logger = LogFactory.getLog(RestApiDirectUrlConfig.class);
+
+    /**
+     * Configuration initialise
+     */
+    public void init()
+    {
+        validate();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void validate()
+    {
+        // Disable direct access URLs for the REST API if any error found in the REST API direct access URL config
+        try
+        {
+            validateDirectAccessUrlConfig();
+        }
+        catch (InvalidDirectAccessUrlConfigException ex)
+        {
+            logger.error("Disabling REST API direct access URLs due to configuration error: " + ex.getMessage());
+            setEnabled(false);
+        }
+    }
+
+    /* Helper method to validate the REST API direct access url configuration settings */
+    private void validateDirectAccessUrlConfig() throws InvalidDirectAccessUrlConfigException
+    {
+        if (isEnabled())
+        {
+            if (getDefaultExpiryTimeInSec() == null)
+            {
+                logger.warn(String.format("Default expiry time property is missing: setting to system-wide default [%s].", getSysWideDefaultExpiryTimeInSec()));
+                setDefaultExpiryTimeInSec(getSysWideDefaultExpiryTimeInSec());
+            }
+
+            if (getDefaultExpiryTimeInSec() < 1)
+            {
+                String errorMsg = String.format("REST API direct access URL default expiry time [%s] is invalid.", getDefaultExpiryTimeInSec());
+                throw new InvalidDirectAccessUrlConfigException(errorMsg);
+            }
+
+            if (getDefaultExpiryTimeInSec() > getSysWideMaxExpiryTimeInSec())
+            {
+                String errorMsg = String.format("REST API direct access URL default expiry time [%s] exceeds system-wide maximum expiry time [%s].",
+                        getDefaultExpiryTimeInSec(), getSysWideMaxExpiryTimeInSec());
+                throw new InvalidDirectAccessUrlConfigException(errorMsg);
+            }
+        }
+    }
+}

remote-api/src/test/java/org/alfresco/AppContext04TestSuite.java

@@ -2,7 +2,7 @@
  * #%L
  * Alfresco Repository
  * %%
- * Copyright (C) 2005 - 2017 Alfresco Software Limited
+ * Copyright (C) 2005 - 2021 Alfresco Software Limited
  * %%
  * This file is part of the Alfresco software. 
  * If the software was purchased under a paid Alfresco license, the terms of 
@@ -76,6 +76,7 @@ import org.junit.runners.Suite;
     org.alfresco.repo.web.scripts.site.SurfConfigTest.class,
     org.alfresco.repo.web.scripts.node.NodeWebScripTest.class,
     org.alfresco.rest.api.impl.CommentsImplUnitTest.class,
+    org.alfresco.rest.api.impl.RestApiDirectUrlConfigUnitTest.class
 })
 public class AppContext04TestSuite
 {

remote-api/src/test/java/org/alfresco/rest/api/impl/RestApiDirectUrlConfigUnitTest.java

@@ -0,0 +1,132 @@
+/*
+ * #%L
+ * Alfresco Repository
+ * %%
+ * Copyright (C) 2005 - 2021 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 <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.impl;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import org.alfresco.repo.content.directurl.SystemWideDirectUrlConfig;
+import org.alfresco.rest.api.impl.directurl.RestApiDirectUrlConfig;
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * Tests for REST API direct access URL configuration settings.
+ *
+ * @author Sara Aspery
+ */
+public class RestApiDirectUrlConfigUnitTest
+{
+    private static final Boolean ENABLED = Boolean.TRUE;
+    private static final Boolean DISABLED = Boolean.FALSE;
+
+    private static final Long DEFAULT_EXPIRY_TIME_IN_SECS = 20L;
+
+    private RestApiDirectUrlConfig restApiDirectUrlConfig;
+
+    @Before
+    public void setup()
+    {
+        this.restApiDirectUrlConfig = new RestApiDirectUrlConfig();
+        SystemWideDirectUrlConfig sysConfig = new SystemWideDirectUrlConfig();
+        sysConfig.setEnabled(ENABLED);
+        sysConfig.setDefaultExpiryTimeInSec(30L);
+        sysConfig.setMaxExpiryTimeInSec(300L);
+        restApiDirectUrlConfig.setSystemWideDirectUrlConfig(sysConfig);
+    }
+
+    @Test
+    public void testValidConfig_RemainsEnabled()
+    {
+        setupDirectAccessConfig(ENABLED, DEFAULT_EXPIRY_TIME_IN_SECS);
+
+        assertTrue("Expected REST API direct URLs to be enabled", restApiDirectUrlConfig.isEnabled());
+        restApiDirectUrlConfig.validate();
+        assertTrue("Expected REST API direct URLs to be enabled", restApiDirectUrlConfig.isEnabled());
+    }
+
+    @Test
+    public void testValidConfig_RemainsDisabled()
+    {
+        setupDirectAccessConfig(DISABLED, DEFAULT_EXPIRY_TIME_IN_SECS);
+
+        assertFalse("Expected REST API direct URLs to be disabled", restApiDirectUrlConfig.isEnabled());
+        restApiDirectUrlConfig.validate();
+        assertFalse("Expected REST API direct URLs to be disabled", restApiDirectUrlConfig.isEnabled());
+    }
+
+    @Test
+    public void testValidConfig_DefaultExpiryTimeMissing()
+    {
+        setupDirectAccessConfig(ENABLED, null);
+
+        assertNull("Expected REST API default expiry time to be null", restApiDirectUrlConfig.getDefaultExpiryTimeInSec());
+        restApiDirectUrlConfig.validate();
+        Long expectedDefaultExpiryTime = restApiDirectUrlConfig.getSysWideDefaultExpiryTimeInSec();
+        assertEquals("Expected REST API default expiry time to be set to the system-wide default", expectedDefaultExpiryTime, restApiDirectUrlConfig.getDefaultExpiryTimeInSec());
+        assertTrue("Expected REST API direct URLs to be enabled", restApiDirectUrlConfig.isEnabled());
+    }
+
+    @Test
+    public void testInvalidConfig_DefaultExpiryTimeZero()
+    {
+        setupDirectAccessConfig(ENABLED, 0L);
+
+        assertTrue("Expected REST API direct URLs to be enabled", restApiDirectUrlConfig.isEnabled());
+        restApiDirectUrlConfig.validate();
+        assertFalse("Expected REST API direct URLs to be disabled", restApiDirectUrlConfig.isEnabled());
+    }
+
+    @Test
+    public void testInvalidConfig_DefaultExpiryTimeNegative()
+    {
+        setupDirectAccessConfig(ENABLED, -1L);
+
+        assertTrue("Expected REST API direct URLs to be enabled", restApiDirectUrlConfig.isEnabled());
+        restApiDirectUrlConfig.validate();
+        assertFalse("Expected REST API direct URLs to be disabled", restApiDirectUrlConfig.isEnabled());
+    }
+
+    @Test
+    public void testInvalidConfig_DefaultExpiryTimeExceedsSystemMax()
+    {
+        Long systemMax = restApiDirectUrlConfig.getSysWideMaxExpiryTimeInSec();
+        setupDirectAccessConfig(ENABLED, systemMax + 1);
+
+        assertTrue("Expected REST API direct URLs to be enabled", restApiDirectUrlConfig.isEnabled());
+        restApiDirectUrlConfig.validate();
+        assertFalse("Expected REST API direct URLs to be disabled", restApiDirectUrlConfig.isEnabled());
+    }
+
+    /* Helper method to set system-wide direct access url configuration settings */
+    private void setupDirectAccessConfig(Boolean isEnabled, Long defaultExpiryTime)
+    {
+        restApiDirectUrlConfig.setEnabled(isEnabled);
+        restApiDirectUrlConfig.setDefaultExpiryTimeInSec(defaultExpiryTime);
+    }
+}