lib/servlet-api/javax/servlet/annotation/WebListener.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.annotation;
  18
  19 import java.lang.annotation.Documented;
  20 import java.lang.annotation.ElementType;
  21 import java.lang.annotation.Retention;
  22 import java.lang.annotation.RetentionPolicy;
  23 import java.lang.annotation.Target;
  24
  25 /**
  26  * The annotation used to declare a listener for various types of event, in a
  27  * given web application context.<br />
  28  * <br />
  29  *
  30  * The class annotated MUST implement one, (or more), of the following
  31  * interfaces: {@link javax.servlet.http.HttpSessionAttributeListener},
  32  * {@link javax.servlet.http.HttpSessionListener},
  33  * {@link javax.servlet.ServletContextAttributeListener},
  34  * {@link javax.servlet.ServletContextListener},
  35  * {@link javax.servlet.ServletRequestAttributeListener},
  36  * {@link javax.servlet.ServletRequestListener} or
  37  * {@link javax.servlet.http.HttpSessionIdListener}
  38  * <br />
  39  *
  40  * E.g. <code>@WebListener</code><br />
  41  * <code>public TestListener implements ServletContextListener {</code><br />
  42  *
  43  * @since Servlet 3.0
  44  */
  45 @Target({ElementType.TYPE})
  46 @Retention(RetentionPolicy.RUNTIME)
  47 @Documented
  48 public @interface WebListener {
  49
  50     /**
  51      * @return description of the listener, if present
  52      */
  53     String value() default "";
  54 }