EndpointResource.java

/*
   This file is part of the LarKC platform 
   http://www.larkc.eu/

   Copyright 2010 LarKC project consortium

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */
package eu.larkc.core.management;

import org.restlet.representation.Representation;
import org.restlet.resource.Get;

/**
 * This interface describes the methods that are possible in an endpoint
 * resource.
 * 
 * @author norlan
 * 
 */
public interface EndpointResource {

	/**
	 * This method gets the endpoint of a specific type for a specific workflow
	 * 
	 * @return the endpoint url
	 * @throws InvalidURLException
	 *             if the url is invalid
	 */
	@Get
	public Representation getEndpoint() throws InvalidURLException;

}