brooklyn-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aledsage <...@git.apache.org>
Subject [GitHub] incubator-brooklyn pull request: CLI commands for manipulating cat...
Date Mon, 18 May 2015 20:39:27 GMT
Github user aledsage commented on a diff in the pull request:

    https://github.com/apache/incubator-brooklyn/pull/617#discussion_r30545124
  
    --- Diff: core/src/main/java/brooklyn/catalog/internal/CatalogInitialization.java ---
    @@ -0,0 +1,377 @@
    +/*
    + * Licensed to the Apache Software Foundation (ASF) under one
    + * or more contributor license agreements.  See the NOTICE file
    + * distributed with this work for additional information
    + * regarding copyright ownership.  The ASF 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 brooklyn.catalog.internal;
    +
    +import java.io.File;
    +import java.util.Collection;
    +import java.util.List;
    +
    +import org.slf4j.Logger;
    +import org.slf4j.LoggerFactory;
    +
    +import brooklyn.catalog.CatalogItem;
    +import brooklyn.config.BrooklynServerConfig;
    +import brooklyn.management.ManagementContext;
    +import brooklyn.management.ManagementContextInjectable;
    +import brooklyn.management.internal.ManagementContextInternal;
    +import brooklyn.util.ResourceUtils;
    +import brooklyn.util.collections.MutableList;
    +import brooklyn.util.exceptions.Exceptions;
    +import brooklyn.util.exceptions.FatalRuntimeException;
    +import brooklyn.util.exceptions.RuntimeInterruptedException;
    +import brooklyn.util.flags.TypeCoercions;
    +import brooklyn.util.guava.Maybe;
    +import brooklyn.util.net.Urls;
    +import brooklyn.util.text.Strings;
    +
    +import com.google.common.annotations.Beta;
    +import com.google.common.base.Function;
    +import com.google.common.base.Preconditions;
    +import com.google.common.collect.ImmutableList;
    +import com.google.common.collect.Iterables;
    +
    +@Beta
    +public class CatalogInitialization implements ManagementContextInjectable {
    +
    +    /*
    +
    +    A1) if not persisting, go to B1
    +    A2) if --catalog-reset, delete persisted catalog items
    +    A3) read persisted catalog items (possibly deleted in A2), go to C1
    +    A4) go to B1
    +
    +    B1) look for --catalog-initial, if so read it, then go to C1
    +    B2) look for BrooklynServerConfig.BROOKLYN_CATALOG_URL, if so, read it, supporting
YAML or XML (warning if XML), then go to C1
    +    B3) look for ~/.brooklyn/catalog.bom, if exists, read it then go to C1
    +    B4) look for ~/.brooklyn/brooklyn.xml, if exists, warn, read it then go to C1
    +    B5) read all classpath://brooklyn/default.catalog.bom items, if they exist (and for
now they will)
    +    B6) go to C1
    +
    +    C1) if --catalog-add, read and add those items
    +
    +    D1) if persisting, read the rest of the persisted items (entities etc)
    +
    +     */
    +
    +    private static final Logger log = LoggerFactory.getLogger(CatalogInitialization.class);
    +    
    +    String initialUri;
    +    boolean reset;
    +    String additionsUri;
    +    boolean force;
    +
    +    boolean disallowLocal = false;
    +    List<Function<CatalogInitialization, Void>> callbacks = MutableList.of();
    +    boolean hasRunBestEffort = false, hasRunOfficial = false, isPopulating = false;
    +    
    +    ManagementContext managementContext;
    +    boolean isStartingUp = false;
    +    boolean failOnStartupErrors = false;
    +    
    +    Object mutex = new Object();
    +    
    +    public CatalogInitialization(String initialUri, boolean reset, String additionUri,
boolean force) {
    +        this.initialUri = initialUri;
    +        this.reset = reset;
    +        this.additionsUri = additionUri;
    +        this.force = force;
    +    }
    +    
    +    public CatalogInitialization() {
    +        this(null, false, null, false);
    +    }
    +
    +    public void injectManagementContext(ManagementContext managementContext) {
    +        if (this.managementContext!=null && managementContext!=null &&
!this.managementContext.equals(managementContext))
    +            throw new IllegalStateException("Cannot switch management context of "+this+";
from "+this.managementContext+" to "+managementContext);
    +        this.managementContext = managementContext;
    +    }
    +    
    +    public ManagementContext getManagementContext() {
    +        return Preconditions.checkNotNull(managementContext, "management context has
not been injected into "+this);
    +    }
    +
    +    public CatalogInitialization addPopulationCallback(Function<CatalogInitialization,
Void> callback) {
    +        callbacks.add(callback);
    +        return this;
    +    }
    +
    +    public boolean isInitialResetRequested() {
    +        return reset;
    +    }
    +
    +    public boolean hasRunOfficial() { return hasRunOfficial; }
    +    public boolean hasRunIncludingBestEffort() { return hasRunOfficial || hasRunBestEffort;
}
    +
    +    /** makes or updates the mgmt catalog, based on the settings in this class */
    +    public void populateCatalog(boolean needsInitial, Collection<CatalogItem<?,
?>> optionalItemsForResettingCatalog) {
    +        try {
    +            isPopulating = true;
    +            synchronized (mutex) {
    +                BasicBrooklynCatalog catalog = (BasicBrooklynCatalog) managementContext.getCatalog();
    +                if (!catalog.getCatalog().isLoaded()) {
    +                    catalog.load();
    +                } else {
    +                    if (needsInitial && (hasRunOfficial || hasRunBestEffort))
{
    +                        // an indication that something caused it to load early; not
severe, but unusual
    +                        log.warn("Catalog initialization has not properly run but management
context has a catalog; re-populating, possibly overwriting items installed during earlier
access (it may have been an early web request)");
    +                        catalog.reset(ImmutableList.<CatalogItem<?,?>>of());
    +                    }
    +                }
    +                hasRunOfficial = true;
    +
    +                populateCatalog(catalog, needsInitial, true, optionalItemsForResettingCatalog);
    +            }
    +        } finally {
    +            hasRunOfficial = true;
    +            isPopulating = false;
    +        }
    +    }
    +
    +    private void populateCatalog(BasicBrooklynCatalog catalog, boolean needsInitial,
boolean runCallbacks, Collection<CatalogItem<?, ?>> optionalItemsForResettingCatalog)
{
    --- End diff --
    
    I'd prefer to not bother passing in arguments that are always true. For example, `runCallbacks`
is true in every caller, so we can miss it out.
    
    I'd also go for a name like `populateCatalogImpl` to indicate that it's the internal implementation
(but no strong feelings on that one).


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message