/*
|
* Copyright 1999-2019 Seata.io Group.
|
*
|
* 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 io.seata.server.session;
|
|
import io.seata.core.exception.TransactionException;
|
import io.seata.core.model.BranchStatus;
|
import io.seata.core.model.GlobalStatus;
|
|
/**
|
* The interface Session lifecycle listener.
|
*
|
* @author sharajava
|
*/
|
public interface SessionLifecycleListener {
|
|
/**
|
* On begin.
|
*
|
* @param globalSession the global session
|
* @throws TransactionException the transaction exception
|
*/
|
void onBegin(GlobalSession globalSession) throws TransactionException;
|
|
/**
|
* On status change.
|
*
|
* @param globalSession the global session
|
* @param status the status
|
* @throws TransactionException the transaction exception
|
*/
|
void onStatusChange(GlobalSession globalSession, GlobalStatus status) throws TransactionException;
|
|
/**
|
* On branch status change.
|
*
|
* @param globalSession the global session
|
* @param branchSession the branch session
|
* @param status the status
|
* @throws TransactionException the transaction exception
|
*/
|
void onBranchStatusChange(GlobalSession globalSession, BranchSession branchSession, BranchStatus status)
|
throws TransactionException;
|
|
/**
|
* On add branch.
|
*
|
* @param globalSession the global session
|
* @param branchSession the branch session
|
* @throws TransactionException the transaction exception
|
*/
|
void onAddBranch(GlobalSession globalSession, BranchSession branchSession) throws TransactionException;
|
|
/**
|
* On remove branch.
|
*
|
* @param globalSession the global session
|
* @param branchSession the branch session
|
* @throws TransactionException the transaction exception
|
*/
|
void onRemoveBranch(GlobalSession globalSession, BranchSession branchSession) throws TransactionException;
|
|
/**
|
* On close.
|
*
|
* @param globalSession the global session
|
* @throws TransactionException the transaction exception
|
*/
|
void onClose(GlobalSession globalSession) throws TransactionException;
|
|
/**
|
* On end.
|
*
|
* @param globalSession the global session
|
* @throws TransactionException the transaction exception
|
*/
|
void onSuccessEnd(GlobalSession globalSession) throws TransactionException;
|
|
/**
|
* On fail end.
|
*
|
* @param globalSession the global session
|
* @throws TransactionException the transaction exception
|
*/
|
void onFailEnd(GlobalSession globalSession) throws TransactionException;
|
}
|