001package ball.upnp;
002/*-
003 * ##########################################################################
004 * UPnP/SSDP Implementation Classes
005 * $Id: AnnotatedService.java 5285 2020-02-05 04:23:21Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-upnp/trunk/src/main/java/ball/upnp/AnnotatedService.java $
007 * %%
008 * Copyright (C) 2013 - 2020 Allen D. Ball
009 * %%
010 * Licensed under the Apache License, Version 2.0 (the "License");
011 * you may not use this file except in compliance with the License.
012 * You may obtain a copy of the License at
013 *
014 *      http://www.apache.org/licenses/LICENSE-2.0
015 *
016 * Unless required by applicable law or agreed to in writing, software
017 * distributed under the License is distributed on an "AS IS" BASIS,
018 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
019 * See the License for the specific language governing permissions and
020 * limitations under the License.
021 * ##########################################################################
022 */
023import ball.upnp.annotation.ServiceId;
024import ball.upnp.annotation.ServiceType;
025import java.net.URI;
026import org.springframework.core.annotation.AnnotationUtils;
027
028/**
029 * {@link Service} support for {@link ServiceType} and related annotations.
030 *
031 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
032 * @version $Revision: 5285 $
033 */
034public interface AnnotatedService {
035
036    /**
037     * Method to get the URN ({@link URI}) describing this
038     * {@link AnnotatedService}'s service type.
039     *
040     * @return  The service type.
041     */
042    default URI getServiceType() {
043        ServiceType annotation =
044            AnnotationUtils.findAnnotation(getClass(), ServiceType.class);
045
046        return (annotation != null) ? URI.create(annotation.value()) : null;
047    }
048
049    /**
050     * Method to get the URN {{@link URI}) describing this
051     * {@link AnnotatedService}'s service ID.
052     *
053     * @return  The service type.
054     */
055    default URI getServiceId() {
056        ServiceId annotation =
057            AnnotationUtils.findAnnotation(getClass(), ServiceId.class);
058
059        return (annotation != null) ? URI.create(annotation.value()) : getServiceType();
060    }
061}