001/*
002 * Copyright 2002-2009 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.portlet.bind.annotation;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import org.springframework.web.bind.annotation.Mapping;
026
027/**
028 * Annotation for mapping Portlet event requests onto handler methods.
029 *
030 * @author Juergen Hoeller
031 * @since 3.0
032 * @see org.springframework.web.bind.annotation.RequestMapping
033 */
034@Target({ElementType.METHOD})
035@Retention(RetentionPolicy.RUNTIME)
036@Documented
037@Mapping()
038public @interface EventMapping {
039
040        /**
041         * The name of the event to be handled.
042         * This name uniquely identifies an event within a portlet mode.
043         * <p>Typically the local name of the event, but fully qualified names
044         * with a "{...}" namespace part will be mapped correctly as well.
045         * <p>If not specified, the handler method will be invoked for any
046         * event request within its general mapping.
047         * @see javax.portlet.EventRequest#getEvent()
048         * @see javax.portlet.Event#getName()
049         */
050        String value() default "";
051
052}