com.sun.enterprise.config.serverbeans.Application Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.enterprise.config.serverbeans;
import java.beans.PropertyVetoException;
import java.io.File;
import java.util.*;
import java.util.logging.Logger;
import java.util.logging.Level;
import java.net.URISyntaxException;
import java.net.URI;
import jakarta.validation.constraints.NotNull;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import org.glassfish.api.admin.config.ApplicationName;
import org.glassfish.api.admin.config.PropertiesDesc;
import org.glassfish.api.admin.RestRedirects;
import org.glassfish.api.admin.RestRedirect;
import org.glassfish.api.deployment.DeployCommandParameters;
import org.glassfish.quality.ToDo;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.DuckTyped;
import org.jvnet.hk2.config.Element;
import com.sun.enterprise.config.serverbeans.customvalidators.ContextRootCheck;
@Configured
@RestRedirects({ @RestRedirect(opType = RestRedirect.OpType.DELETE, commandName = "undeploy"),
@RestRedirect(opType = RestRedirect.OpType.POST, commandName = "redeploy") })
@ContextRootCheck(message = "{contextroot.duplicate}", payload = Application.class)
public interface Application extends ApplicationName, PropertyBag {
public static final String APP_LOCATION_PROP_NAME = "appLocation";
public static final String DEPLOYMENT_PLAN_LOCATION_PROP_NAME = "deploymentPlanLocation";
public static final String ARCHIVE_TYPE_PROP_NAME = "archiveType";
public static final String ALT_DD_LOCATION_PROP_NAME = "altDDLocation";
public static final String RUNTIME_ALT_DD_LOCATION_PROP_NAME = "runtimeAltDDLocation";
/**
* Gets the value of the contextRoot property.
*
* @return possible object is {@link String }
*/
@Attribute
String getContextRoot();
/**
* Sets the value of the contextRoot property.
*
* @param value allowed object is {@link String }
*/
void setContextRoot(String value) throws PropertyVetoException;
/**
* Gets the value of the location property.
*
* @return possible object is {@link String }
*/
@Attribute
String getLocation();
/**
* Sets the value of the location property.
*
* @param value allowed object is {@link String }
*/
void setLocation(String value) throws PropertyVetoException;
/**
* Gets the value of the objectType property.
*
* @return possible object is {@link String }
*/
@Attribute(required = true)
@NotNull
String getObjectType();
/**
* Sets the value of the objectType property.
*
* @param value allowed object is {@link String }
*/
void setObjectType(String value) throws PropertyVetoException;
/**
* Gets the value of the enabled property.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "true", dataType = Boolean.class)
String getEnabled();
/**
* Sets the value of the enabled property.
*
* @param value allowed object is {@link String }
*/
void setEnabled(String value) throws PropertyVetoException;
/**
* Gets the value of the libraries property.
*
* @return possible object is {@link String }
*/
@Attribute
String getLibraries();
/**
* Sets the value of the libraries property.
*
* @param value allowed object is {@link String }
*/
void setLibraries(String value) throws PropertyVetoException;
/**
* Gets the value of the availabilityEnabled property.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "false", dataType = Boolean.class)
String getAvailabilityEnabled();
/**
* Sets the value of the availabilityEnabled property.
*
* @param value allowed object is {@link String }
*/
void setAvailabilityEnabled(String value) throws PropertyVetoException;
/**
* Gets the value of the asyncReplication property.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "true", dataType = Boolean.class)
String getAsyncReplication();
/**
* Sets the value of the asyncReplication property.
*
* @param value allowed object is {@link String }
*/
void setAsyncReplication(String value) throws PropertyVetoException;
/**
* Gets the value of the directoryDeployed property.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "false", dataType = Boolean.class)
String getDirectoryDeployed();
/**
* Sets the value of the directoryDeployed property.
*
* @param value allowed object is {@link String }
*/
void setDirectoryDeployed(String value) throws PropertyVetoException;
/**
* Gets the value of the description property.
*
* @return possible object is {@link String }
*/
@Attribute
String getDescription();
/**
* Sets the value of the description property.
*
* @param value allowed object is {@link String }
*/
void setDescription(String value) throws PropertyVetoException;
/**
* Gets the value of the deploymentOrder property.
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "100", dataType = Integer.class)
String getDeploymentOrder();
/**
* Sets the value of the deploymentOrder property.
*
* @param value allowed object is {@link String }
*/
void setDeploymentOrder(String value) throws PropertyVetoException;
@Element
List getModule();
/**
* Gets the value of the engine property.
*
*
* This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object. This is why there is not a set method for the
* engine property.
*
*
* For example, to add a new item, do as follows:
*
*
* getEngine().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list {@link Engine }
*/
@Element
List getEngine();
@Element
Resources getResources();
void setResources(Resources resources) throws PropertyVetoException;
@Element
AppTenants getAppTenants();
void setAppTenants(AppTenants appTenants);
@Element("*")
List getExtensions();
/*
* Get an extension of the specified type. If there is more than one, it is
* undefined as to which one is returned.
*/
@DuckTyped
T getExtensionByType(Class type);
/*
* Get all extensions of the specified type. If there are none, and empty
* list is returned.
*/
@DuckTyped
List getExtensionsByType(Class type);
@DuckTyped
Module getModule(String moduleName);
@DuckTyped
Properties getDeployProperties();
@DuckTyped
DeployCommandParameters getDeployParameters(ApplicationRef appRef);
@DuckTyped
Map getModulePropertiesMap();
@DuckTyped
boolean isStandaloneModule();
@DuckTyped
boolean containsSnifferType(String snifferType);
@DuckTyped
boolean isLifecycleModule();
@DuckTyped
void recordFileLocations(File app, File plan);
@DuckTyped
File application();
@DuckTyped
File deploymentPlan();
@DuckTyped
String archiveType();
class Duck {
public static Module getModule(Application instance, String name) {
for (Module module : instance.getModule()) {
if (module.getName().equals(name)) {
return module;
}
}
return null;
}
public static Properties getDeployProperties(Application instance) {
Properties deploymentProps = new Properties();
for (Property prop : instance.getProperty()) {
if (prop.getValue() != null) {
deploymentProps.put(prop.getName(), prop.getValue());
}
}
if (instance.getObjectType() != null) {
deploymentProps.setProperty(ServerTags.OBJECT_TYPE, instance.getObjectType());
}
if (instance.getContextRoot() != null) {
deploymentProps.setProperty(ServerTags.CONTEXT_ROOT, instance.getContextRoot());
}
if (instance.getDirectoryDeployed() != null) {
deploymentProps.setProperty(ServerTags.DIRECTORY_DEPLOYED, instance.getDirectoryDeployed());
}
return deploymentProps;
}
public static DeployCommandParameters getDeployParameters(Application app, ApplicationRef appRef) {
URI uri = null;
try {
uri = new URI(app.getLocation());
} catch (URISyntaxException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, e.getMessage(), e);
}
if (uri == null) {
return null;
}
DeployCommandParameters deploymentParams = new DeployCommandParameters(new File(uri));
deploymentParams.name = app.getName();
deploymentParams.description = app.getDescription();
if (Boolean.valueOf(app.getEnabled()) && appRef != null && Boolean.valueOf(appRef.getEnabled())) {
deploymentParams.enabled = Boolean.TRUE;
} else {
deploymentParams.enabled = Boolean.FALSE;
}
deploymentParams.contextroot = app.getContextRoot();
deploymentParams.libraries = app.getLibraries();
deploymentParams.availabilityenabled = Boolean.parseBoolean(app.getAvailabilityEnabled());
deploymentParams.asyncreplication = Boolean.parseBoolean(app.getAsyncReplication());
if (appRef != null) {
deploymentParams.lbenabled = appRef.getLbEnabled();
}
if (appRef != null) {
deploymentParams.virtualservers = appRef.getVirtualServers();
}
deploymentParams.deploymentorder = Integer.valueOf(app.getDeploymentOrder());
for (Property prop : app.getProperty()) {
if (prop.getName().equals(ARCHIVE_TYPE_PROP_NAME)) {
deploymentParams.type = prop.getValue();
} else if (prop.getName().equals(ALT_DD_LOCATION_PROP_NAME)) {
URI altDDUri = null;
try {
altDDUri = new URI(prop.getValue());
} catch (URISyntaxException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, e.getMessage(), e);
}
if (altDDUri != null) {
deploymentParams.altdd = new File(altDDUri);
}
} else if (prop.getName().equals(RUNTIME_ALT_DD_LOCATION_PROP_NAME)) {
URI runtimeAltDDUri = null;
try {
runtimeAltDDUri = new URI(prop.getValue());
} catch (URISyntaxException e) {
Logger.getAnonymousLogger().log(Level.SEVERE, e.getMessage(), e);
}
if (runtimeAltDDUri != null) {
deploymentParams.runtimealtdd = new File(runtimeAltDDUri);
}
}
}
return deploymentParams;
}
public static Map getModulePropertiesMap(Application me) {
Map modulePropertiesMap = new HashMap();
for (Module module : me.getModule()) {
if (module.getProperty() != null) {
Properties moduleProps = new Properties();
for (Property property : module.getProperty()) {
if (property.getValue() != null) {
moduleProps.put(property.getName(), property.getValue());
}
}
modulePropertiesMap.put(module.getName(), moduleProps);
}
}
return modulePropertiesMap;
}
public static boolean isStandaloneModule(Application me) {
return !(Boolean.valueOf(me.getDeployProperties().getProperty(ServerTags.IS_COMPOSITE)));
}
public static boolean isLifecycleModule(Application me) {
return Boolean.valueOf(me.getDeployProperties().getProperty(ServerTags.IS_LIFECYCLE));
}
public static boolean containsSnifferType(Application app, String snifferType) {
List engineList = new ArrayList();
// first add application level engines
engineList.addAll(app.getEngine());
// now add module level engines
for (Module module : app.getModule()) {
engineList.addAll(module.getEngines());
}
for (Engine engine : engineList) {
if (engine.getSniffer().equals(snifferType)) {
return true;
}
}
return false;
}
public static File application(final Application instance) {
return fileForProp(instance, APP_LOCATION_PROP_NAME);
}
public static File deploymentPlan(final Application instance) {
return fileForProp(instance, DEPLOYMENT_PLAN_LOCATION_PROP_NAME);
}
public static File altDD(final Application instance) {
return fileForProp(instance, ALT_DD_LOCATION_PROP_NAME);
}
public static File runtimeAltDD(final Application instance) {
return fileForProp(instance, RUNTIME_ALT_DD_LOCATION_PROP_NAME);
}
public static String archiveType(final Application instance) {
for (Property p : instance.getProperty()) {
if (p.getName().equals(ARCHIVE_TYPE_PROP_NAME)) {
return p.getValue();
}
}
return null;
}
private static File fileForProp(final Application instance, final String propName) {
for (Property p : instance.getProperty()) {
if (p.getName().equals(propName)) {
return new File(URI.create(p.getValue()));
}
}
return null;
}
public static T getExtensionByType(Application a, Class type) {
for (ApplicationExtension extension : a.getExtensions()) {
try {
return type.cast(extension);
} catch (Exception e) {
// ignore, not the right type.
}
}
return null;
}
public static List getExtensionsByType(Application a, Class type) {
ArrayList exts = new ArrayList();
for (ApplicationExtension extension : a.getExtensions()) {
try {
exts.add(type.cast(extension));
} catch (Exception e) {
// ignore, not the right type.
}
}
return exts;
}
}
/**
* Properties as per {@link PropertyBag}
*/
@ToDo(priority = ToDo.Priority.IMPORTANT, details = "Provide PropertyDesc for legal props")
@PropertiesDesc(props = {})
@Element
@Override
List getProperty();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy