metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ottobackwards <...@git.apache.org>
Subject [GitHub] metron pull request #530: METRON-777 Metron Extension System and Parser Exte...
Date Mon, 14 Aug 2017 23:03:30 GMT
Github user ottobackwards commented on a diff in the pull request:

    https://github.com/apache/metron/pull/530#discussion_r133083369
  
    --- Diff: bundles-lib/src/main/java/org/apache/metron/bundles/BundleSystem.java ---
    @@ -0,0 +1,182 @@
    +/*
    + * 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 org.apache.metron.bundles;
    +
    +import java.lang.invoke.MethodHandles;
    +import java.net.URI;
    +import java.util.ArrayList;
    +import java.util.LinkedList;
    +import java.util.List;
    +import org.apache.commons.vfs2.FileObject;
    +import org.apache.commons.vfs2.FileSystemManager;
    +import org.apache.metron.bundles.bundle.Bundle;
    +import org.apache.metron.bundles.util.BundleProperties;
    +import org.apache.metron.bundles.util.FileSystemManagerFactory;
    +import org.slf4j.Logger;
    +import org.slf4j.LoggerFactory;
    +
    +/**
    + * High level interface to the Bundle System.  While you may want to use the lower level
classes it
    + * is not required, as BundleSystem provides the base required interface for initializing
the system
    + * and instantiating classes
    + */
    +public class BundleSystem {
    +
    +  private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
    +
    +  /**
    +   * Builder for a BundleSystem. only {@link BundleProperties} are required. Beyond that,
the
    +   * BundleProperties, if they are the only parameter must have archive extension and
bundle
    +   * extension types properties present.
    +   */
    +  public static class Builder {
    +
    +    private BundleProperties properties;
    +    private FileSystemManager fileSystemManager;
    +    private List<Class> extensionClasses = new LinkedList<>();
    +    private Bundle systemBundle;
    +
    +    /**
    +     * The BundleProperties to use.  Unless other builder parameters override options
    +     * (withExtensionClasses ), they must have archive extension and bundle extensions
types
    +     * specified
    +     *
    +     * @param properties The BundleProperties
    +     * @return Builder
    +     */
    +    public Builder withBundleProperties(BundleProperties properties) {
    +      this.properties = properties;
    +      return this;
    +    }
    +
    +    /**
    +     * Provide a {@link FileSystemManager} to overide the default
    +     *
    +     * @param fileSystemManager override
    +     * @return Builder
    +     */
    +    public Builder withFileSystemManager(FileSystemManager fileSystemManager) {
    +      this.fileSystemManager = fileSystemManager;
    +      return this;
    +    }
    +
    +    /**
    +     * Provide Extension Classes.  If not provided with this override then the classes
will be
    +     * configured from the BundleProperties. If provided, the properties file will not
be used.
    +     *
    +     * @param extensionClasses override
    +     * @return Builder
    +     */
    +    public Builder withExtensionClasses(List<Class> extensionClasses) {
    +      this.extensionClasses.addAll(extensionClasses);
    +      return this;
    +    }
    +
    +    /**
    +     * Provide a SystemBundle.  If not provided with this override then the default SystemBundle
    +     * will be created.
    +     */
    +    public Builder withSystemBundle(Bundle systemBundle) {
    +      this.systemBundle = systemBundle;
    +      return this;
    +    }
    +
    +    /**
    +     * Builds a new BundleSystem.
    +     *
    +     * @return BundleSystem
    +     * @throws NotInitializedException if any errors happen during build
    +     */
    +    public BundleSystem build() throws NotInitializedException {
    +      if (this.properties == null) {
    +        throw new IllegalArgumentException("BundleProperties are required");
    --- End diff --
    
    I will make it more clear they will not be used for the classes, but will be used for
other things


---
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