com.oracle.bedrock.runtime.coherence.options.Clustering Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence-21.06 Show documentation
A set of tools to manage and control Oracle Coherence 21.06 processes at runtime.
There is a newer version: 7.0.6
/*
 * File: Clustering.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.coherence.options;

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.coherence.CoherenceClusterMember;
import com.oracle.bedrock.runtime.java.options.SystemProperties;
import com.oracle.bedrock.runtime.java.options.SystemProperty;

/**
 * An {@link Option} to specify when {@link CoherenceClusterMember} is allowed to cluster (using tcmp).
 * 
 * Copyright (c) 2021. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public class Clustering implements Profile, Option
{
    /**
     * The tangosol.coherence.tcmp.enabled property.
     */
    public static final String PROPERTY = "coherence.tcmp.enabled";

    /**
     * Is local storage enabled?
     */
    private boolean enabled;


    /**
     * Constructs a {@link Clustering} for the specified value.
     *
     * @param enabled  is local storage enabled?
     */
    private Clustering(boolean enabled)
    {
        this.enabled = enabled;
    }


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


    /**
     * Obtains a {@link Clustering} for a specified value.
     *
     * @param enabled  is local storage enabled?
     *
     * @return a {@link Clustering} for the specified value
     */
    public static Clustering enabled(boolean enabled)
    {
        return new Clustering(enabled);
    }


    /**
     * Obtains a {@link Clustering} that is enabled.
     *
     * @return a {@link Clustering} that is enabled
     */
    public static Clustering enabled()
    {
        return new Clustering(true);
    }


    /**
     * Obtains a {@link Clustering} that is disabled.
     *
     * @return a {@link Clustering} that is disabled
     */
    public static Clustering disabled()
    {
        return new Clustering(false);
    }


    @Override
    public void onLaunching(Platform      platform,
                            MetaClass     metaClass,
                            OptionsByType optionsByType)
    {
        SystemProperties systemProperties = optionsByType.get(SystemProperties.class);

        if (systemProperties != null)
        {
            optionsByType.add(SystemProperty.of(PROPERTY, enabled));
        }
    }


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


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


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

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

        Clustering that = (Clustering) o;

        return enabled == that.enabled;

    }


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