org.kie.internal.runtime.manager.SessionFactory 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;

import org.kie.api.runtime.KieSession;

/**
 * Factory that produces KieSession instances.
 *
 */
public interface SessionFactory {

    /**
     * Produces new instance of KieSession
     * @return new instance of KieSession
     */
    KieSession newKieSession();

    /**
     * Loads KieSession form data store (such as db) based on given id.
     * @param sessionId identifier of ksession
     * @return loaded instance of KieSession
     * @throws RuntimeException in case session cannot be loaded
     */
    KieSession findKieSessionById(Long sessionId);

    /**
     * Closes the factory and releases all resources
     */
    void close();
    
    /**
     * Invoked when runtime engine is about to be disposed
     * @param sessionId ksession id that is disposed.
     */
    void onDispose(Long sessionId);
}