| /* |
| * 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.nifi.web.dao; |
| |
| import org.apache.nifi.components.state.Scope; |
| import org.apache.nifi.components.state.StateMap; |
| import org.apache.nifi.groups.RemoteProcessGroup; |
| import org.apache.nifi.remote.RemoteGroupPort; |
| import org.apache.nifi.web.api.dto.RemoteProcessGroupDTO; |
| import org.apache.nifi.web.api.dto.RemoteProcessGroupPortDTO; |
| |
| import java.util.Set; |
| |
| public interface RemoteProcessGroupDAO { |
| |
| /** |
| * Determines if the specified remote process group exists. |
| * |
| * @param remoteProcessGroupId group id |
| * @return true if the specified remote process group exists |
| */ |
| boolean hasRemoteProcessGroup(String remoteProcessGroupId); |
| |
| /** |
| * Creates a remote process group reference. |
| * |
| * @param groupId group id |
| * @param remoteProcessGroup The remote process group |
| * @return The remote process group |
| */ |
| RemoteProcessGroup createRemoteProcessGroup(String groupId, RemoteProcessGroupDTO remoteProcessGroup); |
| |
| /** |
| * Gets the specified remote process group. |
| * |
| * @param remoteProcessGroupId The remote process group id |
| * @return The remote process group |
| */ |
| RemoteProcessGroup getRemoteProcessGroup(String remoteProcessGroupId); |
| |
| /** |
| * Gets all of the remote process groups. |
| * |
| * @param groupId group id |
| * @return The remote process groups |
| */ |
| Set<RemoteProcessGroup> getRemoteProcessGroups(String groupId); |
| |
| /** |
| * Verifies the specified remote process group can be updated. |
| * |
| * @param remoteProcessGroup group |
| */ |
| void verifyUpdate(RemoteProcessGroupDTO remoteProcessGroup); |
| |
| /** |
| * Verifies the specified remote process group input port can be updated. |
| * |
| * @param remoteProcessGroupId process group id |
| * @param remoteProcessGroupPort port |
| */ |
| void verifyUpdateInputPort(String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort); |
| |
| /** |
| * Verifies the specified remote process group input port can be updated. |
| * |
| * @param remoteProcessGroupId group id |
| * @param remoteProcessGroupPort group port |
| */ |
| void verifyUpdateOutputPort(String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort); |
| |
| /** |
| * Updates the specified remote process group. |
| * |
| * @param remoteProcessGroup The remote process group |
| * @return The remote process group |
| */ |
| RemoteProcessGroup updateRemoteProcessGroup(RemoteProcessGroupDTO remoteProcessGroup); |
| |
| /** |
| * Updates the specified remote process group input port. |
| * |
| * @param remoteProcessGroupId id |
| * @param remoteProcessGroupPort port |
| * @return updated group port |
| */ |
| RemoteGroupPort updateRemoteProcessGroupInputPort(String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort); |
| |
| /** |
| * Updates the specified remote process group output port. |
| * |
| * @param remoteProcessGroupId group id |
| * @param remoteProcessGroupPort port |
| * @return group port |
| */ |
| RemoteGroupPort updateRemoteProcessGroupOutputPort(String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort); |
| |
| /** |
| * Verifies the specified remote process group can be removed. |
| * |
| * @param remoteProcessGroupId group id |
| */ |
| void verifyDelete(String remoteProcessGroupId); |
| |
| /** |
| * Deletes the specified remote process group. |
| * |
| * @param remoteProcessGroupId The remote process group id |
| */ |
| void deleteRemoteProcessGroup(String remoteProcessGroupId); |
| |
| /** |
| * Gets the specified RemoteProcessGroupId. |
| * |
| * @param remoteProcessGroupId RemoteProcessGroupId id |
| * @return state map |
| */ |
| StateMap getState(String remoteProcessGroupId, Scope scope); |
| } |