net.shibboleth.ext.spring.config.DurationToLongConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-extensions Show documentation

A set of extensions for the Spring framework. This package includes things like factory beans, converters, etc.

There is a newer version: 6.0.0

/*
 * Licensed to the University Corporation for Advanced Internet Development,
 * Inc. (UCAID) under one or more contributor license agreements.  See the
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You 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 net.shibboleth.ext.spring.config;

import javax.annotation.Nonnull;

import net.shibboleth.utilities.java.support.annotation.Duration;
import net.shibboleth.utilities.java.support.xml.DOMTypeSupport;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.convert.TypeDescriptor;
import org.springframework.core.convert.converter.ConditionalConverter;
import org.springframework.core.convert.converter.Converter;

/**
 * Allows setting of Duration-valued properties using lexical string form.
 */
public class DurationToLongConverter implements Converter, ConditionalConverter {

    /** Logger. */
    @Nonnull private Logger log = LoggerFactory.getLogger(DurationToLongConverter.class);

    /** {@inheritDoc} */
    @Override public Long convert(final String source) {
        if (source.startsWith("P")) {
            return DOMTypeSupport.durationToLong(source.trim());
        } else if (source.startsWith("-P")) {
            throw new IllegalArgumentException("Negative durations are not supported");
        } else {
            // Treat as a milliseconds.  But note this
            final long duration = Long.valueOf(source);
            log.info("Deprecated duration of {} was specified. Use XML duration of {}", source,
                    DOMTypeSupport.longToDuration(duration));
            return duration;
        }
    }

    /** {@inheritDoc} */
    @Override public boolean matches(final TypeDescriptor sourceType, final TypeDescriptor targetType) {
        return targetType.hasAnnotation(Duration.class);
    }

}