org.kie.internal.runtime.manager.context.ProcessInstanceIdContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kie-internal Show documentation

The Drools and jBPM internal API which is NOT backwards compatible between releases.

There is a newer version: 9.44.0.Final

/*
 * Copyright 2013 Red Hat, Inc. 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 org.kie.internal.runtime.manager.context;

import org.kie.api.runtime.manager.Context;

/**
 * Process instance id aware implementation of the Context interface.
 * It's main responsibility is to be the data holder between caller and runtime manager
 * to obtain proper instances of RuntimeEngine.

 * Used by strategy:
 * 
 *  PerProcessInstance
 * 
 * To obtain instances of this context use one of the following static methods:
 * 
 *  get() to get empty context when starting process instances
 *  get(Long) to get context for specific process instance
 * 
 */
public class ProcessInstanceIdContext implements Context {

    private String processInstanceId;

    public ProcessInstanceIdContext(String processInstanceId) {
        this.processInstanceId = processInstanceId;
    }

    @Override
    public String getContextId() {
        return processInstanceId;
    }

    public void setContextId(String id) {
        this.processInstanceId = id;
    }

    /**
     * Returns new instance of ProcessInstanceIdContext without process instance id.
     * Used for starting new instances of the process.
     * @return
     */
    public static ProcessInstanceIdContext get() {
        return new ProcessInstanceIdContext(null);
    }

    /**
     * Returns new instance of ProcessInstanceIdContext with id of already existing process instance
     * @param processInstanceId actual identifier of process instance
     * @return
     */
    public static ProcessInstanceIdContext get(String processInstanceId) {
        return new ProcessInstanceIdContext(processInstanceId);
    }

}