LinkInterceptor.java

package com.temenos.interaction.media.odata.xml.atom;

/*
 * #%L
 * interaction-media-odata-xml
 * %%
 * Copyright (C) 2012 - 2014 Temenos Holdings N.V.
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */


import com.temenos.interaction.core.hypermedia.Link;
import com.temenos.interaction.core.resource.EntityResource;
import com.temenos.interaction.core.resource.RESTResource;

public interface LinkInterceptor {

	/**
	 * <P>Called by the Provider when adding links to an {@link EntityResource}
	 * or {@link CollectionResource}.  The return Link will be added to the 
	 * representation, returning null will cause the link to be ignored.</P>
	 * @param resource the resource we are adding the link to
	 * @param linkToAdd
	 * @return
	 */
	public Link addingLink(RESTResource resource, Link linkToAdd);
	
}