blob: 7fbc1f4886213dbc8faad6d216e7626b08325faf [file] [log] [blame]
/*
* Copyright (c) OSGi Alliance (2017). All Rights Reserved.
*
* 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 org.osgi.service.jaxrs.whiteboard.propertytypes;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.osgi.service.component.annotations.ComponentPropertyType;
import org.osgi.service.jaxrs.whiteboard.annotations.RequireJaxRSWhiteboard;
/**
* Component Property Type for the {@code osgi.jaxrs.resource} service property.
* <p>
* This annotation can be used on a JAX-RS resource to declare the value of the
* {@link org.osgi.service.jaxrs.whiteboard.JaxRSWhiteboardConstants#JAX_RS_RESOURCE}
* service property.
*
* @see "Component Property Types"
* @author $Id: 6a574a8c0d6523e601a31c233d25c01e89107351 $
* @since 1.0
*/
@ComponentPropertyType
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
@RequireJaxRSWhiteboard
public @interface JaxrsResource {
/**
* Prefix for the property name. This value is prepended to each property
* name.
*/
String PREFIX_ = "osgi.";
/**
* Service property identifying a JAX-RS resource for processing by the
* whiteboard.
*
* @return The JAX-RS resource value.
* @see org.osgi.service.jaxrs.whiteboard.JaxRSWhiteboardConstants#JAX_RS_RESOURCE
*/
//String value() default "true";
}