com.sun.enterprise.v3.admin.GetCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. 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 at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* 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]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2019-2021] [Payara Foundation and/or its affiliates]
package com.sun.enterprise.v3.admin;
import java.util.*;
import java.util.logging.Logger;
import com.sun.enterprise.config.modularity.GetSetModularityHelper;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.admin.report.PropsFileActionReporter;
import java.util.logging.Level;
import org.glassfish.api.ActionReport;
import org.glassfish.api.Param;
import org.glassfish.api.admin.*;
import org.glassfish.flashlight.MonitoringRuntimeDataRegistry;
import org.glassfish.internal.api.Target;
import jakarta.inject.Inject;
import org.glassfish.api.admin.AccessRequired.AccessCheck;
import org.jvnet.hk2.annotations.Optional;
import org.jvnet.hk2.annotations.Service;
import org.glassfish.hk2.api.PerLookup;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.kernel.KernelLoggerInfo;
import org.jvnet.hk2.config.Dom;
import org.jvnet.hk2.config.types.Property;
/**
* User: Jerome Dochez
* Date: Jul 10, 2008
* Time: 12:17:26 AM
*/
@Service(name = "get")
@PerLookup
@CommandLock(CommandLock.LockType.NONE)
@ExecuteOn({RuntimeType.DAS, RuntimeType.INSTANCE})
@RestEndpoints({
@RestEndpoint(configBean=Domain.class,
opType=RestEndpoint.OpType.GET,
path="get",
description="Get")
})
public class GetCommand extends V2DottedNameSupport implements AdminCommand,
AdminCommandSecurity.Preauthorization,
AdminCommandSecurity.AccessCheckProvider {
@Inject
private MonitoringReporter mr;
@Inject
private Domain domain;
@Inject
private ServerEnvironment serverEnv;
@Inject
private Target targetService;
@Inject
private ServiceLocator habitat;
@Param(optional = true, defaultValue = "false", shortName = "m")
private Boolean monitor;
@Param(optional = true, defaultValue = "false", shortName = "c")
private Boolean aggregateDataOnly;
@Param(primary = true)
private String pattern;
@Inject @Optional
private MonitoringRuntimeDataRegistry mrdr;
final private static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(GetCommand.class);
private ActionReport report;
private List matchingNodesSorted;
private String prefix;
@Inject
@Optional
GetSetModularityHelper modularityHelper;
@Override
public boolean preAuthorization(AdminCommandContext context) {
if (monitor) {
return preAuthorizationForMonitoring(context);
} else {
return preAuthorizationForNonMonitoring(context);
}
}
private boolean preAuthorizationForMonitoring(final AdminCommandContext context) {
mr.prepareGet(context, pattern, aggregateDataOnly);
return true;
}
private boolean preAuthorizationForNonMonitoring(final AdminCommandContext context) {
report = context.getActionReport();
/* Issue 5918 Used in ManifestManager to keep output sorted */
try {
PropsFileActionReporter reporter = (PropsFileActionReporter) report;
reporter.useMainChildrenAttribute(true);
}
catch (ClassCastException e) {
// ignore this is not a manifest output.
}
matchingNodesSorted = findSortedMatchingNodes();
return matchingNodesSorted != null;
}
@Override
public Collection getAccessChecks() {
if (monitor) {
return mr.getAccessChecksForGet();
} else {
return getAccessChecksForNonMonitoring();
}
}
private Collection getAccessChecksForNonMonitoring() {
final Collection accessChecks = new ArrayList();
for (Map.Entry entry : matchingNodesSorted) {
accessChecks.add(new AccessCheck(AccessRequired.Util.resourceNameFromDom((Dom)entry.getKey()), "read"));
}
return accessChecks;
}
@Override
public void execute(AdminCommandContext context) {
if (monitor) {
getMonitorAttributes(context);
//String old = report.getMessage();
//String append = "\nXXXXXXXXX\n" + mr.toString();
//report.setMessage(old == null ? append : old + append);
return;
}
boolean foundMatch = false;
for (Map.Entry node : matchingNodesSorted) {
// if we get more of these special cases, we should switch to a Renderer pattern
if (Property.class.getName().equals(node.getKey().model.targetTypeName)) {
// special display for properties...
if (matches(node.getValue(), pattern)) {
ActionReport.MessagePart part = report.getTopMessagePart().addChild();
part.setChildrenType("DottedName");
part.setMessage(prefix + node.getValue() + "=" + node.getKey().attribute("value"));
foundMatch = true;
}
}
else {
Map attributes = getNodeAttributes(node.getKey(), pattern);
TreeMap attributesSorted = new TreeMap(attributes);
for (Map.Entry name : attributesSorted.entrySet()) {
String finalDottedName = node.getValue() + "." + name.getKey();
if (matches(finalDottedName, pattern)) {
ActionReport.MessagePart part = report.getTopMessagePart().addChild();
part.setChildrenType("DottedName");
part.setMessage(prefix + node.getValue() + "." + name.getKey() + "=" + name.getValue());
foundMatch = true;
}
}
}
}
if (!foundMatch) {
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
//report.setMessage("No object found matching " + pattern);
report.setMessage(localStrings.getLocalString("admin.get.path.notfound", "Dotted name path {0} not found.", prefix + pattern));
}
}
private void getMonitorAttributes(AdminCommandContext ctxt) {
Logger l = KernelLoggerInfo.getLogger();
if (l.isLoggable(Level.FINE)) {
l.log(Level.FINE, "Get Command: {0}", mr.toString());
}
mr.execute();
}
private List findSortedMatchingNodes() {
if (!monitor) {
if (modularityHelper != null) {
modularityHelper.getLocationForDottedName(pattern);
}
}
// check for logging patterns
if (pattern.contains(".log-service")) {
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setMessage(localStrings.getLocalString("admin.get.invalid.logservice.command", "For getting log levels/attributes use list-log-levels/list-log-attributes command."));
return null;
}
//check for incomplete dotted name
if (!pattern.equals("*")) {
if (pattern.lastIndexOf(".") == -1 || pattern.lastIndexOf(".") == (pattern.length() - 1)) {
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
//report.setMessage("Missing expected dotted name part");
report.setMessage(localStrings.getLocalString("missing.dotted.name", "Missing expected dotted name part"));
return null;
}
}
// first let's get the parent for this pattern.
TreeNode[] parentNodes = getAliasedParent(domain, pattern);
// reset the pattern.
prefix = "";
if(!pattern.startsWith(parentNodes[0].relativeName)) {
prefix = pattern.substring(0, pattern.indexOf(parentNodes[0].relativeName));
pattern = parentNodes[0].relativeName;
} else {
pattern = parentNodes[0].relativeName;
}
Map matchingNodes;
Map dottedNames = new HashMap();
for (TreeNode parentNode : parentNodes) {
dottedNames.putAll(getAllDottedNodes(parentNode.node));
if (parentNode.name.equals("")) {
dottedNames.put(parentNode.node, "domain");
}
}
matchingNodes = getMatchingNodes(dottedNames, pattern);
if (matchingNodes.isEmpty() && pattern.lastIndexOf('.') != -1) {
// it's possible the user is just looking for an attribute, let's remove the
// last element from the pattern.
matchingNodes = getMatchingNodes(dottedNames, pattern.substring(0, pattern.lastIndexOf(".")));
}
//No matches found - report the failure and return
if (matchingNodes.isEmpty()) {
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
//report.setMessage("Dotted name path \"" + prefix + pattern + "\" not found.");
report.setMessage(localStrings.getLocalString("admin.get.path.notfound", "Dotted name path {0} not found.", prefix + pattern));
return null;
}
List result = sortNodesByDottedName(matchingNodes);
result = applyOverrideRules(result);
return result;
}
}