de.decoit.simu.cbor.ifmap.metadata.multivalue.CBORCapability.java Source code

Introduction

Here is the source code for de.decoit.simu.cbor.ifmap.metadata.multivalue.CBORCapability.java

Source

/* 
 * Copyright 2015 DECOIT GmbH
 *
 * 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 de.decoit.simu.cbor.ifmap.metadata.multivalue;

import co.nstant.in.cbor.builder.ArrayBuilder;
import co.nstant.in.cbor.model.DataItem;
import co.nstant.in.cbor.model.SimpleValue;
import co.nstant.in.cbor.model.SimpleValueType;
import co.nstant.in.cbor.model.UnicodeString;
import de.decoit.simu.cbor.ifmap.exception.CBORSerializationException;
import de.decoit.simu.cbor.ifmap.util.IfMapNamespaces;
import de.decoit.simu.cbor.xml.dictionary.DictionaryProvider;
import de.decoit.simu.cbor.xml.dictionary.DictionarySimpleElement;
import de.decoit.simu.cbor.xml.dictionary.exception.DictionaryPathException;
import java.time.ZonedDateTime;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;

/**
 * Java representation of the IF-MAP capability metadata.
 *
 * @author Thomas Rix (rix@decoit.de)
 */
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@Slf4j
public class CBORCapability extends AbstractMultiValueMetadata {
    public static final String XML_NAME = "capability";
    public static final String NAME = "name";
    public static final String ADMINISTRATIVE_DOMAIN = "administrative-domain";

    @Getter
    private final String name;
    @Getter
    private String administrativeDomain;

    /**
     * Create a new capability metadata.
     * This constructor should be used for metadata that is sent from the SERVER to the CLIENT. It includes
     * the attributes ifmap-publisher-id, ifmap-timestamp and ifmap-timestamp-fraction.
     * The timestamps are stored with UTC timezone. If a timestamp with another timezone is
     * passed into the constructor, it will be converted to UTC. The IF-MAP timestamp fraction
     * element will be calculated from the provided timestamp.
     *
     * @param ifMapPublisherId IF-MAP client publisher ID
     * @param ifMapTimestamp Timestamp for the metadata
     * @param name Capability name
     */
    public CBORCapability(String ifMapPublisherId, ZonedDateTime ifMapTimestamp, String name) {
        super(IfMapNamespaces.IFMAP_METADATA, XML_NAME, ifMapPublisherId, ifMapTimestamp);

        if (StringUtils.isBlank(name)) {
            throw new IllegalArgumentException("Name must not be blank");
        }

        this.name = name;
        this.administrativeDomain = null;
    }

    /**
     * Create a new capability metadata.
     * This constructor should be used for metadata that is sent from the CLIENT to the SERVER. It does not include
     * the attributes ifmap-publisher-id, ifmap-timestamp and ifmap-timestamp-fraction.
     * The timestamps are stored with UTC timezone. If a timestamp with another timezone is
     * passed into the constructor, it will be converted to UTC. The IF-MAP timestamp fraction
     * element will be calculated from the provided timestamp.
     *
     * @param name Capability name
     */
    public CBORCapability(String name) {
        super(IfMapNamespaces.IFMAP_METADATA, XML_NAME);

        if (StringUtils.isBlank(name)) {
            throw new IllegalArgumentException("Name must not be blank");
        }

        this.name = name;
        this.administrativeDomain = null;
    }

    /**
     * Set the administrative-domain for this metadata.
     * The administrative-domain may be null to remove this value from the metadata. If not null,
     * the administrative-domain MUST NOT be an empty string or whitespace only.
     *
     * @param administrativeDomain administrative-domain for this metadata
     */
    public void setAdministrativeDomain(String administrativeDomain) {
        if (StringUtils.isWhitespace(administrativeDomain)) {
            throw new IllegalArgumentException("administrative-domain must not be empty or whitespace only");
        }

        this.administrativeDomain = administrativeDomain;
    }

    @Override
    protected void serializeNestedElements(final ArrayBuilder<?> builder) throws CBORSerializationException {
        try {
            // Build dictionary path to this element
            StringBuilder dictPathSb = new StringBuilder("<");
            dictPathSb.append(this.namespace);
            dictPathSb.append(">");
            dictPathSb.append(this.elementName);

            // Get dictionary entry for this element
            DictionarySimpleElement elementEntry = DictionaryProvider.getInstance()
                    .findElementByPath(dictPathSb.toString());

            // Serialize 'name'
            {
                DataItem cborName = this.getNestedElementNameMapping(CBORCapability.NAME, elementEntry);

                builder.add(new SimpleValue(SimpleValueType.NULL));
                builder.add(cborName);
                builder.addArray();
                builder.add(new UnicodeString(this.name));
            }

            // Serialize 'administrative-domain'
            if (this.administrativeDomain != null) {
                DataItem cborName = this.getNestedElementNameMapping(CBORCapability.ADMINISTRATIVE_DOMAIN,
                        elementEntry);

                builder.add(new SimpleValue(SimpleValueType.NULL));
                builder.add(cborName);
                builder.addArray();
                builder.add(new UnicodeString(this.administrativeDomain));
            }
        } catch (DictionaryPathException | RuntimeException ex) {
            throw new CBORSerializationException("Error during serialization, see nested exception for details",
                    ex);
        }
    }
}