com.oracle.bedrock.runtime.AssemblyBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bedrock-runtime Show documentation
Interfaces, classes and resources to construct, inspect and manage runtime processes.
There is a newer version: 7.0.5
/*
 * File: AssemblyBuilder.java
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * The contents of this file are subject to the terms and conditions of 
 * the Common Development and Distribution License 1.0 (the "License").
 *
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the License by consulting the LICENSE.txt file
 * distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
 *
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file LICENSE.txt.
 *
 * MODIFICATIONS:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 */

package com.oracle.bedrock.runtime;

import com.oracle.bedrock.Option;

/**
 * A builder of {@link Assembly}s on {@link Infrastructure}.
 * 
 * Copyright (c) 2014. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public interface AssemblyBuilder, B extends AssemblyBuilder>
{
    /**
     * Sets the {@link Option}s to be used as the basis launching each {@link Application}.
     * These {@link Option} will be overriden by those specifically provided for each application
     * as part of calling {@link #include(int, Class, Option...)} and by those defined when calling
     * {@link #build(Infrastructure, Option...)} or {@link #build(Option...)}.
     *
     * @param options  the {@link Option}s
     *
     * @return this {@link AssemblyBuilder}
     */
    B with(Option... options);


    /**
     * Includes the necessary information for launching one or more {@link Application}s of a specified
     * type as part of an {@link Assembly}, using {@link Platform#launch(Class, Option...)} when
     * {@link #build(Infrastructure, Option...)} method is called.
     * 

     * The {@link Platform} on which the {@link Application}s are launch on the {@link Infrastructure} is
     * based on the specified {@link Option}s.
     * 
     * Multiple calls to this method are permitted, allowing an {@link Assembly} to be created containing
     * multiple different types of {@link Application}s.
     *
     * @param count             the number of instances of the {@link Application} that should be launched for
     *                          the {@link Assembly}
     * @param applicationClass  the class of {@link Application}
     * @param options           the {@link Option}s to use for launching the {@link Application}s
     *
     * @return this {@link AssemblyBuilder}
     *
     * @see Platform#launch(String, Option...)
     */
    B include(int                count,
              Class applicationClass,
              Option...          options);


    /**
     * Builds an {@link Assembly} using the provided {@link Infrastructure} to acquire {@link Platform}s on which
     * to launch {@link Application}s.
     *
     * @param infrastructure  the {@link Infrastructure} on which to launch the {@link Application}s
     * @param options         the {@link Option}s to override those specified in {@link #include(int, Class, Option...)}
     *
     * @return an {@link Assembly} representing the collection of launched {@link Application}s.
     *
     * @throws RuntimeException when a problem occurs building the {@link Assembly}
     *
     * @see Platform
     */
    G build(Infrastructure infrastructure,
            Option...      options);


    /**
     * Builds an {@link Assembly} using local {@link Infrastructure} and overriding {@link Option}s
     * for launching {@link Application}s.
     *
     * @param options  the {@link Option}s to override those specified in {@link #include(int, Class, Option...)}
     *
     * @return an {@link Assembly} representing the collection of launched {@link Application}s.
     *
     * @throws RuntimeException when a problem occurs building the {@link Assembly}
     *
     * @see Infrastructure#local()
     */
    default G build(Option... options)
    {
        return build(Infrastructure.local(), options);
    }
}