com.oracle.bedrock.runtime.coherence.AbstractCoherenceClusterMember Maven / Gradle / Ivy
Show all versions of coherence-21.06 Show documentation
/*
* File: AbstractCoherenceClusterMember.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;
import com.oracle.bedrock.OptionsByType;
import com.oracle.bedrock.runtime.Application;
import com.oracle.bedrock.runtime.ApplicationProcess;
import com.oracle.bedrock.runtime.Platform;
import com.oracle.bedrock.runtime.coherence.callables.*;
import com.oracle.bedrock.runtime.java.AbstractJavaApplication;
import com.oracle.bedrock.runtime.java.JavaApplication;
import com.oracle.bedrock.runtime.java.JavaApplicationProcess;
import com.oracle.bedrock.runtime.java.features.JmxFeature;
import com.oracle.bedrock.util.Trilean;
import com.tangosol.net.Coherence;
import com.tangosol.net.NamedCache;
import com.tangosol.net.Session;
import com.tangosol.util.UID;
import javax.management.MBeanInfo;
import javax.management.ObjectName;
import java.util.Set;
/**
* An abstract implementation of a {@link CoherenceClusterMember}.
*
* Copyright (c) 2021. All Rights Reserved. Oracle Corporation.
* Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
*
* @author Brian Oliver
*/
public abstract class AbstractCoherenceClusterMember extends AbstractJavaApplication
implements CoherenceClusterMember
{
/**
* The MBean name of the Coherence Cluster MBean.
*/
public static final String MBEAN_NAME_CLUSTER = "Coherence:type=Cluster";
/**
* Constructs an {@link AbstractCoherenceClusterMember}.
*
* @param platform the {@link Platform} on which the {@link Application} was launched
* @param process the underlying {@link ApplicationProcess} representing the {@link Application}
* @param optionsByType the {@link OptionsByType} used to launch the {@link Application}
*/
public AbstractCoherenceClusterMember(Platform platform,
JavaApplicationProcess process,
OptionsByType optionsByType)
{
super(platform, process, optionsByType);
}
/**
* Obtains the Coherence Cluster {@link MBeanInfo} for the {@link AbstractCoherenceClusterMember}.
*
* If the JMX infrastructure in the {@link JavaApplication} is not yet
* available, it will block at wait for the default application timeout
* until it becomes available.
*
* @return a {@link MBeanInfo}
*
* @throws com.oracle.bedrock.deferred.PermanentlyUnavailableException
* when the resource is not available
* @throws UnsupportedOperationException when JMX is not enabled for the
* {@link JavaApplication}
*/
public MBeanInfo getClusterMBeanInfo()
{
JmxFeature jmxFeature = get(JmxFeature.class);
if (jmxFeature == null)
{
throw new UnsupportedOperationException("The JmxFeature (Java Management Extensions) haven't been enabled for this application");
}
else
{
try
{
return jmxFeature.getMBeanInfo(new ObjectName(MBEAN_NAME_CLUSTER));
}
catch (RuntimeException e)
{
throw e;
}
catch (Exception e)
{
throw new UnsupportedOperationException("Could not retrieve the Coherence Cluster MBean", e);
}
}
}
@Override
public int getClusterSize()
{
return invoke(new GetClusterSize());
}
@Override
public int getLocalMemberId()
{
return invoke(new GetLocalMemberId());
}
@Override
public UID getLocalMemberUID()
{
return invoke(new GetLocalMemberUID());
}
@Override
public Set getClusterMemberUIDs()
{
return invoke(new GetClusterMemberUIDs());
}
/**
* Obtains the Coherence Service {@link MBeanInfo} for the {@link AbstractCoherenceClusterMember}.
*
* If the JMX infrastructure in the {@link JavaApplication} is not yet
* available, it will block at wait for the default application timeout
* until it becomes available.
*
* @param serviceName the name of the service
* @param nodeId the nodeId on which the service is defined
*
* @return a {@link MBeanInfo}
*
* @throws com.oracle.bedrock.deferred.PermanentlyUnavailableException
* when the resource is not available
* @throws UnsupportedOperationException when JMX is not enabled for the
* {@link JavaApplication}
*/
public MBeanInfo getServiceMBeanInfo(String serviceName,
int nodeId)
{
JmxFeature jmxFeature = get(JmxFeature.class);
if (jmxFeature == null)
{
throw new UnsupportedOperationException("The JmxFeature (Java Management Extensions) haven't been enabled for this application");
}
else
{
try
{
return jmxFeature.getMBeanInfo(new ObjectName(String.format("Coherence:type=Service,name=%s,nodeId=%d",
serviceName,
nodeId)));
}
catch (RuntimeException e)
{
throw e;
}
catch (Exception e)
{
throw new UnsupportedOperationException(String.format("Could not retrieve the Coherence Service MBean [%s]",
serviceName),
e);
}
}
}
@Override
public String getRoleName()
{
return invoke(new GetLocalMemberRoleName());
}
@Override
public String getSiteName()
{
return invoke(new GetLocalMemberSiteName());
}
@Override
public String getClusterName()
{
return invoke(new GetClusterName());
}
@Override
@SuppressWarnings("unchecked")
public NamedCache getCache(String cacheName)
{
return (NamedCache) getCache(cacheName, Object.class, Object.class);
}
@Override
public NamedCache getCache(String cacheName,
Class keyClass,
Class valueClass)
{
return new CoherenceNamedCache<>(this, cacheName, keyClass, valueClass);
}
@Override
@SuppressWarnings({"unchecked"})
public NamedCache getCache(String sessionName, String cacheName)
{
return (NamedCache) getCache(Coherence.DEFAULT_NAME, sessionName, cacheName, Object.class, Object.class);
}
@Override
public NamedCache getCache(String sessionName,
String cacheName,
Class keyClass,
Class valueClass)
{
return getCache(Coherence.DEFAULT_NAME, sessionName, cacheName, keyClass, valueClass);
}
@Override
@SuppressWarnings({"unchecked"})
public NamedCache getCache(String coherenceName, String sessionName, String cacheName)
{
return (NamedCache) getCache(coherenceName, sessionName, cacheName, Object.class, Object.class);
}
@Override
public NamedCache getCache(String coherenceName,
String sessionName,
String cacheName,
Class keyClass,
Class valueClass)
{
return new CoherenceNamedCache<>(this, cacheName, keyClass, valueClass,
new GetSessionCache(coherenceName, sessionName, cacheName));
}
@Override
public Session getSession()
{
return getSession(Coherence.DEFAULT_NAME, Coherence.DEFAULT_NAME);
}
@Override
public Session getSession(String sessionName)
{
return getSession(Coherence.DEFAULT_NAME, sessionName);
}
@Override
public Session getSession(String coherenceName, String sessionName)
{
if (invoke(new SessionExists(coherenceName, sessionName)))
{
return new CoherenceSession(this, coherenceName, sessionName);
}
throw new IllegalArgumentException("No session exists in the remote member named " + sessionName
+ " in Coherence instance named " + coherenceName);
}
@Override
public boolean isServiceRunning(String serviceName)
{
return invoke(new IsServiceRunning(serviceName));
}
@Override
public Trilean isStorageEnabled(String serviceName)
{
return invoke(new IsServiceStorageEnabled(serviceName));
}
@Override
public ServiceStatus getServiceStatus(String serviceName)
{
return invoke(new GetServiceStatus(serviceName));
}
}