lib/servlet-api/javax/servlet/http/HttpSessionIdListener.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *     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  */
  17 package javax.servlet.http;
  18
  19 import java.util.EventListener;
  20
  21 /**
  22  * Implementations of this interface are notified when an {@link HttpSession}'s
  23  * ID changes. To receive notification events, the implementation class must be
  24  * configured in the deployment descriptor for the web application, annotated
  25  * with {@link javax.servlet.annotation.WebListener} or registered by calling an
  26  * addListener method on the {@link javax.servlet.ServletContext}.
  27  *
  28  * @see HttpSessionEvent
  29  * @see HttpServletRequest#changeSessionId()
  30  * @since Servlet 3.1
  31  */
  32 public interface HttpSessionIdListener extends EventListener {
  33
  34     /**
  35      * Notification that a session ID has been changed.
  36      *
  37      * @param se the notification event
  38      * @param oldSessionId the old session ID
  39      */
  40     public void sessionIdChanged(HttpSessionEvent se, String oldSessionId);
  41 }