/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.commons.jackson.jsonpatch;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.core.JsonPointer;
import lombok.Getter;
import org.hisp.dhis.commons.jackson.jsonpatch.operations.AddOperation;
import org.hisp.dhis.commons.jackson.jsonpatch.operations.RemoveByIdOperation;
import org.hisp.dhis.commons.jackson.jsonpatch.operations.RemoveOperation;
import org.hisp.dhis.commons.jackson.jsonpatch.operations.ReplaceOperation;

/**
 * Encapsulates a JSON Patch Operation, 2 types of sub-classes exists, one which support an
 * additional 'value' field, and one that does not.
 *
 * <p>Follows RFC 6902, and we currently support 3 operators (add, remove, replace)
 *
 * @see AddOperation
 * @see RemoveOperation
 * @see ReplaceOperation
 * @author Morten Olav Hansen
 */
@Getter
@JsonSubTypes({
  @JsonSubTypes.Type(name = "add", value = AddOperation.class),
  @JsonSubTypes.Type(name = "remove", value = RemoveOperation.class),
  @JsonSubTypes.Type(name = "remove-by-id", value = RemoveByIdOperation.class),
  @JsonSubTypes.Type(name = "replace", value = ReplaceOperation.class)
})
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "op")
public abstract class JsonPatchOperation implements Patch {
  public static final String ADD_OPERATION = "add";

  public static final String REMOVE_OPERATION = "remove";

  public static final String REMOVE_BY_ID_OPERATION = "remove-by-id";

  public static final String REPLACE_OPERATION = "replace";

  @JsonProperty protected final String op;

  @JsonProperty protected JsonPointer path;

  protected JsonPatchOperation(final String op, final JsonPointer path) {
    this.op = op;
    this.path = path;
  }

  // TODO: To remove when we remove old UserCredentials compatibility layer
  public void setPath(JsonPointer path) {
    this.path = path;
  }
}
