org.apache.turbine.services.pull.PipelineDataApplicationTool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of turbine Show documentation

Turbine is a servlet based framework that allows experienced Java developers to quickly build secure web applications. Parts of Turbine can also be used independently of the web portion of Turbine as well. In other words, we strive to make portions of Turbine easily available for use in other applications.

There is a newer version: 6.0

Show newest version

package org.apache.turbine.services.pull;

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

import org.apache.turbine.pipeline.PipelineData;


/**
 * Interface for tools to be init'd and refreshed using a PipelineData
 * object
 * Code largely taken from ApplicationTool.
 *
 * @author Peter Courcoux
 */
public interface PipelineDataApplicationTool
{
    /**
     * Initialize the application tool. The data parameter holds a different
     * type depending on how the tool is being instantiated:
     * 
     * For global tools data will be null
     * For request tools data will be of type PipelineData
     * For session and authorized tools data will be of type User
     * 
     * 
     * It is possible that session scope tools will be initialized with a null
     * User object.  This happens when the first request on a
     * session happens to the be login action.  The next request on the session
     * will cause the session tool to be refreshed if
     * tools.per.request.refresh is set to true
     * in TurbineResources.properties.  You will then be able to
     * get a User object from the instance of
     * PipelineData.
     *
     * @param data initialization data
     */
    public void init(Object data);

    /**
     * Refresh the application tool. This is
     * necessary for development work where you
     * probably want the tool to refresh itself
     * if it is using configuration information
     * that is typically cached after initialization
     *
     * @param data The current PipelineData Object
     */
    public void refresh(PipelineData data);
}