001package ball.upnp;
002/*-
003 * ##########################################################################
004 * UPnP/SSDP Implementation Classes
005 * $Id: Device.java 5839 2020-04-22 21:40:04Z ball $
006 * $HeadURL: svn+ssh://svn.hcf.dev/var/spool/scm/repository.svn/ball-upnp/trunk/src/main/java/ball/upnp/Device.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 java.util.UUID;
027import javax.xml.bind.annotation.XmlRootElement;
028import lombok.Getter;
029import lombok.NoArgsConstructor;
030
031import static lombok.AccessLevel.PROTECTED;
032
033/**
034 * Abstract base class for {@link.uri http://www.upnp.org/ UPnP} devices.
035 *
036 * {@bean.info}
037 *
038 * @author {@link.uri mailto:ball@hcf.dev Allen D. Ball}
039 * @version $Revision: 5839 $
040 */
041@XmlRootElement(name = "root", namespace = "urn:schemas-upnp-org:device-1-0")
042@NoArgsConstructor(access = PROTECTED)
043public abstract class Device implements AnnotatedDevice, XmlDocument {
044    @Getter
045    private final UUID UUID = java.util.UUID.randomUUID();
046    @Getter
047    private final List<Icon> iconList = new LinkedList<>();
048    @Getter
049    private final List<Service> serviceList = new LinkedList<>();
050    @Getter
051    private final List<Device> deviceList = new LinkedList<>();
052
053    /**
054     * Method to get {@link.this} {@link Service}s UDN.
055     *
056     * @return  The UDN {@link URI}.
057     */
058    public URI getUDN() {
059        return URI.create("uuid:" + getUUID().toString().toUpperCase());
060    }
061
062    @Override
063    public String toString() { return getDeviceType().toString(); }
064}