001package ball.upnp;
002/*-
003 * ##########################################################################
004 * UPnP/SSDP Implementation Classes
005 * $Id: Service.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/Service.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 java.net.URI;
024import java.util.LinkedList;
025import java.util.List;
026import javax.xml.bind.annotation.XmlRootElement;
027import lombok.Getter;
028import lombok.NonNull;
029import lombok.RequiredArgsConstructor;
030
031import static lombok.AccessLevel.PROTECTED;
032
033/**
034 * Abstract base class for {@link.uri http://www.upnp.org/ UPnP} services.
035 *
036 * {@bean.info}
037 *
038 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
039 * @version $Revision: 5285 $
040 */
041@XmlRootElement(name = "scpd", namespace = "urn:schemas-upnp-org:service-1-0")
042@RequiredArgsConstructor(access = PROTECTED)
043public abstract class Service implements AnnotatedService, XmlDocument {
044    @NonNull @Getter
045    private final Device device;
046    @Getter
047    private final List<Action> actionList = new LinkedList<>();
048    @Getter
049    private final List<StateVariable> serviceStateTable = new LinkedList<>();
050
051    /**
052     * Method to get the USN {@link URI}.  The {@link URI} is calculated by
053     * combining the {@link Device#getUDN()} and {@link #getServiceId()}.
054     *
055     * @return  The USN {@link URI}.
056     */
057    public URI getUSN() {
058        return URI.create(getDevice().getUDN() + "::" + getServiceId());
059    }
060
061    @Override
062    public String toString() { return getServiceType().toString(); }
063}