ParametrizedRestURLGenerator.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rest.url;

import java.net.URL;

import org.xwiki.component.annotation.Role;
import org.xwiki.rest.XWikiRestException;

/**
 * A parameterized REST URL generator.
 *
 * @param <T> the type of the resource for which the URL are created for.
 * @version $Id: 66b01e73b1becedd310a39099599d59f5dcfa050 $
 * @since 8.0
 */
@Role
public interface ParametrizedRestURLGenerator<T>
{
    /**
     * @param resource an resource
     * @return the REST URL to access the given entity
     * @throws XWikiRestException if problems occur
     */
    URL getURL(T resource) throws XWikiRestException;
}