com.codebullets.sagalib.ContextKeyExtractFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of saga-lib Show documentation

Java saga pattern library to organize and handle domain events.

The newest version!

/*
 * Copyright 2015 Stefan Domnanovits
 *
 * 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 com.codebullets.sagalib;

import com.codebullets.sagalib.context.LookupContext;

import javax.annotation.Nullable;

/**
 * Called to extract a saga instance key. The returned instance key is used
 * too perform lookup for existing saga states.
 *
 * In comparison to the {@link KeyExtractFunction} it has an additional
 * context parameter providing more information.
 *
 * @param  The type of the message to extract the key from.
 * @param  The type of the key returned after extraction.
 */
public interface ContextKeyExtractFunction {
    /**
     * Returns the key value to identify a running saga.
     */
    @Nullable
    KEY key(MESSAGE message, LookupContext context);
}