summaryrefslogtreecommitdiffstats
path: root/infra/translate-spi/src/main/java/io/fd/honeycomb/translate/spi/write/WriterCustomizer.java
blob: 8148657dad7a5237b038d8b349d60b1f943bb47c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 *
 * Licensed 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 io.fd.honeycomb.translate.spi.write;

import com.google.common.annotations.Beta;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.write.WriteFailedException;
import javax.annotation.Nonnull;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;

/**
 * CompositeChildWriter SPI to customize its behavior.
 *
 * @param <D> Specific DataObject derived type (Identifiable), that is handled by this customizer
 */
@Beta
public interface WriterCustomizer<D extends DataObject> {

    /**
     * Handle write operation. C from CRUD.
     *
     * @param id Identifier(from root) of data being written
     * @param dataAfter New data to be written
     * @param writeContext Write context can be used to store any useful information and then utilized by other customizers
     *
     * @throws WriteFailedException if write was unsuccessful
     */
    void writeCurrentAttributes(@Nonnull final InstanceIdentifier<D> id,
                                @Nonnull final D dataAfter,
                                @Nonnull final WriteContext writeContext) throws WriteFailedException;

    /**
     * Handle update operation. U from CRUD.
     *
     * @param id Identifier(from root) of data being written
     * @param dataBefore Old data
     * @param dataAfter New, updated data
     * @param writeContext Write context can be used to store any useful information and then utilized by other customizers
     *
     * @throws WriteFailedException if update was unsuccessful
     */
    void updateCurrentAttributes(@Nonnull final InstanceIdentifier<D> id,
                                 @Nonnull final D dataBefore,
                                 @Nonnull final D dataAfter,
                                 @Nonnull final WriteContext writeContext) throws WriteFailedException;

    /**
     * Handle delete operation. D from CRUD.
     *
     * @param id Identifier(from root) of data being written
     * @param dataBefore Old data being deleted
     * @param writeContext Write context can be used to store any useful information and then utilized by other customizers
     *
     * @throws WriteFailedException if delete was unsuccessful
     */
    void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<D> id,
                                 @Nonnull final D dataBefore,
                                 @Nonnull final WriteContext writeContext) throws WriteFailedException;

}