com.oracle.tools.runtime.java.JavaApplicationSchema Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oracle-tools-all Show documentation
The Oracle Tools artifacts as a single distribution.
There is a newer version: 2.0.0-RC9
/*
 * File: JavaApplicationSchema.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.tools.runtime.java;

import com.oracle.tools.runtime.Application;
import com.oracle.tools.runtime.ApplicationConsole;
import com.oracle.tools.runtime.ApplicationSchema;
import com.oracle.tools.runtime.PropertiesBuilder;

import java.util.List;
import java.util.Properties;

/**
 * A {@link JavaApplicationSchema} is a Java specific {@link ApplicationSchema}.
 * 
 * Copyright (c) 2011. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public interface JavaApplicationSchema, S extends JavaApplicationSchema>
    extends ApplicationSchema
{
    /**
     * Obtains the {@link PropertiesBuilder} that will be used as a basis for configuring the Java System Properties
     * of the realized {@link JavaApplication}s from an {@link JavaApplicationBuilder}.
     *
     * @return {@link PropertiesBuilder}
     */
    public PropertiesBuilder getSystemPropertiesBuilder();


    /**
     * Obtains the JVM options to be used for starting the {@link JavaApplication}.
     *
     * @return A {@link List} of {@link String}s
     */
    public List getJVMOptions();


    /**
     * Obtains the {@link ClassPath} to be used for the {@link JavaApplication}.
     *
     * @return {@link ClassPath}
     */
    public ClassPath getClassPath();


    /**
     * Obtain the application main class name.
     *
     * @return {@link String}
     */
    public String getApplicationClassName();


    /**
     * Instantiates a suitable {@link JavaApplication} to control the underlying
     * {@link JavaProcess}.  It's through this {@link JavaApplication}
     * that developers will interact with the underlying Java {@link Process}.
     *
     * @param process               the {@link JavaProcess} representing the {@link JavaApplication}
     * @param name                  the name of the {@link JavaApplication}
     * @param console               the {@link ApplicationConsole} that will be used for I/O by the
     *                              realized {@link Application}. This may be null if not required
     * @param environmentVariables  the environment variables used when starting the {@link JavaApplication}
     * @param systemProperties      the system properties provided to the {@link JavaApplication}
     *
     * @return a {@link JavaApplication}
     */
    public A createJavaApplication(JavaProcess        process,
                                   String             name,
                                   ApplicationConsole console,
                                   Properties         environmentVariables,
                                   Properties         systemProperties);
}
Related Artifacts