1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.syncope.core.provisioning.api.macro;
20
21 import java.util.Map;
22 import java.util.Optional;
23 import javax.validation.ValidationException;
24 import org.apache.syncope.common.lib.command.CommandArgs;
25 import org.apache.syncope.common.lib.form.SyncopeForm;
26
27 /**
28 * Interface for actions to be performed during macro execution.
29 */
30 public interface MacroActions {
31
32 default Optional<String> getDefaultValue(String formProperty) {
33 return Optional.empty();
34 }
35
36 default Map<String, String> getDropdownValues(String formProperty) {
37 return Map.of();
38 }
39
40 default void validate(SyncopeForm form, Map<String, Object> vars) throws ValidationException {
41 // does nothing by default
42 }
43
44 default void beforeAll() {
45 // does nothing by default
46 }
47
48 default void beforeCommand(Command<CommandArgs> command, CommandArgs args) {
49 // does nothing by default
50 }
51
52 default void afterCommand(Command<CommandArgs> command, CommandArgs args, String output) {
53 // does nothing by default
54 }
55
56 default StringBuilder afterAll(StringBuilder output) {
57 return output;
58 }
59 }