Home | History | Annotate | Download | only in ssl 
      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 
     18 package javax.net.ssl;
     19 
     20 import java.io.Serializable;
     21 import java.util.EventObject;
     22 
     23 /**
     24  * The event sent to an {@code SSLSessionBindingListener} when the listener
     25  * object is bound ({@link SSLSession#putValue(String, Object)}) or unbound
     26  * ({@link SSLSession#removeValue(String)}) to an {@code SSLSession}.
     27  */
     28 public class SSLSessionBindingEvent extends EventObject implements Serializable {
     29 
     30     /**
     31      * The 5.0 spec. doesn't declare this serialVersionUID field In order to be compatible it is
     32      * explicitly declared here
     33      */
     34     private static final long serialVersionUID = 3989172637106345L;
     35 
     36     /**
     37      * @serial include
     38      */
     39     private final String name;
     40 
     41     /**
     42      * Creates a new {@code SSLSessionBindingEvent} for the specified session
     43      * indicating a binding event for the specified name.
     44      *
     45      * @param session
     46      *            the session for which the event occurs.
     47      * @param name
     48      *            the name of the object being (un)bound.
     49      */
     50     public SSLSessionBindingEvent(SSLSession session, String name) {
     51         super(session);
     52         this.name = name;
     53     }
     54 
     55     /**
     56      * Returns the name of the binding being added or removed.
     57      *
     58      * @return the name of the binding.
     59      */
     60     public String getName() {
     61         return name;
     62     }
     63 
     64     /**
     65      * Returns the session to which the binding is added or from which it is
     66      * removed.
     67      *
     68      * @return the session to which the binding is added or from which it is
     69      *         removed.
     70      */
     71     public SSLSession getSession() {
     72         return (SSLSession) this.source;
     73     }
     74 
     75 }
     76