javax.portlet.annotations.DestroyMethod Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of portlet-api Show documentation

The Java Portlet API version 3.0 developed by the Java Community Process JSR-362 Expert Group.

There is a newer version: 3.0.1

/*  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.
 */

/*
 * This source code implements specifications defined by the Java
 * Community Process. In order to remain compliant with the specification
 * DO NOT add / change / or delete method signatures!
 */

package javax.portlet.annotations;


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

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;


/**
 * 
 * Designates a method corresponding to the portlet API destroy method.
 * The annotated method must have the following signature:
 * 
 *    public void <methodName>()
 * 
   
 * where the method name can be freely selected.
 * 

 * the destroy method is called by the portlet container to 
 * indicate to a portlet that the
 * portlet is being taken out of service.  
 * 

 * Before the portlet container calls the destroy method, it should 
 * allow any threads that are currently processing requests within 
 * the portlet object to complete execution. To avoid
 * waiting forever, the portlet container can optionally wait for 
 * a predefined time before destroying the portlet object.
 * 

 * This method enables the portlet to do the following:
 * 

 * clean up any resources that it holds (for example, memory,
 * file handles, threads) 
 * 
make sure that any persistent state is
 * synchronized with the portlet current state in memory.
 * 
 * 
 *    
 * @see javax.portlet.Portlet#destroy()
 *
 */

@Retention(RUNTIME) @Target({METHOD})
public @interface DestroyMethod {
   
   /**
    * The portlet name for the annotated method.
    * 
    * @return  The portlet name
    */
   String   value();
}