01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */package org.apache.geronimo.clustering;
17:
18: /**
19: * Callback listener for inbound and outbound Session migration.
20: * <p>
21: * A Session is preemptively moved between its associated set of SessionManagers. For instance, when a
22: * ClusteredInvocation for a given Session is invoked on a Node where the local SessionManager, RequestingSM, does not
23: * own the targeted Session, the SessionManager owning the Session, OwningSM, the Session may be moved from OwningSM
24: * to RequestingSM. OwningSM, prior to relinquish the Session, executes notifyOutboundSessionMigration and provides
25: * the Session under migration. RequestingRM, after having acquired the Session ownership, executes
26: * notifyInboundSessionMigration and provides the Session under migration.
27: * <p>
28: * The typical usage of these migration callbacks are to allow a wrapping SessionManager, e.g. an HTTPSession manager,
29: * to perform bookkeeping operations.
30: *
31: * @version $Rev$ $Date$
32: */
33: public interface SessionListener {
34:
35: /**
36: * Calls when the ownership of the provided Session is acquired by the SessionManager to which this listener
37: * is attached.
38: *
39: * @param session New Session now owned by the attached SessionManager.
40: */
41: void notifyInboundSessionMigration(Session session);
42:
43: /**
44: * Calls when the ownership of the provided Session is relinquished to another SessionManager.
45: *
46: * @param session Session now owned by another SessionManager.
47: */
48: void notifyOutboundSessionMigration(Session session);
49:
50: /**
51: * Calls when a Session is destroyed.
52: *
53: * @param session Destroyed session.
54: */
55: void notifySessionDestruction(Session session);
56: }
|