/*
* 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.model.reference.EntityReference;
import org.xwiki.rest.XWikiRestException;
/**
* Component to generate REST URLs for entities.
*
* @version $Id: 969fc2091c8a4fc2d8fea257f01b1b49c79ee26d $
* @since 7.2M1
*/
@Role
public interface RestURLGenerator
{
/**
* Generate a REST URL to access the given entity.
*
* @param entityReference entity
* @return the REST URL to access the given entity
* @throws XWikiRestException if problems occur (e.g. the entity type is not supported)
*/
URL getURL(EntityReference entityReference) throws XWikiRestException;
}