001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.juneau.petstore.console.pages; 018 019import java.util.*; 020 021import org.apache.juneau.commons.beanquery.*; 022import org.apache.juneau.terminal.region.*; 023import org.apache.juneau.console.freemarker.*; 024import org.apache.juneau.console.views.*; 025import org.apache.juneau.console.views.RowAction.*; 026import org.apache.juneau.console.views.TableSpec.*; 027 028/** 029 * Builder twins of the Operations pages: P6 Jobs ({@code jobs.ftlh}) and P7 Audit ({@code audit.ftlh}). 030 * 031 * <h2 class='section'>Example:</h2> 032 * <p class='bjava'> 033 * <jk>return</jk> <jsm>twin</jsm>(<jv>req</jv>, OpsPageBuilders.<jsm>audit</jsm>()); 034 * </p> 035 */ 036@SuppressWarnings({ 037 "java:S1192" // Page-definition ids and labels repeat as inline literals by design. 038}) 039public final class OpsPageBuilders { 040 041 private OpsPageBuilders() {} 042 043 /** 044 * P6 Jobs. 045 * 046 * @param groomOutput The latest groom run's terminal. 047 * @param groomFile The latest groom run's transcript file. 048 * @return The page spec. 049 */ 050 public static PageSpec jobs(TerminalDef groomOutput, TerminalDef groomFile) { 051 return PageSpec.create().tab("ops/jobs").toolkit("views", "datatables-buttons") 052 .card(SwitcherDef.create("jobs-sw").style(SwitcherDef.STYLE_SLIDER).initialView("restock") 053 .view("restock", "Restock", v -> v.cards( 054 CardSpec.html("restock-help").title("Restocking").src("/console/ops/jobs/fragments/restock-help"), 055 restockJobLog())) 056 .view("jobs", "Jobs", v -> v.section(SwitcherCards.table(jobsTable()))) 057 .view("species", "Species", v -> v.section(SwitcherCards.table(speciesTable()))) 058 .view("groom", "Groom", v -> v.cards( 059 CardSpec.of("terminal", "groom-output").title("Groom run").body("terminal", groomOutput.toMap()), 060 CardSpec.of("terminal", "groom-file").title("Groom transcript (file)").body("terminal", groomFile.toMap()), 061 SwitcherCards.table(groomRunsTable()))) 062 .toCardSpec()); 063 } 064 065 private static CardSpec restockJobLog() { 066 return CardSpec.of("job-log", "restock").title("Restock inventory") 067 .body("submit", Map.of("endpoint", "/console/ops/jobs/restock", "submitLabel", "Restock", "fields", List.of( 068 Map.of("name", "DOG", "label", "Dogs (0-50)", "type", "number", "default", 1), 069 Map.of("name", "slowMs", "label", "Wait before restocking (ms, 0-10000)", "type", "number", "default", 0), 070 Map.of("name", "holdMs", "label", "Hold after restocking (ms, 0-10000)", "type", "number", "default", 1000)))) 071 .body("urlParam", "job"); 072 } 073 074 private static TableSpec jobsTable() { 075 return TableSpec.create("jobs").dataMode(DataMode.CLIENT).dataUrl("/console/ops/jobs/rows") 076 .pollIntervalMs(2000) 077 .columnConfig(true) 078 .columns( 079 Column.create("jobId").label("Job"), 080 Column.create("submitted").label("Submitted").render("timestamp"), 081 Column.create("state").label("State").render(PillRenders.jobState()), 082 Column.create("result.message").label("Result")) 083 .ribbon(Ribbons.standard() 084 .create(RibbonItem.dialog("restock").title("Restock").endpoint("/console/ops/jobs/restock").method(Method.POST).form("/console/ops/jobs/restock-form")) 085 .build()); 086 } 087 088 private static TableSpec speciesTable() { 089 return TableSpec.create("species").dataMode(DataMode.CLIENT).dataUrl("/console/ops/jobs/species") 090 .pollIntervalMs(2000) 091 .columnConfig(true) 092 .columns( 093 Column.create("species").label("Species").render(PillRenders.species()), 094 Column.create("available").label("Available")) 095 .detail(RowDetail.create("/console/ops/jobs/species/{id}").region(JobLogRegion.create("restock-species") 096 .submit(JobLogRegion.Submit.create("/console/ops/jobs/species/{id}/restock", "restock-species", "/console/ops/jobs/species/{id}/key") 097 .submitLabel("Restock") 098 .field(JobLogRegion.Field.of("count").label("How many (1-50)").type("number").defaultValue(1).required(true)) 099 .field(JobLogRegion.Field.of("species").type("hidden").source("row.species"))) 100 .detail(JobLogRegion.Detail.of("fieldGrid", RegionDef.Field.of("available").label("Available"))) 101 .output(JobLogRegion.Output.field("available").from("row.available")) 102 .toRegion())) 103 .ribbon(Ribbons.standard().build()); 104 } 105 106 private static TableSpec groomRunsTable() { 107 return TableSpec.create("groom-runs").dataMode(DataMode.CLIENT).dataUrl("/console/ops/jobs/groom-rows") 108 .columns( 109 Column.create("pet").label("Pet"), 110 Column.create("submitted").label("Submitted").render("timestamp"), 111 Column.create("state").label("State").render(PillRenders.jobState()), 112 Column.create("lines").label("Lines")) 113 .detail(RowDetail.create("/console/ops/jobs/groom-runs/{id}") 114 .region(RegionDef.create("regroom").type(RegionDef.TYPE_ROW_DETAIL).populate("petstore-regroom").allowPopulators("petstore-regroom"))) 115 .columnConfig(true) 116 .ribbon(Ribbons.standard() 117 .create(RibbonItem.dialog("groom").title("Groom").endpoint("/console/ops/jobs/groom").method(Method.POST).form("/console/ops/jobs/groom-form")) 118 .refreshId("groom-refresh") 119 .build()); 120 } 121 122 /** 123 * P7 Audit. 124 * 125 * @return The page spec. 126 */ 127 public static PageSpec audit() { 128 return PageSpec.create().tab("ops/audit").toolkit("views", "datatables-buttons") 129 .table(TableSpec.create("audit").dataMode(DataMode.SERVER).dataUrl("/console/ops/audit/query") 130 .operators(SearchOperatorSet.standard()) 131 .defaultOrder("at", Sort.DESC) 132 .detail(RowDetails.audit()) 133 .columns( 134 Column.create("id").label("Id").defaultVisible(false), 135 Column.create("at").label("When").render("timestamp").searchType(SearchType.TIMESTAMP), 136 Column.create("actor").label("Actor").searchType(SearchType.TEXT), 137 Column.create("action").label("Action").render(PillRenders.auditAction()).searchType(SearchType.TEXT), 138 Column.create("entity").label("Entity").render(PillRenders.entity()).searchType(SearchType.TEXT), 139 Column.create("entityId").label("Id").searchType(SearchType.TEXT), 140 Column.create("detail").label("Detail").searchType(SearchType.TEXT)) 141 .columnConfig(true) 142 .ribbon(Ribbons.standard().build())); 143 } 144}