Open Source Repository

Home /spring/spring-web-portlet-3.0.5 | Repository Home


org/springframework/web/portlet/bind/annotation/ActionMapping.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * Licensed 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 org.springframework.web.portlet.bind.annotation;

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

import org.springframework.web.bind.annotation.Mapping;

/**
 * Annotation for mapping Portlet action requests onto handler methods.
 *
 @author Juergen Hoeller
 @since 3.0
 @see org.springframework.web.bind.annotation.RequestMapping
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface ActionMapping {

  /**
   * The name of the action, according to the Portlet 2.0
   * "javax.portlet.action" parameter.
   <p>If not specified, the method will be used as default handler:
   * i.e. for action requests where no specific action mapping was found.
   <p>Note that all such annotated action methods only apply within the
   <code>@RequestMapping</code> constraints of the containing handler class.
   @see javax.portlet.ActionRequest#ACTION_NAME
   */
  String value() default "";

  /**
   * The parameters of the mapped request, narrowing the primary mapping.
   <p>Same format for any environment: a sequence of "myParam=myValue" style
   * expressions, with a request only mapped if each such parameter is found
   * to have the given value. "myParam" style expressions are also supported,
   * with such parameters having to be present in the request (allowed to have
   * any value). Finally, "!myParam" style expressions indicate that the
   * specified parameter is <i>not</i> supposed to be present in the request.
   @see org.springframework.web.bind.annotation.RequestMapping#params()
   */
  String[] params() default {};

}