/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.net.ssl;

import java.util.EventObject;

/**

 * This event is propagated to a SSLSessionBindingListener.

 * When a listener object is bound or unbound to an SSLSession by

 * {@link SSLSession#putValue(String, Object)}

 * or {@link SSLSession#removeValue(String)}, objects which

 * implement the SSLSessionBindingListener will be receive an

 * event of this type.  The event's <code>name</code> field is the

 * key in which the listener is being bound or unbound.

 *

 * @see SSLSession

 * @see SSLSessionBindingListener

 *

 * @since 1.4

 * @author Nathan Abramson

 * @author David Brownell

 */

public

class SSLSessionBindingEvent

extends EventObject

{

    private static final long serialVersionUID = 3989172637106345L;

    /**

     * @serial The name to which the object is being bound or unbound

     */

    private String name;

    /**

     * Constructs a new SSLSessionBindingEvent.

     *

     * @param session the SSLSession acting as the source of the event

     * @param name the name to which the object is being bound or unbound

     * @exception  IllegalArgumentException  if <code>session</code> is null.

     */

    public SSLSessionBindingEvent(SSLSession session, String name)

    {

        super(session);

        this.name = name;

    }

    /**

     * Returns the name to which the object is being bound, or the name

     * from which the object is being unbound.

     *

     * @return the name to which the object is being bound or unbound

     */

    public String getName()

    {

        return name;

    }

    /**

     * Returns the SSLSession into which the listener is being bound or

     * from which the listener is being unbound.

     *

     * @return the <code>SSLSession</code>

     */

    public SSLSession getSession()

    {

        return (SSLSession) getSource();

    }

}