/*******************************************************************************
 *
 * Copyright (c) 2004-2009 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 * 
 *    Kohsuke Kawaguchi
 *
 *
 *******************************************************************************/ 

package hudson.model;

import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

/**
 * Optional interface for {@link Action}s that are attached to
 * {@link AbstractProject} (through {@link JobProperty#getJobActions(Job)}),
 * which allows plugins to define additional permalinks in the project.
 *
 * <p> Permalinks are listed together in the UI for better ease of use, plus
 * other plugins can use this information elsewhere (for example, a plugin to
 * download an artifact from one of the permalinks.)
 *
 * @author Kohsuke Kawaguchi
 * @since 1.253
 * @see JobProperty
 */
public interface PermalinkProjectAction extends Action {

    /**
     * Gets the permalinks defined for this project.
     *
     * <p> Because {@link Permalink} is a strategy-pattern object, this method
     * should normally return a pre-initialzied read-only static list object.
     *
     * @return can be empty, but never null.
     */
    List<Permalink> getPermalinks();

    /**
     * Permalink as a strategy pattern.
     */
    public static abstract class Permalink {

        /**
         * String to be displayed in the UI, such as "Last successful build".
         * The convention is to upper case the first letter.
         */
        public abstract String getDisplayName();

        /**
         * ID that uniquely identifies this permalink.
         *
         * <p> The is also used as an URL token to represent the permalink. This
         * becomes the part of the permanent URL.
         *
         * <p> The expected format is the camel case, such as
         * "lastSuccessfulBuild".
         */
        public abstract String getId();

        /**
         * Resolves the permalink to a build.
         *
         * @return null if the target of the permalink doesn't exist.
         */
        public abstract Run<?, ?> resolve(Job<?, ?> job);
        /**
         * List of {@link Permalink}s that are built into Hudson.
         */
        public static final List<Permalink> BUILTIN = new CopyOnWriteArrayList<Permalink>();

        static {
            BUILTIN.add(new Permalink() {
                public String getDisplayName() {
                    return Messages.Permalink_LastBuild();
                }

                public String getId() {
                    return "lastBuild";
                }

                public Run<?, ?> resolve(Job<?, ?> job) {
                    return job.getLastBuild();
                }
            });

            BUILTIN.add(new Permalink() {
                public String getDisplayName() {
                    return Messages.Permalink_LastStableBuild();
                }

                public String getId() {
                    return "lastStableBuild";
                }

                public Run<?, ?> resolve(Job<?, ?> job) {
                    return job.getLastStableBuild();
                }
            });

            BUILTIN.add(new Permalink() {
                public String getDisplayName() {
                    return Messages.Permalink_LastSuccessfulBuild();
                }

                public String getId() {
                    return "lastSuccessfulBuild";
                }

                public Run<?, ?> resolve(Job<?, ?> job) {
                    return job.getLastSuccessfulBuild();
                }
            });

            BUILTIN.add(new Permalink() {
                public String getDisplayName() {
                    return Messages.Permalink_LastFailedBuild();
                }

                public String getId() {
                    return "lastFailedBuild";
                }

                public Run<?, ?> resolve(Job<?, ?> job) {
                    return job.getLastFailedBuild();
                }
            });

            BUILTIN.add(new Permalink() {
                public String getDisplayName() {
                    return Messages.Permalink_LastUnstableBuild();
                }

                public String getId() {
                    return "lastUnstableBuild";
                }

                public Run<?, ?> resolve(Job<?, ?> job) {
                    return job.getLastUnstableBuild();
                }
            });

            BUILTIN.add(new Permalink() {
                public String getDisplayName() {
                    return Messages.Permalink_LastUnsuccessfulBuild();
                }

                public String getId() {
                    return "lastUnsuccessfulBuild";
                }

                public Run<?, ?> resolve(Job<?, ?> job) {
                    return job.getLastUnsuccessfulBuild();
                }
            });
        }
    }
}