com.sun.enterprise.security.cli.CreateAuditModule 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-2012 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 [2021] Payara Foundation and/or affiliates
package com.sun.enterprise.security.cli;
import org.jvnet.hk2.config.types.Property;
import java.util.List;
import org.glassfish.api.admin.AdminCommand;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.ActionReport;
import org.jvnet.hk2.annotations.Service;
import jakarta.inject.Inject;
import jakarta.inject.Named;
import org.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.config.ConfigSupport;
import org.jvnet.hk2.config.SingleConfigCode;
import org.jvnet.hk2.config.TransactionFailure;
import com.sun.enterprise.config.serverbeans.SecurityService;
import com.sun.enterprise.config.serverbeans.AuditModule;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.security.SecurityConfigListener;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.util.SystemPropertyConstants;
import java.beans.PropertyVetoException;
import org.glassfish.api.admin.AccessRequired;
import org.glassfish.api.admin.AdminCommandSecurity;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.api.admin.ServerEnvironment;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.config.support.TargetType;
/**
* Create Audit Module Command
*
* Usage: create-audit-module --classname classnme [--terse=false]
* [--echo=false] [--interactive=true] [--host localhost]
* [--port 4848|4849] [--secure | -s] [--user admin_user]
* [--passwordfile file_name] [--property (name=value)
* [:name=value]*] [--target target(Default server)] audit_module_name
*
* domain.xml element example
*
*
*
* @author Nandini Ektare
*/
@Service(name="create-audit-module")
@PerLookup
@I18n("create.audit.module")
@ExecuteOn({RuntimeType.DAS, RuntimeType.INSTANCE})
@TargetType({CommandTarget.DAS,CommandTarget.STANDALONE_INSTANCE,CommandTarget.CLUSTER,CommandTarget.CONFIG})
public class CreateAuditModule implements AdminCommand, AdminCommandSecurity.Preauthorization {
final private static LocalStringManagerImpl localStrings = new LocalStringManagerImpl(CreateAuditModule.class);
@Param(name="classname")
String className;
@Param(name="auditmodulename", primary=true)
String auditModuleName;
@Param(optional=true, name="property", separator=':')
java.util.Properties properties;
@Param(name = "target", optional = true, defaultValue =
SystemPropertyConstants.DEFAULT_SERVER_INSTANCE_NAME)
private String target;
@Inject @Named(ServerEnvironment.DEFAULT_INSTANCE_NAME)
private Config config;
@Inject
private Domain domain;
@Inject
SecurityConfigListener securityConfigListener;
@AccessRequired.NewChild(type=AuditModule.class)
private SecurityService securityService = null;
@Override
public boolean preAuthorization(AdminCommandContext context) {
securityService = chooseSecurityService(context.getActionReport());
return (securityService != null);
}
/**
* Executes the command with the command parameters passed as Properties
* where the keys are paramter names and the values the parameter values
*
* @param context information
*/
@Override
public void execute(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
// check if there exists an audit module by the specified name
// if so return failure.
List ams = securityService.getAuditModule();
for (AuditModule am : ams) {
if (am.getName().equals(auditModuleName)) {
report.setMessage(localStrings.getLocalString(
"create.audit.module.duplicatefound",
"AuditModule named {0} exists. " +
"Cannot add duplicate AuditModule.", auditModuleName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
}
// No duplicate audit modules found. So add one.
try {
ConfigSupport.apply(new SingleConfigCode() {
public Object run(SecurityService param)
throws PropertyVetoException, TransactionFailure {
AuditModule newAuditModule = param.createChild(AuditModule.class);
populateAuditModuleElement(newAuditModule);
param.getAuditModule().add(newAuditModule);
return newAuditModule;
}
}, securityService);
} catch(TransactionFailure e) {
report.setMessage(localStrings.getLocalString("create.audit.module.fail",
"Creation of AuditModule {0} failed", auditModuleName));
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(e);
return;
}
report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
//report.setMessage(localStrings.getLocalString("create.audit.module.success",
// "Creation of AuditModule {0} completed successfully", auditModuleName));
}
private SecurityService chooseSecurityService(final ActionReport report) {
config = CLIUtil.chooseConfig(domain, target, report);
if (config == null) {
return null;
}
return config.getSecurityService();
}
private void populateAuditModuleElement(AuditModule newAuditModule)
throws PropertyVetoException, TransactionFailure {
newAuditModule.setName(auditModuleName);
newAuditModule.setClassname(className);
if (properties != null) {
for (Object propname: properties.keySet()) {
Property newprop = newAuditModule.createChild(Property.class);
newprop.setName((String) propname);
newprop.setValue(properties.getProperty((String) propname));
newAuditModule.getProperty().add(newprop);
}
}
}
}