org.glassfish.resources.javamail.admin.cli.CreateJavaMailResource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web 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 [2017-2021] Payara Foundation and/or its affiliates
*/
package org.glassfish.resources.javamail.admin.cli;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.config.serverbeans.Resources;
import com.sun.enterprise.config.serverbeans.ServerTags;
import com.sun.enterprise.util.LocalStringManagerImpl;
import com.sun.enterprise.util.SystemPropertyConstants;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.*;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.config.support.TargetType;
import org.glassfish.hk2.api.PerLookup;
import org.glassfish.resourcebase.resources.api.ResourceStatus;
import org.jvnet.hk2.annotations.Service;
import jakarta.inject.Inject;
import java.util.HashMap;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Create Java Mail Resource
*
*/
@TargetType(value={CommandTarget.DAS,CommandTarget.DOMAIN, CommandTarget.CLUSTER, CommandTarget.STANDALONE_INSTANCE,
CommandTarget.DEPLOYMENT_GROUP})
@RestEndpoints({
@RestEndpoint(configBean=Resources.class,
opType=RestEndpoint.OpType.POST,
path="create-javamail-resource",
description="create-javamail-resource")
})
@org.glassfish.api.admin.ExecuteOn(RuntimeType.ALL)
@Service(name="create-javamail-resource")
@PerLookup
@I18n("create.javamail.resource")
public class CreateJavaMailResource implements AdminCommand {
final private static LocalStringManagerImpl localStrings =
new LocalStringManagerImpl(CreateJavaMailResource.class);
@Param(name="mailhost", alias="host")
private String mailHost;
@Param(name="mailuser", alias="user")
private String mailUser;
@Param(name="password", optional=true)
private String mailPassword;
@Param(name="auth", optional=true, defaultValue="false")
private Boolean auth;
@Param(name="fromaddress",alias="from")
private String fromAddress;
@Param(name="jndi_name", primary=true)
private String jndiName;
@Param(name="storeprotocol", optional=true, defaultValue="imap", alias="storeProtocol")
private String storeProtocol;
@Param(name="storeprotocolclass", optional=true, defaultValue="com.sun.mail.imap.IMAPStore", alias="storeProtocolClass")
private String storeProtocolClass;
@Param(name="transprotocol", optional=true, defaultValue="smtp", alias="transportProtocol")
private String transportProtocol;
@Param(name="transprotocolclass", optional=true, defaultValue="com.sun.mail.smtp.SMTPTransport", alias="transportProtocolClass")
private String transportProtocolClass;
@Param(optional=true, defaultValue="true")
private Boolean enabled;
@Param(optional=true, defaultValue="false")
private Boolean debug;
@Param(name="property", optional=true, separator=':')
private Properties properties;
@Param(optional=true,
defaultValue = SystemPropertyConstants.DAS_SERVER_NAME)
private String target;
@Param(optional=true)
private String description;
@Inject
private Domain domain;
@Inject
private org.glassfish.resources.javamail.admin.cli.JavaMailResourceManager mailResMgr;
/**
* Executes the command with the command parameters passed as Properties
* where the keys are the parameter names and the values the parameter values
*
* @param context information
*/
public void execute(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
HashMap attributes = new HashMap();
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.JNDI_NAME, jndiName);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_HOST, mailHost);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_USER, mailUser);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_PASSWORD, mailPassword);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_AUTH, auth.toString());
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_FROM_ADDRESS, fromAddress);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_STORE_PROTO, storeProtocol);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_STORE_PROTO_CLASS, storeProtocolClass);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_TRANS_PROTO, transportProtocol);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_TRANS_PROTO_CLASS, transportProtocolClass);
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.MAIL_DEBUG, debug.toString());
attributes.put(org.glassfish.resources.admin.cli.ResourceConstants.ENABLED, enabled.toString());
attributes.put(ServerTags.DESCRIPTION, description);
ResourceStatus rs;
try {
rs = mailResMgr.create(domain.getResources(), attributes, properties, target);
} catch(Exception e) {
Logger.getLogger(CreateJavaMailResource.class.getName()).log(Level.SEVERE,
"Unable to create Mail Resource " + jndiName, e);
String def = "Mail resource: {0} could not be created";
report.setMessage(localStrings.getLocalString("create.mail.resource.fail",
def, jndiName) + " " + e.getLocalizedMessage());
report.setActionExitCode(ActionReport.ExitCode.FAILURE);
report.setFailureCause(e);
return;
}
ActionReport.ExitCode ec = ActionReport.ExitCode.SUCCESS;
if (rs.getStatus() == ResourceStatus.FAILURE) {
ec = ActionReport.ExitCode.FAILURE;
if (rs.getMessage() == null) {
report.setMessage(localStrings.getLocalString("create.mail.resource.fail",
"Unable to create Mail Resource {0}.", jndiName));
}
if (rs.getException() != null)
report.setFailureCause(rs.getException());
}
if(rs.getMessage() != null){
report.setMessage(rs.getMessage());
}
report.setActionExitCode(ec);
}
}