001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019 */
020package org.sonar.api.web;
021
022import org.sonar.api.ServerExtension;
023
024/**
025 * This extension point must be implemented to define a new filter.
026 *
027 * @since 3.1
028 */
029public abstract class FilterTemplate implements ServerExtension {
030
031  /**
032   * Returns the {@link Filter} object that represents the filter to use.
033   *
034   * @return the filter
035   */
036  public abstract Filter createFilter();
037
038  /**
039   * Filter name
040   */
041  public abstract String getName();
042}