001/**
002 * Copyright 2014 Tampere University of Technology, Pori Department
003 * 
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * 
008 *   http://www.apache.org/licenses/LICENSE-2.0
009 * 
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package core.tut.pori.http.annotations;
017
018import static java.lang.annotation.ElementType.TYPE;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.Inherited;
023import java.lang.annotation.Retention;
024import java.lang.annotation.Target;
025
026/**
027 * Annotation for making a class a Service.
028 * 
029 * The method will be reachable in the path designated by the \@HTTPService annotation's name, generally in the format /WebApplicationName/rest/SERVICE_NAME
030 *
031 * The service names MUST be unique, an attempt to declare multiple methods with identical (case sensitive) names will result in an error on application context (service) initialization.
032 */
033@Retention(RUNTIME)
034@Target({TYPE})
035@Inherited
036@Documented
037public @interface HTTPService {
038  /**
039   * 
040   * @return name of the service
041   */
042  String name();
043}