net.java.trueupdate.manager.jms.JmsUpdateManagerParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of trueupdate-manager-jms Show documentation
Provides an update manager which depends on the JMS API.
The newest version!
/*
 * Copyright (C) 2013 Schlichtherle IT Services & Stimulus Software.
 * All rights reserved. Use is subject to license terms.
 */
package net.java.trueupdate.manager.jms;

import net.java.trueupdate.jms.JmsParameters;
import net.java.trueupdate.manager.core.TimerParameters;
import net.java.trueupdate.manager.core.UpdateServiceParameters;
import net.java.trueupdate.manager.jms.ci.JmsUpdateManagerParametersCi;
import net.java.trueupdate.util.builder.AbstractBuilder;

import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.xml.bind.JAXB;
import java.net.URL;
import java.util.Locale;
import java.util.ServiceConfigurationError;

import static java.util.Objects.requireNonNull;

/**
 * JMS update manager parameters.
 *
 * @author Christian Schlichtherle
 */
@Immutable
public final class JmsUpdateManagerParameters {

    private static final String CONFIGURATION = "update/manager.xml";

    private final UpdateServiceParameters updateService;
    private final TimerParameters updateTimer;
    private final JmsParameters messaging;

    JmsUpdateManagerParameters(final Builder b) {
        this.updateService = requireNonNull(b.updateService);
        this.updateTimer = requireNonNull(b.updateTimer);
        this.messaging = requireNonNull(b.messaging);
    }

    /**
     * Loads JMS update manager parameters from the configuration resource
     * file with the name {@code update/manager.xml}.
     */
    public static JmsUpdateManagerParameters load() {
        return load(net.java.trueupdate.util.Resources.locate(CONFIGURATION));
    }

    static JmsUpdateManagerParameters load(final URL source) {
        try {
            return parse(JAXB.unmarshal(source,
                                        JmsUpdateManagerParametersCi.class));
        } catch (RuntimeException ex) {
            throw new ServiceConfigurationError(String.format(Locale.ENGLISH,
                    "Failed to load configuration from %s .", source),
                    ex);
        }
    }

    /** Parses the given configuration item. */
    public static JmsUpdateManagerParameters parse(
            JmsUpdateManagerParametersCi ci) {
        return builder().parse(ci).build();
    }

    /** Returns a new builder for JMS update manager parameters. */
    public static Builder builder() { return new Builder<>(); }

    /** Returns the update service parameters. */
    public UpdateServiceParameters updateService() { return updateService; }

    /** Returns the timer parameters for checking for artifact updates. */
    public TimerParameters updateTimer() { return updateTimer; }

    /** Returns the messaging parameters. */
    public JmsParameters messaging() { return messaging; }

    /**
     * A builder for JMS update manager parameters.
     *
     * @param  The type of the parent builder, if defined.
     */
    @SuppressWarnings("PackageVisibleField")
    public static class Builder
 extends AbstractBuilder
 {

        @CheckForNull UpdateServiceParameters updateService;
        @CheckForNull TimerParameters updateTimer;
        @CheckForNull JmsParameters messaging;

        protected Builder() { }

        /** Selectively parses the given configuration item. */
        public final Builder
 parse(final JmsUpdateManagerParametersCi ci) {
            if (null != ci.updateService)
                updateService = UpdateServiceParameters.parse(ci.updateService);
            if (null != ci.updateTimer)
                updateTimer = TimerParameters.parse(ci.updateTimer);
            if (null != ci.messaging)
                messaging = JmsParameters.parse(ci.messaging);
            return this;
        }

        public final Builder
 updateService(
                final @Nullable UpdateServiceParameters updateService) {
            this.updateService = updateService;
            return this;
        }

        public final Builder
 updateTimer(
                final @Nullable TimerParameters updateTimer) {
            this.updateTimer = updateTimer;
            return this;
        }

        public final Builder messaging(
                final @Nullable JmsParameters messaging) {
            this.messaging = messaging;
            return this;
        }

        @Override public final JmsUpdateManagerParameters build() {
            return new JmsUpdateManagerParameters(this);
        }
    } // Builder
}