Support Renaming Containers (#55)

Author: RosalineP

CHANGELOG.md

@@ -1,8 +1,12 @@
 # The LabKey Remote API Library for Java - Change Log
 
-## version 5.2.0-SNAPSHOT
+## version 5.3.0-SNAPSHOT
 *Released*: TBD
 
+## version 5.2.0
+*Released*: 3 May 2023
+* Add `RenameContainerCommand` and `RenameContainerResponse`
+
 ## version 5.1.0
 *Released*: 3 March 2023
 * Delegate first request behavior to the configured `CredentialsProvider`. Connection-based providers invoke

README.md

@@ -44,12 +44,6 @@ follow is to use your feature branch in the naming of that version (e.g., `X.Y.Z
 TeamCity will automatically publish new SNAPSHOT versions from feature branches.
 - Update your `$LABKEY_ROOT/settings.gradle` file to include this project (`include ':remoteapi:labkey-api-java'`)
 
-After making these changes, in all places where a dependency on the Java API has been declared like so: 
-
-```gradle
-BuildUtils.addLabKeyDependency(project: project, config: "remoteApi", depProjectPath: BuildUtils.getRemoteApiProjectPath(gradle), depVersion: project.labkeyClientApiVersion)
-```
-
 Gradle will now pull in the locally built version instead. To start using a published
 version instead, revert the change to the `settings.gradle` file (and, if necessary, update the `labkeyClientApiVersion`
 in the `$LABKEY_ROOT/gradle.properties` file).

build.gradle

@@ -48,7 +48,7 @@ repositories {
 
 group "org.labkey.api"
 
-version "5.2.0-SNAPSHOT"
+version "5.3.0-SNAPSHOT"
 
 dependencies {
     api "org.json:json:${jsonObjectVersion}"

src/org/labkey/remoteapi/security/RenameContainerCommand.java

@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2009 LabKey Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.labkey.remoteapi.security;
+
+import org.labkey.remoteapi.PostCommand;
+
+import org.json.JSONObject;
+
+/**
+ * Rename a container on the server
+ */
+public class RenameContainerCommand extends PostCommand<RenameContainerResponse> {
+    private String _name;
+    private String _title;
+    private boolean _addAlias = true;
+
+
+    public RenameContainerCommand(String name, String title, boolean addAlias)
+    {
+        super("admin", "RenameContainer");
+        _name = name;
+        _title = title;
+        _addAlias = addAlias;
+    }
+
+    @Override
+    public JSONObject getJsonObject()
+    {
+        JSONObject result = new JSONObject();
+        result.put("name", _name);
+        result.put("title", _title);
+        result.put("addAlias", _addAlias);
+
+        return result;
+    }
+
+    public String getName()
+    {
+        return _name;
+    }
+
+    public void setName(String name)
+    {
+        _name = name;
+    }
+
+    public String getTitle()
+    {
+        return _title;
+    }
+
+    public void setTitle(String title)
+    {
+        _title = title;
+    }
+
+    public boolean isAddAlias()
+    {
+        return _addAlias;
+    }
+
+    public void setAddAlias(boolean addAlias)
+    {
+        _addAlias = addAlias;
+    }
+
+    @Override
+    protected RenameContainerResponse createResponse(String text, int status, String contentType, JSONObject json)
+    {
+        return new RenameContainerResponse(text, status, contentType, json);
+    }
+
+}

src/org/labkey/remoteapi/security/RenameContainerResponse.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2012-2013 LabKey Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.labkey.remoteapi.security;
+
+import org.json.JSONObject;
+import org.labkey.remoteapi.CommandResponse;
+
+public class RenameContainerResponse extends CommandResponse
+{
+    public RenameContainerResponse(String text, int statusCode, String contentType, JSONObject json)
+    {
+        super(text, statusCode, contentType, json);
+    }
+
+    public String getPath()
+    {
+        return getProperty("path");
+    }
+
+    public String getName()
+    {
+        return getProperty("name");
+    }
+}