geronimo-websockets_1.0_spec/src/main/java/javax/websocket/OnClose.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 javax.websocket;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This method level annotation can be used to decorate a Java method that wishes to be called when a web socket session
 * is closing.
 * <p/>
 * The method may only take the following parameters:-
 * <ul>
 * <li>optional Session parameter</li>
 * <li>optional CloseReason parameter</li>
 * <li>Zero to n String parameters annotated with the PathParam annotation.</li>
 * </ul>
 * <p/>
 * The parameters may appear in any order. See Endpoint.onClose(javax.websocket.Session, javax.websocket.CloseReason)
 * for more details on how the session parameter may be used during method calls annotated with this annotation.
 */
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = ElementType.METHOD)
public @interface OnClose {
}