org.apache.jackrabbit.oak.spi.commit.CommitContext Maven / Gradle / Ivy
/*
* 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.jackrabbit.oak.spi.commit;
import javax.annotation.CheckForNull;
/**
* A CommitContext instance can be obtained from {@link CommitInfo#getInfo()}
* if it has been set before the merge call. This can then be used by CommitHook
* to record some metadata regarding the commit.
*
* CommitContext state would be reset in case commit is retried from within
* NodeStore say when a merge exception occurs.
*/
public interface CommitContext {
/**
* Name of the entry of the mutable commit attributes map in the {@code info}
* map in {@link CommitInfo#getInfo()}
*/
String NAME = "oak.commitAttributes";
/**
* Stores an attribute related to this commit.
* Attributes are reset if the commit is retried.
*
*
If the object passed in is null, the effect is the same as
* calling {@link #remove}.
*
* @param name a String specifying the name of the attribute
* @param value the Object to be stored
*/
void set(String name, Object value);
/**
* Returns the value of the named attribute as an Object,
* or null if no attribute of the given name exists.
*
* @param name String specifying the name of
* the attribute
*
* @return an Object containing the value
* of the attribute, or null if the attribute does not exist
*/
@CheckForNull
Object get(String name);
/**
* Removes an attribute from this commit.
*
* @param name a String specifying
* the name of the attribute to remove
*/
void remove(String name);
}