com.oracle.bedrock.runtime.java.profiles.CommercialFeatures Maven / Gradle / Ivy

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.3
/*
 * File: CommercialFeatures.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.java.profiles;

import com.oracle.bedrock.Option;
import com.oracle.bedrock.OptionsByType;
import com.oracle.bedrock.runtime.Application;
import com.oracle.bedrock.runtime.MetaClass;
import com.oracle.bedrock.runtime.Platform;
import com.oracle.bedrock.runtime.Profile;
import com.oracle.bedrock.runtime.java.JavaApplication;
import com.oracle.bedrock.runtime.java.options.Freeform;

import java.lang.management.ManagementFactory;

/**
 * Defines a {@link Profile} to enable/disable using commercial features with the
 * Oracle Java Virtual Machine
 * 
 * Copyright (c) 2016. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public class CommercialFeatures implements Profile, Option
{
    /**
     * Should remote debugging be enabled for a {@link JavaApplication}.
     */
    private boolean enabled;


    /**
     * Privately constructs a {@link CommercialFeatures} {@link Profile}.
     *
     * @param enabled           is the use of commercial features enabled
     */
    private CommercialFeatures(boolean enabled)
    {
        this.enabled = enabled;
    }


    /**
     * Obtains if {@link CommercialFeatures} is enabled.
     *
     * @return  true if {@link CommercialFeatures} is enabled, false otherwise
     */
    public boolean isEnabled()
    {
        return enabled;
    }


    @Override
    public void onLaunching(Platform      platform,
                            MetaClass     metaClass,
                            OptionsByType optionsByType)
    {
        if (enabled)
        {
            optionsByType.add(new Freeform("-XX:+UnlockCommercialFeatures"));
        }
    }


    @Override
    public void onLaunched(Platform      platform,
                           Application   application,
                           OptionsByType optionsByType)
    {
    }


    @Override
    public void onClosing(Platform      platform,
                          Application   application,
                          OptionsByType optionsByType)
    {
    }


    /**
     * Obtains an enabled {@link CommercialFeatures} {@link Profile}.
     *
     * @return  a {@link CommercialFeatures} {@link Option}
     */
    public static CommercialFeatures enabled()
    {
        return new CommercialFeatures(true);
    }


    /**
     * Obtains a disabled {@link CommercialFeatures} {@link Profile}.
     *
     * @return  a {@link CommercialFeatures} {@link Option}
     */
    public static CommercialFeatures disabled()
    {
        return new CommercialFeatures(false);
    }


    /**
     * Obtains a {@link CommercialFeatures} {@link Profile}, auto-detecting if it should be
     * enabled based on the Java process in which the thread is executing.
     *
     * @return  a {@link CommercialFeatures} {@link Option}
     */
    @OptionsByType.Default
    public static CommercialFeatures autoDetect()
    {
        try
        {
            return ManagementFactory.getRuntimeMXBean().getInputArguments().stream()
            .filter(arg -> arg.contains("-XX:+UnlockCommercialFeatures")).findFirst().isPresent() ? enabled()
                                                                                                  : disabled();
        }
        catch (Throwable t)                                                         
        {
            System.err.println("Error trying to determine commercial features status - " + t.getMessage());

            return disabled();
        }
    }


    @Override
    public boolean equals(Object o)
    {
        if (this == o)
        {
            return true;
        }

        if (!(o instanceof CommercialFeatures))
        {
            return false;
        }

        CommercialFeatures that = (CommercialFeatures) o;

        return enabled == that.enabled;

    }


    @Override
    public int hashCode()
    {
        return (enabled ? 1 : 0);
    }
}