org.glassfish.connectors.admin.cli.CreateConnectorConnectionPool 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-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.
*/
package org.glassfish.connectors.admin.cli;
import com.sun.enterprise.config.serverbeans.Domain;
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.hk2.api.PerLookup;
import org.glassfish.resourcebase.resources.api.ResourceStatus;
import org.glassfish.resources.admin.cli.ResourceConstants;
import org.jvnet.hk2.annotations.Service;
import jakarta.inject.Inject;
import jakarta.inject.Provider;
import java.util.HashMap;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
import static org.glassfish.connectors.admin.cli.CLIConstants.CCP.*;
import static org.glassfish.connectors.admin.cli.CLIConstants.*;
/**
* Create Connector Connection Pool Command
*
*/
@ExecuteOn(RuntimeType.ALL)
@Service(name=CCP_CREATE_COMMAND_NAME)
@PerLookup
@I18n("create.connector.connection.pool")
public class CreateConnectorConnectionPool implements AdminCommand {
final private static LocalStringManagerImpl localStrings = new LocalStringManagerImpl(CreateConnectorConnectionPool.class);
@Param(name=CCP_RA_NAME, alias= "resourceAdapterName")
String raname;
@Param(name=CCP_CON_DEFN_NAME, alias="connectiondefinitionname")
String connectiondefinition;
@Param(name=CCP_STEADY_POOL_SIZE, alias="steadyPoolSize", optional=true, defaultValue="8")
String steadypoolsize = "8";
@Param(name=CCP_MAX_POOL_SIZE, alias="maxPoolSize", optional=true, defaultValue="32")
String maxpoolsize = "32";
@Param(name=CCP_MAX_WAIT_TIME, optional=true, alias="maxWaitTimeInMillis", defaultValue="60000")
String maxwait = "60000";
@Param(name=CCP_POOL_RESIZE_QTY, optional=true, alias="poolResizeQuantity", defaultValue="2")
String poolresize = "2";
@Param(name=CCP_IDLE_TIMEOUT, optional=true, alias="idleTimeoutInSeconds", defaultValue="300")
String idletimeout = "300";
@Param(name=CCP_IS_VALIDATION_REQUIRED, optional=true, defaultValue="false", alias="isConnectionValidationRequired")
Boolean isconnectvalidatereq;
@Param(name=CCP_FAIL_ALL_CONNS, optional=true, defaultValue="false", alias="failAllConnections")
Boolean failconnection;
@Param(name=CCP_LEAK_TIMEOUT, alias="connectionLeakTimeoutInSeconds", optional=true, defaultValue="0")
String leaktimeout = "0";
@Param(name=CCP_LEAK_RECLAIM, alias="connectionLeakReclaim", optional=true, defaultValue="false")
Boolean leakreclaim;
@Param(name=CCP_CON_CREATION_RETRY_ATTEMPTS, alias="connectionCreationRetryAttempts", optional=true, defaultValue="0")
String creationretryattempts = "0";
@Param(name=CCP_CON_CREATION_RETRY_INTERVAL, alias="connectionCreationRetryIntervalInSeconds", optional=true, defaultValue="10")
String creationretryinterval = "10";
@Param(name=CCP_LAZY_CON_ENLISTMENT, alias="lazyConnectionEnlistment", optional=true, defaultValue="false")
Boolean lazyconnectionenlistment;
@Param(name=CCP_LAZY_CON_ASSOC, alias="lazyConnectionAssociation", optional=true, defaultValue="false")
Boolean lazyconnectionassociation;
@Param(name=CCP_ASSOC_WITH_THREAD, alias="associateWithThread", optional=true, defaultValue="false")
Boolean associatewiththread;
@Param(name=CCP_MATCH_CONNECTIONS, alias="matchConnections", optional=true, defaultValue="true")
Boolean matchconnections;
@Param(name=CCP_MAX_CON_USAGE_COUNT, alias="maxConnectionUsageCount", optional=true, defaultValue="0")
String maxconnectionusagecount = "0";
@Param(name=CCP_PING, optional=true, defaultValue="false")
Boolean ping;
@Param(name=CCP_POOLING, optional=true, defaultValue="true")
Boolean pooling;
@Param(name=CCP_VALIDATE_ATMOST_PERIOD, alias="validateAtmostOncePeriodInSeconds", optional=true, defaultValue="0")
String validateatmostonceperiod;
@Param(name=CCP_TXN_SUPPORT, alias="transactionSupport", acceptableValues="XATransaction,LocalTransaction,NoTransaction", optional=true)
String transactionsupport;
@Param(name=DESCRIPTION, optional=true)
String description;
@Param(name= PROPERTY, optional=true, separator=':')
Properties properties;
@Param(name= TARGET, optional=true, obsolete = true)
String target = SystemPropertyConstants.DAS_SERVER_NAME;
@Param(name=CCP_POOL_NAME, primary=true)
String poolname;
@Inject
private Domain domain;
@Inject
private Provider connectorConnectionPoolManagerProvider;
@Inject
private CommandRunner commandRunner;
/**
* Executes the command with the command parameters passed as Properties
* where the keys are the paramter names and the values the parameter values
*
* @param context information
*/
public void execute(AdminCommandContext context) {
final ActionReport report = context.getActionReport();
HashMap attrList = new HashMap();
attrList.put(ResourceConstants.RES_ADAPTER_NAME, raname);
attrList.put(ResourceConstants.CONN_DEF_NAME, connectiondefinition);
attrList.put(ServerTags.DESCRIPTION, description);
attrList.put(ResourceConstants.STEADY_POOL_SIZE, steadypoolsize);
attrList.put(ResourceConstants.MAX_POOL_SIZE, maxpoolsize);
attrList.put(ResourceConstants.MAX_WAIT_TIME_IN_MILLIS, maxwait);
attrList.put(ResourceConstants.POOL_SIZE_QUANTITY, poolresize);
attrList.put(ResourceConstants.IDLE_TIME_OUT_IN_SECONDS, idletimeout);
attrList.put(ResourceConstants.IS_CONNECTION_VALIDATION_REQUIRED, isconnectvalidatereq.toString());
attrList.put(ResourceConstants.CONN_FAIL_ALL_CONNECTIONS, failconnection.toString());
attrList.put(ResourceConstants.VALIDATE_ATMOST_ONCE_PERIOD_IN_SECONDS, validateatmostonceperiod);
attrList.put(ResourceConstants.CONNECTION_LEAK_TIMEOUT_IN_SECONDS, leaktimeout);
attrList.put(ResourceConstants.CONNECTION_LEAK_RECLAIM, leakreclaim.toString());
attrList.put(ResourceConstants.CONNECTION_CREATION_RETRY_ATTEMPTS, creationretryattempts);
attrList.put(ResourceConstants.CONNECTION_CREATION_RETRY_INTERVAL_IN_SECONDS, creationretryinterval);
attrList.put(ResourceConstants.LAZY_CONNECTION_ASSOCIATION, lazyconnectionassociation.toString());
attrList.put(ResourceConstants.LAZY_CONNECTION_ENLISTMENT, lazyconnectionenlistment.toString());
attrList.put(ResourceConstants.ASSOCIATE_WITH_THREAD, associatewiththread.toString());
attrList.put(ResourceConstants.MATCH_CONNECTIONS, matchconnections.toString());
attrList.put(ResourceConstants.MAX_CONNECTION_USAGE_COUNT, maxconnectionusagecount);
attrList.put(ResourceConstants.CONNECTOR_CONNECTION_POOL_NAME, poolname);
attrList.put(ResourceConstants.CONN_TRANSACTION_SUPPORT, transactionsupport);
attrList.put(ResourceConstants.PING, ping.toString());
attrList.put(ResourceConstants.POOLING, pooling.toString());
ResourceStatus rs;
try {
ConnectorConnectionPoolManager connPoolMgr = connectorConnectionPoolManagerProvider.get();
rs = connPoolMgr.create(domain.getResources(), attrList, properties, target);
} catch(Exception e) {
Logger.getLogger(CreateConnectorConnectionPool.class.getName()).log(Level.SEVERE,
"Unable to create connector connection pool " + poolname, e);
String def = "Connector connection pool: {0} could not be created, reason: {1}";
report.setMessage(localStrings.getLocalString("create.connector.connection.pool.fail",
def, poolname) + " " + 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(rs.getMessage());
} else {
report.setMessage(localStrings.getLocalString("create.connector.connection.pool.fail",
"Connector connection pool {0} creation failed.", poolname));
}
if (rs.getException() != null)
report.setFailureCause(rs.getException());
} else {
//TODO only for DAS ?
if ("true".equalsIgnoreCase(ping.toString())) {
ActionReport subReport = report.addSubActionsReport();
ParameterMap parameters = new ParameterMap();
parameters.set("pool_name", poolname);
commandRunner.getCommandInvocation("ping-connection-pool", subReport, context.getSubject()).parameters(parameters).execute();
if (ActionReport.ExitCode.FAILURE.equals(subReport.getActionExitCode())) {
subReport.setMessage(localStrings.getLocalString("ping.create.connector.connection.pool.fail",
"\nAttempting to ping during Connector Connection " +
"Pool Creation : {0} - Failed.", poolname));
subReport.setActionExitCode(ActionReport.ExitCode.FAILURE);
} else {
subReport.setMessage(localStrings.getLocalString("ping.create.connector.connection.pool.success",
"\nAttempting to ping during Connector Connection " +
"Pool Creation : {0} - Succeeded.", poolname));
}
}
}
if (rs.getMessage() != null) {
report.setMessage(rs.getMessage());
}
report.setActionExitCode(ec);
}
}