org.apache.struts2.Preparable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of struts2-core Show documentation

The newest version!

/*
 * 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 org.apache.struts2;

/**
 * Preparable Actions will have their prepare() method called if the
 * {@link org.apache.struts2.interceptor.PrepareInterceptor} is applied to the ActionConfig.
 *
 * @author Jason Carreira
 * @see org.apache.struts2.interceptor.PrepareInterceptor
 */
public interface Preparable {

    /**
     * This method is called to allow the action to prepare itself.
     *
     * @throws Exception thrown if a system level exception occurs.
     */
    void prepare() throws Exception;

}