org.glassfish.common.util.admin.CommandModelImpl 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) 2008-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] Payara Foundation and/or affiliates
package org.glassfish.common.util.admin;
import com.sun.enterprise.util.AnnotationUtil;
import com.sun.enterprise.util.LocalStringManager;
import com.sun.enterprise.util.LocalStringManagerImpl;
import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.ParamDefaultCalculator;
import org.glassfish.api.UnknownOptionsAreOperands;
import org.glassfish.api.admin.CommandModel;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.ManagedJob;
import org.glassfish.api.admin.config.ModelBinding;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.config.Attribute;
/**
* Model for an administrative command
*
* @author Jerome Dochez
*/
public class CommandModelImpl extends CommandModel {
// use a LinkedHashMap so params appears in the order they are declared in the class.
private final Map params;
private final String commandName;
private final Class commandClass;
private final ExecuteOn execOn;
private final I18n i18n;
private final boolean dashOk;
private final LocalStringManager localStrings;
private boolean managedJob;
public CommandModelImpl(Class commandType) {
Service service = commandType.getAnnotation(Service.class);
commandName = service != null ? service.name() : null;
commandClass = commandType;
i18n = commandType.getAnnotation(I18n.class);
execOn = commandType.getAnnotation(ExecuteOn.class);
localStrings = new LocalStringManagerImpl(commandType);
managedJob = AnnotationUtil.presentTransitive(ManagedJob.class, commandType);
params = init(commandType, i18n, localStrings);
Class currentClazz = commandType;
boolean found = false;
while (currentClazz != null) {
if (currentClazz.isAnnotationPresent(UnknownOptionsAreOperands.class)) {
found = true;
}
currentClazz = currentClazz.getSuperclass();
}
dashOk = found;
}
public static Map init(Class commandType, I18n i18n, LocalStringManager localStrings) {
Class currentClazz = commandType;
Map results = new LinkedHashMap();
while (currentClazz != null) {
for (Field f : currentClazz.getDeclaredFields()) {
I18n fieldI18n = f.getAnnotation(I18n.class);
if (fieldI18n!=null) {
localStrings = new LocalStringManagerImpl(commandType);
}
add(results, f, i18n, localStrings);
}
for (Method m : currentClazz.getDeclaredMethods()) {
I18n fieldI18n = m.getAnnotation(I18n.class);
if (fieldI18n!=null) {
localStrings = new LocalStringManagerImpl(commandType);
}
add(results, m, i18n, localStrings);
}
currentClazz = currentClazz.getSuperclass();
}
return results;
}
@Override
public String getLocalizedDescription() {
if (i18n!=null) {
return localStrings.getLocalString(i18n.value(), "");
} else {
return null;
}
}
@Override
public String getUsageText() {
if (i18n!=null) {
return localStrings.getLocalString(i18n.value()+".usagetext", null);
} else {
return null;
}
}
@Override
public String getCommandName() {
return commandName;
}
@Override
public CommandModel.ParamModel getModelFor(String paramName) {
return params.get(paramName);
}
@Override
public Collection getParametersNames() {
return params.keySet();
}
@Override
public Class getCommandClass() {
return commandClass;
}
@Override
public ExecuteOn getClusteringAttributes() {
return execOn;
}
@Override
public boolean isManagedJob() {
return managedJob;
}
public void setManagedJob(boolean value) {
this.managedJob = value;
}
/**
* Should an unknown option be considered an operand by asadmin?
*/
@Override
public boolean unknownOptionsAreOperands() {
return dashOk;
}
public void addParam(String name, CommandModel.ParamModel param) {
params.put(name, param);
}
private static void add(Map results, AnnotatedElement e, I18n parentI18n, LocalStringManager localStrings) {
Param param = e.getAnnotation(Param.class);
if (param!=null) {
String defaultValue = param.defaultValue();
ModelBinding mb = e.getAnnotation(ModelBinding.class);
if (mb!=null && defaultValue.isEmpty()) {
Method m = null;
try {
m = mb.type().getMethod(mb.getterMethodName());
} catch (NoSuchMethodException e1) {
// ignore.
}
if (m!=null) {
Attribute attr = m.getAnnotation(Attribute.class);
if (attr!=null) {
defaultValue = attr.defaultValue();
}
}
}
ParamModel model = new ParamModelImpl(e, defaultValue, parentI18n, localStrings);
if (!results.containsKey(model.getName())) {
results.put(model.getName(), model);
}
}
}
@Override
public void add(ParamModel model) {
if (!params.containsKey(model.getName())) {
params.put(model.getName(), model);
}
}
private static class ParamModelImpl extends ParamModel {
private final String name;
private final Param param;
private final I18n i18n;
private final I18n parentI18n;
private final LocalStringManager localStrings;
private final Class type;
private final String defaultValue;
ParamModelImpl(AnnotatedElement e, String defaultValue, I18n parentI18n, LocalStringManager localStrings) {
Param p = e.getAnnotation(Param.class);
this.parentI18n = parentI18n;
this.localStrings = localStrings;
name = getParamName(p, e);
this.defaultValue = defaultValue;
param = p;
i18n = e.getAnnotation(I18n.class);
if (e instanceof Method) {
type = ((Method) e).getReturnType();
} else if (e instanceof Field) {
type = ((Field) e).getType();
} else {
type = String.class;
}
}
@Override
public String getName() {
return name;
}
@Override
public Param getParam() {
return new Param() {
@Override
public String name() {
return param.name();
}
@Override
public String acceptableValues() {
return param.acceptableValues();
}
@Override
public boolean optional() {
return param.optional();
}
@Override
public String shortName() {
return param.shortName();
}
@Override
public boolean primary() {
return param.primary();
}
@Override
public String defaultValue() {
return defaultValue;
}
@Override
public Class defaultCalculator() {
return param.defaultCalculator();
}
@Override
public boolean password() {
return param.password();
}
@Override
public char separator() {
return param.separator();
}
@Override
public boolean multiple() {
return param.multiple();
}
@Override
public boolean obsolete() {
return param.obsolete();
}
@Override
public String alias() {
return param.alias();
}
@Override
public Class annotationType() {
return param.annotationType();
}
};
}
private String getLocalizedString(String type) {
String paramDesc=null;
if (i18n!=null) {
paramDesc = localStrings.getLocalString(i18n.value() + type, "");
} else {
if (parentI18n!=null) {
paramDesc = localStrings.getLocalString(parentI18n.value() + "." + name + type, "");
}
}
if (paramDesc==null) {
paramDesc="";
}
return paramDesc;
}
@Override
public String getLocalizedDescription() {
return getLocalizedString("");
}
@Override
public String getLocalizedPrompt() {
return getLocalizedString(".prompt");
}
@Override
public String getLocalizedPromptAgain() {
return getLocalizedString(".promptAgain");
}
public I18n getI18n() {
return i18n;
}
@Override
public Class getType() {
return type;
}
}
}