org.glassfish.gms.admin.GMSAnnounceBeforeStartClusterCommand Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.gms.admin;
import com.sun.logging.LogDomains;
import org.glassfish.gms.bootstrap.GMSAdapterService;
import org.glassfish.gms.bootstrap.GMSAdapter;
import com.sun.enterprise.config.serverbeans.*;
import com.sun.enterprise.ee.cms.core.GMSConstants;
import org.glassfish.api.ActionReport;
import org.glassfish.api.Param;
import org.glassfish.api.admin.*;
import jakarta.inject.Inject;
import org.glassfish.logging.annotation.LogMessageInfo;
import org.glassfish.logging.annotation.LogMessagesResourceBundle;
import org.glassfish.logging.annotation.LoggerInfo;
import org.jvnet.hk2.annotations.Service;
import org.glassfish.hk2.api.PerLookup;
import org.glassfish.hk2.api.ServiceLocator;
import java.util.*;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.ee.cms.core.GroupManagementService;
import java.util.LinkedList;
import java.util.List;
import org.glassfish.api.logging.LogLevel;
import java.util.logging.Logger;
@Service(name = "_gms-announce-before-start-cluster-command")
@Supplemental(value = "start-cluster", on = Supplemental.Timing.Before, ifFailure = FailurePolicy.Warn)
@PerLookup
@RestEndpoints({
@RestEndpoint(configBean=Domain.class,
opType=RestEndpoint.OpType.POST,
path="_gms-announce-before-start-cluster-command",
description="_gms-announce-before-start-cluster-command")
})
public class GMSAnnounceBeforeStartClusterCommand implements AdminCommand {
//private static final Logger logger = LogDomains.getLogger(
// GMSAnnounceBeforeStartClusterCommand.class, LogDomains.GMS_LOGGER);
@LoggerInfo(subsystem = "CLSTR", description="Group Management Service Admin Logger", publish=true)
private static final String GMS_LOGGER_NAME = "jakarta.enterprise.cluster.gms.admin";
@LogMessagesResourceBundle
private static final String LOG_MESSAGES_RB = "org.glassfish.cluster.gms.LogMessages";
static final Logger GMS_LOGGER = Logger.getLogger(GMS_LOGGER_NAME, LOG_MESSAGES_RB);
//# GMSAnnounceBeforeStartClusterCommand
//cluster.start.exception=GMSAD3004: An exception occurred while announcing GMS group startup: {0}
//GMSAD3004.diag.cause.1=An unexpected exception occurred in the GMS implementation.
//GMSAD3004.diag.check.1=Check the server log file for more information from Shoal-GMS.
@LogMessageInfo(message = "An exception occurred while announcing GMS group startup: {0}",
level="WARNING",
cause="An unexpected exception occurred in the GMS implementation.",
action="Check the server log file for more information from Shoal-GMS.")
private static final String GMS_CLUSTER_START_EXCEPTION="NCLS-CLSTR-30004";
@Inject
private ServerEnvironment env;
@Inject
private ServiceLocator habitat;
@Param(optional = false, primary = true)
private String clusterName;
@Inject
private Domain domain;
@Inject
private CommandRunner runner;
@Param(optional = true, defaultValue = "false")
private boolean verbose;
@Inject
GMSAdapterService gmsAdapterService;
private GroupManagementService gms = null;
private boolean gmsStartCluster = false;
private List clusterMembers = EMPTY_LIST;
private GMSAdapter gmsadapter = null;
static final private List EMPTY_LIST = new LinkedList();
@Override
public void execute(AdminCommandContext context) {
ActionReport report = context.getActionReport();
try {
if (gmsAdapterService.isGmsEnabled()) {
gmsadapter = gmsAdapterService.getGMSAdapterByName(clusterName);
// gmsadapter can be null if GMSEnabled=false for clusterName.
if (gmsadapter != null) {
gms = gmsadapter.getModule();
if (gms != null) {
clusterMembers = getClusterMembers();
// no need to announce a zero instance cluster.
if (clusterMembers != null && clusterMembers.size() > 0) {
// one or more clustered instances for this cluster in domain.xml.
// now check if any clustered instance are already running.
// DAS is a SPECTATOR so it will not be in list of current core members.
// If one or more clustered instances is already running, do not consider this a GROUP_STARTUP,
// but treat as a series of individual INSTANCE_STARTUP for instances that do get started.
// no gms calls needed if not a GROUP_STARTUP.
List startedGMSMembers = gms.getGroupHandle().getCurrentCoreMembers();
if (startedGMSMembers.size() == 0) {
try {
// must be called on DAS only.
gms.announceGroupStartup(clusterName, GMSConstants.groupStartupState.INITIATED, clusterMembers);
gmsStartCluster = true;
} catch (Throwable t) {
// ensure gms group startup announcement does not interfere with starting cluster.
// any exception here should not interfere with starting cluster.
GMS_LOGGER.log(LogLevel.WARNING,
GMS_CLUSTER_START_EXCEPTION,
t.getLocalizedMessage());
}
} // else from GMS perspective treat remaining instances getting started as INSTANCE_START, not GROUP_START.
// nothing gms specific to do for this case.
}
}
}
}
} finally {
if (gms != null) {
GMSAnnounceSupplementalInfo result = new GMSAnnounceSupplementalInfo(clusterMembers, gmsStartCluster, gmsadapter);
report.setResultType(GMSAnnounceSupplementalInfo.class, result);
}
}
}
private List getClusterMembers() {
List clusterMembers = EMPTY_LIST;
com.sun.enterprise.config.serverbeans.Cluster cluster = domain.getClusterNamed(clusterName);
List targetServers = null;
if (cluster != null) {
// Get the list of servers in the cluster.
targetServers = domain.getServersInTarget(clusterName);
if (targetServers != null) {
clusterMembers = new ArrayList(targetServers.size());
for (Server server : targetServers) {
clusterMembers.add(server.getName());
}
}
}
return clusterMembers;
}
}