View Javadoc
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.persistence.jpa.entity.task;
20  
21  import com.fasterxml.jackson.core.type.TypeReference;
22  import java.util.ArrayList;
23  import java.util.List;
24  import javax.persistence.CascadeType;
25  import javax.persistence.Entity;
26  import javax.persistence.FetchType;
27  import javax.persistence.JoinColumn;
28  import javax.persistence.JoinTable;
29  import javax.persistence.Lob;
30  import javax.persistence.ManyToMany;
31  import javax.persistence.ManyToOne;
32  import javax.persistence.OneToMany;
33  import javax.persistence.PostLoad;
34  import javax.persistence.PostPersist;
35  import javax.persistence.PostUpdate;
36  import javax.persistence.PrePersist;
37  import javax.persistence.PreUpdate;
38  import javax.persistence.Table;
39  import javax.persistence.Transient;
40  import javax.persistence.UniqueConstraint;
41  import javax.validation.constraints.NotNull;
42  import org.apache.syncope.common.lib.command.CommandArgs;
43  import org.apache.syncope.common.lib.types.IdRepoImplementationType;
44  import org.apache.syncope.core.persistence.api.entity.Implementation;
45  import org.apache.syncope.core.persistence.api.entity.Realm;
46  import org.apache.syncope.core.persistence.api.entity.task.MacroTask;
47  import org.apache.syncope.core.persistence.api.entity.task.SchedTask;
48  import org.apache.syncope.core.persistence.api.entity.task.TaskExec;
49  import org.apache.syncope.core.persistence.jpa.entity.JPAImplementation;
50  import org.apache.syncope.core.persistence.jpa.entity.JPARealm;
51  import org.apache.syncope.core.provisioning.api.serialization.POJOHelper;
52  
53  @Entity
54  @Table(name = JPAMacroTask.TABLE)
55  public class JPAMacroTask extends JPASchedTask implements MacroTask {
56  
57      private static final long serialVersionUID = 8261850094316787406L;
58  
59      public static final String TABLE = "MacroTask";
60  
61      protected static final TypeReference<List<CommandArgs>> TYPEREF = new TypeReference<List<CommandArgs>>() {
62      };
63  
64      @ManyToOne(fetch = FetchType.EAGER, optional = false)
65      private JPARealm realm;
66  
67      @NotNull
68      private Boolean continueOnError = false;
69  
70      @NotNull
71      private Boolean saveExecs = true;
72  
73      @ManyToMany(fetch = FetchType.EAGER)
74      @JoinTable(name = TABLE + "Commands",
75              joinColumns =
76              @JoinColumn(name = "task_id"),
77              inverseJoinColumns =
78              @JoinColumn(name = "implementation_id"),
79              uniqueConstraints =
80              @UniqueConstraint(columnNames = { "task_id", "implementation_id" }))
81      private List<JPAImplementation> commands = new ArrayList<>();
82  
83      @Lob
84      private String commandArgs;
85  
86      @Transient
87      private final List<CommandArgs> commandArgsList = new ArrayList<>();
88  
89      @OneToMany(targetEntity = JPAMacroTaskExec.class,
90              cascade = CascadeType.ALL, orphanRemoval = true, mappedBy = "task")
91      private List<TaskExec<SchedTask>> executions = new ArrayList<>();
92  
93      @Override
94      public Realm getRealm() {
95          return realm;
96      }
97  
98      @Override
99      public void setRealm(final Realm realm) {
100         checkType(realm, JPARealm.class);
101         this.realm = (JPARealm) realm;
102     }
103 
104     @Override
105     public void add(final Implementation command, final CommandArgs args) {
106         checkType(command, JPAImplementation.class);
107         checkImplementationType(command, IdRepoImplementationType.COMMAND);
108         commands.add((JPAImplementation) command);
109 
110         getCommandArgs().add(args);
111     }
112 
113     @Override
114     public List<JPAImplementation> getCommands() {
115         return commands;
116     }
117 
118     @Override
119     public List<CommandArgs> getCommandArgs() {
120         return commandArgsList;
121     }
122 
123     @Override
124     public boolean isContinueOnError() {
125         return continueOnError == null ? false : continueOnError;
126     }
127 
128     @Override
129     public void setContinueOnError(final boolean continueOnError) {
130         this.continueOnError = continueOnError;
131     }
132 
133     @Override
134     public boolean isSaveExecs() {
135         return saveExecs == null ? true : saveExecs;
136     }
137 
138     @Override
139     public void setSaveExecs(final boolean saveExecs) {
140         this.saveExecs = saveExecs;
141     }
142 
143     @Override
144     protected Class<? extends TaskExec<SchedTask>> executionClass() {
145         return JPAMacroTaskExec.class;
146     }
147 
148     @Override
149     protected List<TaskExec<SchedTask>> executions() {
150         return executions;
151     }
152 
153     protected void json2list(final boolean clearFirst) {
154         if (clearFirst) {
155             getCommandArgs().clear();
156         }
157         if (commandArgs != null) {
158             getCommandArgs().addAll(POJOHelper.deserialize(commandArgs, TYPEREF));
159         }
160     }
161 
162     @PostLoad
163     public void postLoad() {
164         json2list(false);
165     }
166 
167     @PostPersist
168     @PostUpdate
169     public void postSave() {
170         json2list(true);
171     }
172 
173     @PrePersist
174     @PreUpdate
175     public void list2json() {
176         commandArgs = POJOHelper.serialize(getCommandArgs(), TYPEREF);
177     }
178 }