WIP: Add Coffee management plugin for HackerBook training

client/pom.xml

@@ -28,6 +28,11 @@
         <version>4.23.0.0-SNAPSHOT</version>
     </parent>
     <dependencies>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-plugin-hackerbook-feature</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>javax.servlet</groupId>
             <artifactId>javax.servlet-api</artifactId>

engine/schema/src/main/resources/META-INF/db/schema-42200to42300.sql

@@ -18,3 +18,17 @@
 --;
 -- Schema upgrade from 4.22.0.0 to 4.23.0.0
 --;
+CREATE TABLE IF NOT EXISTS `cloud`.`coffee` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+  `uuid` varchar(40) UNIQUE,
+  `name` varchar(255) NOT NULL,
+  `offering` varchar(40) NOT NULL,
+  `size` varchar(40) NOT NULL,
+  `state` varchar(40) NOT NULL,
+  `account_id` bigint unsigned NOT NULL,
+  `created` datetime NOT NULL COMMENT 'date of creation',
+  `removed` datetime COMMENT 'date of removal',
+  PRIMARY KEY (`id`),
+  KEY (`uuid`),
+  KEY `i_coffee` (`name`, `account_id`, `created`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;

plugins/hackerbook/feature/pom.xml

@@ -0,0 +1,48 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>cloud-plugin-hackerbook-feature</artifactId>
+    <name>Apache CloudStack Plugin - HackerBook Coffee Feature</name>
+    <parent>
+        <groupId>org.apache.cloudstack</groupId>
+        <artifactId>cloudstack-plugins</artifactId>
+        <version>4.23.0.0-SNAPSHOT</version>
+        <relativePath>../../pom.xml</relativePath>
+    </parent>
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.cloudstack</groupId>
+            <artifactId>cloud-utils</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+    <properties>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+</project>

plugins/hackerbook/feature/src/main/java/org/apache/cloudstack/api/Coffee.java

@@ -0,0 +1,79 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.cloudstack.api;
+
+/**
+ * Represents a coffee order in the system.
+ * @since 4.23.0.0
+ */
+public interface Coffee extends InternalIdentity, Identity {
+
+    /**
+     * Size options for coffee orders.
+     */
+    enum Size {
+        SMALL,
+        MEDIUM,
+        LARGE
+    }
+
+    /**
+     * Available coffee offerings/types.
+     */
+    enum Offering {
+        ESPRESSO,
+        CAPPUCCINO,
+        MOCHA,
+        LATTE
+    }
+
+    /**
+     * Lifecycle states for a coffee order.
+     */
+    enum State {
+        CREATED,
+        BREWING,
+        BREWED
+    }
+
+    /**
+     * Returns the name of the coffee order.
+     * @return the coffee name
+     */
+    String getName();
+
+    /**
+     * Returns the type of coffee ordered.
+     * @return the coffee offering type
+     */
+    Offering getOffering();
+
+    /**
+     * Returns the size of the coffee order.
+     * @return the coffee size
+     */
+    Size getSize();
+
+    /**
+     * Returns the current state of the coffee order.
+     * @return the coffee state
+     */
+    State getState();
+}

plugins/hackerbook/feature/src/main/java/org/apache/cloudstack/api/CoffeeManager.java

@@ -0,0 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.cloudstack.api;
+
+import org.apache.cloudstack.api.command.CreateCoffeeCmd;
+import org.apache.cloudstack.api.command.ListCoffeeCmd;
+import org.apache.cloudstack.api.command.RemoveCoffeeCmd;
+import org.apache.cloudstack.api.command.UpdateCoffeeCmd;
+import org.apache.cloudstack.api.response.CoffeeResponse;
+
+import java.util.List;
+
+public interface CoffeeManager {
+    Coffee createCoffee(CreateCoffeeCmd cmd);
+
+    List<Coffee> listCoffees(ListCoffeeCmd cmd);
+
+    Coffee updateCoffee(UpdateCoffeeCmd cmd);
+
+    boolean removeCoffee(RemoveCoffeeCmd cmd);
+
+    CoffeeResponse createCoffeeResponse(Coffee coffee);
+
+    List<CoffeeResponse> createCoffeeResponses(List<Coffee> coffees);
+}

plugins/hackerbook/feature/src/main/java/org/apache/cloudstack/api/command/CreateCoffeeCmd.java

@@ -0,0 +1,124 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.cloudstack.api.command;
+
+import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseAsyncCreateCmd;
+import org.apache.cloudstack.api.Parameter;
+import org.apache.cloudstack.api.Coffee;
+import org.apache.cloudstack.api.CoffeeManager;
+import org.apache.cloudstack.api.response.CoffeeResponse;
+import org.apache.cloudstack.acl.RoleType;
+import org.apache.cloudstack.context.CallContext;
+
+import javax.inject.Inject;
+
+@APICommand(
+        name = CreateCoffeeCmd.APINAME,
+        description = "Creates a new coffee order",
+        responseObject = CoffeeResponse.class,
+        since = "4.23.0.0",
+        requestHasSensitiveInfo = false,
+        responseHasSensitiveInfo = false,
+        authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User}
+)
+public class CreateCoffeeCmd extends BaseAsyncCreateCmd {
+    public static final String APINAME = "createCoffee";
+
+    @Inject
+    private CoffeeManager coffeeManager;
+
+    private Coffee coffee;
+
+    /////////////////////////////////////////////////////
+    //////////////// API parameters /////////////////////
+    /////////////////////////////////////////////////////
+
+    @Parameter(name = ApiConstants.NAME,
+            type = CommandType.STRING,
+            required = true,
+            description = "name of the coffee order")
+    private String name;
+
+    @Parameter(name = "offering",
+            type = CommandType.STRING,
+            required = true,
+            description = "type of coffee (ESPRESSO, CAPPUCCINO, MOCHA, LATTE)")
+    private String offering;
+
+    @Parameter(name = "size",
+            type = CommandType.STRING,
+            required = true,
+            description = "size of coffee (SMALL, MEDIUM, LARGE)")
+    private String size;
+
+    /////////////////////////////////////////////////////
+    /////////////////// Accessors ///////////////////////
+    /////////////////////////////////////////////////////
+
+    public String getName() {
+        return name;
+    }
+
+    public String getOffering() {
+        return offering;
+    }
+
+    public String getSize() {
+        return size;
+    }
+
+    /////////////////////////////////////////////////////
+    /////////////// API Implementation///////////////////
+    /////////////////////////////////////////////////////
+
+    @Override
+    public void create() {
+        coffee = coffeeManager.createCoffee(this);
+
+        if (coffee != null) {
+            setEntityId(coffee.getId());
+            setEntityUuid(coffee.getUuid());
+        }
+    }
+
+    @Override
+    public void execute() {
+        CoffeeResponse response = coffeeManager.createCoffeeResponse(coffee);
+        response.setResponseName(getCommandName());
+        setResponseObject(response);
+    }
+
+    @Override
+    public String getEventType() {
+        return "COFFEE.CREATE";
+    }
+
+    @Override
+    public String getEventDescription() {
+        return "Creating coffee: " + name;
+    }
+
+    @Override
+    public long getEntityOwnerId() {
+        return CallContext.current().getCallingAccountId();
+    }
+}