ClientSession.java

/*
 * Copyright 2016 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.workbench.common.stunner.core.client.session;

import org.kie.workbench.common.stunner.core.client.canvas.Canvas;
import org.kie.workbench.common.stunner.core.client.canvas.CanvasHandler;

/**
 * Stunner's Client Sessions provide stateful sessions that have access to the
 * canvas and the canvas handler when a user opens a diagram and it gets processed and
 * displayed into the canvas.
 * @param <C> The type of the canvas.
 * @param <H> The of the canvas handler.
 */
public interface ClientSession<C extends Canvas, H extends CanvasHandler> {

    /**
     * The canvas instance for this session.
     */
    C getCanvas();

    /**
     * The canvas handler instance for this session.
     */
    H getCanvasHandler();
}