com.google.appengine.tools.development.AbstractModule Maven / Gradle / Ivy
Go to download
SDK for dev_appserver (local development) with some of the dependencies shaded (repackaged)
/*
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.appengine.tools.development;
import com.google.appengine.tools.development.ApplicationConfigurationManager.ModuleConfigurationHandle;
import com.google.apphosting.api.ApiProxy;
import java.io.File;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.logging.Logger;
/**
* Abstract super class for {@link Module} implementations.
*
* @param An {@link InstanceHolder} type which is available to a Module implementation
* but not reflected in the {@link Module} interface.
*/
public abstract class AbstractModule implements Module {
// Should not be used until ContainerService.startup() is called.
// TODO: Verify above comment is no longer needed and hopefully remove it.
static final Logger LOGGER = Logger.getLogger(AbstractModule.class.getName());
//Set during construction
private final ModuleConfigurationHandle moduleConfigurationHandle;
private final String serverInfo;
private final File externalResourceDir;
private final String address;
private final DevAppServer devAppServer;
private final List instanceHolders;
private ApiProxy.Delegate apiProxyDelegate;
//Set by configure
private LocalServerEnvironment localServerEnvironment;
protected AbstractModule(ModuleConfigurationHandle moduleConfigurationHandle,
String serverInfo, File externalResourceDir, String address,
DevAppServer devAppServer, List instanceHolders) {
this.moduleConfigurationHandle = moduleConfigurationHandle;
this.serverInfo = serverInfo;
this.externalResourceDir = externalResourceDir;
this.address = address;
this.devAppServer = devAppServer;
this.instanceHolders = new CopyOnWriteArrayList(instanceHolders);
}
@Override
public String getModuleName() {
return moduleConfigurationHandle.getModule().getModuleName();
}
protected List getInstanceHolders() {
return instanceHolders;
}
@Override
public LocalServerEnvironment getLocalServerEnvironment() {
return localServerEnvironment;
}
@Override
public final void configure(Map containerConfigProperties) throws Exception {
// Only configure modules once.
// TODO: Investigate removing this multiple configuration protection.
if (localServerEnvironment == null) {
localServerEnvironment = doConfigure(moduleConfigurationHandle, serverInfo,
externalResourceDir, address, containerConfigProperties, devAppServer);
}
}
@Override
public void createConnection() throws Exception {
for (I instanceHolder : instanceHolders) {
instanceHolder.createConnection();
}
}
@Override
public void setApiProxyDelegate(ApiProxy.Delegate apiProxyDelegate) {
for (I instanceHolder : instanceHolders) {
instanceHolder.getContainerService().setApiProxyDelegate(apiProxyDelegate);
}
}
@Override
public void startup() throws Exception {
for (I instanceHolder : instanceHolders) {
instanceHolder.startUp();
String listeningHostAndPort = getHostAndPort(instanceHolder);
// WARNING: Current tests rely on this log message. If you change it, update
// PORT_PATTERN and PORT_MATCH_GROUP in
// j/c/g/corp/common/testing/appengine/DevAppServer.java (cl/48377962)
// and PORT_PATTERN in j/c/g/publicalerts/testing/integration/DevAppServer.java. (cl/49496967)
if (instanceHolder.isMainInstance()) {
LOGGER.info(String.format("Module instance %s is running at http://%s/", getModuleName(),
listeningHostAndPort));
} else {
LOGGER.info(String.format("Module instance %s instance %s is running at http://%s/",
getModuleName(), instanceHolder.getInstance(), listeningHostAndPort));
}
LOGGER.info("The admin console is running at http://" + listeningHostAndPort + "/_ah/admin");
}
}
@Override
public String getHostAndPort(int instance) {
I instanceHolder = getInstanceHolder(instance);
if (instanceHolder == null) {
return null;
} else {
return getHostAndPort(instanceHolder);
}
}
private String getHostAndPort(I instanceHolder) {
ContainerService containerService = instanceHolder.getContainerService();
String prettyAddress = containerService.getAddress();
if (prettyAddress.equals("0.0.0.0") || prettyAddress.equals("127.0.0.1")) {
prettyAddress = "localhost";
}
String listeningHostAndPort = prettyAddress + ":" + containerService.getPort();
return listeningHostAndPort;
}
@Override
public I getInstanceHolder(int instance) {
if (instance < LocalEnvironment.MAIN_INSTANCE || instance + 1 > instanceHolders.size()) {
return null;
} else {
return instanceHolders.get(instance + 1);
}
}
@Override
public void shutdown() throws Exception {
for (I instanceHolder : instanceHolders) {
instanceHolder.getContainerService().shutdown();
if (instanceHolder.isMainInstance()) {
LOGGER.info("Shutting down module instance " + getModuleName());
} else {
LOGGER.info("Shutting down module instance " + getModuleName() + " instance "
+ instanceHolder.getInstance());
}
}
}
@Override
public ContainerService getMainContainer() {
return instanceHolders.get(0).getContainerService();
}
@Override
public I getAndReserveAvailableInstanceHolder() {
throw new UnsupportedOperationException();
}
@Override
public void startServing() throws Exception {
throw new UnsupportedOperationException();
}
@Override
public void stopServing() throws Exception {
throw new UnsupportedOperationException();
}
/**
* Configures the containers for a {@link Module} and returns the
* {@link LocalServerEnvironment} for the main container.
*/
protected abstract LocalServerEnvironment doConfigure(
ModuleConfigurationHandle moduleConfigurationHandle, String serverInfo,
File externalResourceDir, String address, Map containerConfigProperties,
DevAppServer devAppServer) throws Exception;
}