com.sun.enterprise.config.serverbeans.Domain 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 com.sun.enterprise.config.modularity.parser.ModuleConfigurationLoader;
import com.sun.enterprise.config.util.ConfigApiLoggerInfo;
import com.sun.enterprise.util.StringUtils;
import org.glassfish.api.admin.config.ApplicationName;
import org.glassfish.api.admin.config.PropertiesDesc;
import org.glassfish.api.admin.config.PropertyDesc;
import org.glassfish.api.admin.config.ReferenceContainer;
import org.glassfish.quality.ToDo;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.ConfigExtensionMethod;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.DuckTyped;
import org.jvnet.hk2.config.Element;
import org.jvnet.hk2.config.TransactionFailure;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import jakarta.validation.constraints.NotNull;
import java.beans.PropertyVetoException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
@Configured
/**
* Top level Domain Element that includes applications, resources, configs, servers, clusters and node-agents, load
* balancer configurations and load balancers. node-agents and load balancers are SE/EE related entities only.
*
*/
public interface Domain extends ConfigBeanProxy, PropertyBag, SystemPropertyBag, ConfigLoader {
public static final String DOMAIN_NAME_PROPERTY = "administrative.domain.name";
/**
* Gets the value of the applicationRoot property.
*
* For PE this defines the location where applications are deployed
*
* @return possible object is {@link String }
*/
@Attribute
String getApplicationRoot();
/**
* Sets the value of the applicationRoot property.
*
* @param value allowed object is {@link String }
*/
void setApplicationRoot(String value) throws PropertyVetoException;
/**
* Gets the value of the logRoot property.
*
* Specifies where the server instance's log files are kept, including HTTP access logs, server logs, and transaction
* logs. Default is $INSTANCE-ROOT/logs
*
* @return possible object is {@link String }
*/
@Attribute
String getLogRoot();
/**
* Sets the value of the logRoot property.
*
* @param value allowed object is {@link String }
*/
void setLogRoot(String value) throws PropertyVetoException;
/**
* Gets the value of the locale property.
*
* @return possible object is {@link String }
*/
@Attribute
String getLocale();
/**
* Sets the value of the locale property.
*
* @param value allowed object is {@link String }
*/
void setLocale(String value) throws PropertyVetoException;
/**
* Gets the value of the version property. It is read-only.
*
* Tools are not to depend on this property. It is only for reference.
*
* @return String representing version of the Domain.
*/
@Attribute
String getVersion();
/**
* Gets the SecureAdmin value defined in the domain.
*
* @return {@link SecureAdmin }
*/
@Element
SecureAdmin getSecureAdmin();
/**
* Sets the SecureAdmin value.
*
* @param secureAdmin
*/
void setSecureAdmin(SecureAdmin secureAdmin);
/**
* Gets the value of the applications property.
*
* @return possible object is {@link Applications }
*/
@Element
@NotNull
Applications getApplications();
/**
* Sets the value of the system-applications property.
*
* @param value allowed object is {@link Applications }
*/
void setApplications(Applications value) throws PropertyVetoException;
@Element
@NotNull
SystemApplications getSystemApplications();
/**
* Sets the value of the system-applications property.
*
* @param value allowed object is {@link Applications }
*/
void setSystemApplications(SystemApplications value) throws PropertyVetoException;
/**
* Gets the value of the resources property.
*
* @return possible object is {@link Resources }
*/
@Element
@NotNull
Resources getResources();
/**
* Sets the value of the resources property.
*
* @param value allowed object is {@link Resources }
*/
void setResources(Resources value) throws PropertyVetoException;
/**
* Gets the value of the configs property.
*
* @return possible object is {@link Configs }
*/
@Element(required = true)
@NotNull
Configs getConfigs();
/**
* Sets the value of the configs property.
*
* @param value allowed object is {@link Configs }
*/
void setConfigs(Configs value) throws PropertyVetoException;
/**
* Gets the value of the servers property.
*
* @return possible object is {@link Servers }
*/
@Element(required = true)
@NotNull
Servers getServers();
/**
* Sets the value of the servers property.
*
* @param value allowed object is {@link Servers }
*/
void setServers(Servers value) throws PropertyVetoException;
/**
* Gets the value of the clusters property.
*
* @return possible object is {@link Clusters }
*/
@Element
@NotNull
Clusters getClusters();
/**
* Sets the value of the clusters property.
*
* @param value allowed object is {@link Clusters }
*/
void setClusters(Clusters value) throws PropertyVetoException;
/**
* Gets the value of the nodes property.
*
* @return possible object is {@link Nodes }
*/
@Element
Nodes getNodes();
/**
* Sets the value of the nodes property.
*
* @param value allowed object is {@link Nodes }
*/
void setNodes(Nodes value) throws PropertyVetoException;
/**
* Gets the value of the nodeAgents property.
*
* @return possible object is {@link NodeAgents }
*/
@Element
NodeAgents getNodeAgents();
/**
* Sets the value of the nodeAgents property.
*
* @param value allowed object is {@link NodeAgents }
*/
void setNodeAgents(NodeAgents value) throws PropertyVetoException;
/**
* Gets the value of the systemProperty 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
* systemProperty property.
*
*
* For example, to add a new item, do as follows:
*
*
* getSystemProperty().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list {@link SystemProperty }
*/
@ToDo(priority = ToDo.Priority.IMPORTANT, details = "Any more legal system properties?")
@PropertiesDesc(systemProperties = true, props = {
@PropertyDesc(name = "com.sun.aas.installRoot", description = "Operating system dependent. Path to the directory where the server is installed"),
@PropertyDesc(name = "com.sun.aas.instanceRoot", description = "Operating system dependent. Path to the top level directory for a server instance"),
@PropertyDesc(name = "com.sun.aas.hostName", description = "Operating system dependent. Path to the name of the host (machine)"),
@PropertyDesc(name = "com.sun.aas.javaRoot", description = "Operating system dependent. Path to the library directory for the Sun GlassFish Message Queue software"),
@PropertyDesc(name = "com.sun.aas.imqLib", description = "Operating system dependent. Path to the installation directory for the Java runtime"),
@PropertyDesc(name = "com.sun.aas.imqLib", description = "Operating system dependent. Path to the installation directory for the Java runtime"),
@PropertyDesc(name = "com.sun.aas.configName", defaultValue = "server-config", description = "Name of the used by a server instance"),
@PropertyDesc(name = "com.sun.aas.instanceName", defaultValue = "server1", description = "Name of the server instance. Not used in the default configuration, but can be used to customize configuration"),
@PropertyDesc(name = "com.sun.aas.domainName", defaultValue = "domain1", description = "Name of the domain. Not used in the default configuration, but can be used to customize configuration") })
@Element
List getSystemProperty();
/**
* Properties as per {@link PropertyBag}
*/
@ToDo(priority = ToDo.Priority.IMPORTANT, details = "Provide PropertyDesc for legal props")
@PropertiesDesc(props = {})
@Element
List getProperty();
@Element("*")
List getExtensions();
@DuckTyped
String getName();
@DuckTyped
List getAllDefinedSystemApplications();
@DuckTyped
ApplicationRef getApplicationRefInServer(String sn, String name);
@DuckTyped
List getApplicationRefsInServer(String sn);
/**
* Returns the list of system-applications that are referenced from the given server. A server references an
* application, if the server has an element named <application-ref> in it that points to given application. The
* given server is a <server> element inside domain.
*
* @param sn the string denoting name of the server
* @return List of system-applications for that server, an empty list in case there is none
*/
@DuckTyped
List getSystemApplicationsReferencedFrom(String sn);
@DuckTyped
Application getSystemApplicationReferencedFrom(String sn, String appName);
@DuckTyped
boolean isNamedSystemApplicationReferencedFrom(String appName, String serverName);
@DuckTyped
Server getServerNamed(String name);
@DuckTyped
boolean isServer(String name);
@DuckTyped
Config getConfigNamed(String name);
@DuckTyped
Cluster getClusterNamed(String name);
@DuckTyped
Node getNodeNamed(String name);
@DuckTyped
boolean isCurrentInstanceMatchingTarget(String target, String appName, String currentInstance, List referencedTargets);
@DuckTyped
List getServersInTarget(String target);
@DuckTyped
List getApplicationRefsInTarget(String target);
@DuckTyped
ApplicationRef getApplicationRefInTarget(String appName, String target);
@DuckTyped
ApplicationRef getApplicationRefInTarget(String appName, String target, boolean includeInstances);
@DuckTyped
boolean isAppRefEnabledInTarget(String appName, String target);
@DuckTyped
boolean isAppEnabledInTarget(String appName, String target);
@DuckTyped
boolean isAppReferencedByPaaSTarget(String appName);
@DuckTyped
List getAllReferencedTargetsForApplication(String appName);
@DuckTyped
List getAllTargets();
@DuckTyped
public List getTargets(final String tgt);
@DuckTyped
List getApplicationsInTarget(String target);
@DuckTyped
String getVirtualServersForApplication(String target, String appName);
@DuckTyped
String getEnabledForApplication(String target, String appName);
@DuckTyped
ReferenceContainer getReferenceContainerNamed(String name);
@DuckTyped
Cluster getClusterForInstance(String instanceName);
@DuckTyped
List getAllReferenceContainers();
@DuckTyped
List getReferenceContainersOf(Config config);
@DuckTyped
List getInstancesOnNode(String nodeName);
@DuckTyped
List getClustersOnNode(String nodeName);
@ConfigExtensionMethod
T getExtensionByType(Class type);
/**
* @param configBeanType The config bean type we want to check whether the configuration exists for it or not.
* @param Type that extends the ConfigBeanProxy which is the type of class we accept as parameter
* @return true if configuration for the type exists in the target area of domain.xml and false if not.
*/
@DuckTyped
boolean checkIfExtensionExists(Class
configBeanType);
class Duck {
private final static Logger logger = ConfigApiLoggerInfo.getLogger();
public static String getName(Domain domain) {
return domain.getPropertyValue(DOMAIN_NAME_PROPERTY);
}
/* return an empty list if given garbage -- or errors are encountered
* or if no matches
*/
public static List getInstancesOnNode(Domain domain, String nodeName) {
List ret = new LinkedList();
try {
if (!StringUtils.ok(nodeName))
return ret;
List servers = domain.getServers().getServer();
for (Server server : servers) {
if (nodeName.equals(server.getNodeRef()))
ret.add(server);
}
} catch (Exception e) {
logger.log(Level.WARNING, ConfigApiLoggerInfo.errorGettingServers, e.getLocalizedMessage());
}
return ret;
}
/* return an empty list if given garbage -- or errors are encountered
* or if no matches
*/
public static List getClustersOnNode(Domain domain, String nodeName) {
HashMap clMap = new HashMap();
List serverList = getInstancesOnNode(domain, nodeName);
try {
for (Server server : serverList) {
Cluster mycl = server.getCluster();
if (nodeName.equals(server.getNodeRef())) {
clMap.put(mycl.getName(), mycl);
}
}
} catch (Exception e) {
logger.log(Level.WARNING, ConfigApiLoggerInfo.errorGettingCluster, e.getLocalizedMessage());
}
return new ArrayList(clMap.values());
}
public static List getAllDefinedSystemApplications(Domain me) {
List allSysApps = new ArrayList();
SystemApplications sa = me.getSystemApplications();
if (sa != null) {
for (ApplicationName m : sa.getModules()) {
if (m instanceof Application)
allSysApps.add((Application) m);
}
}
return Collections.unmodifiableList(allSysApps);
}
public static ApplicationRef getApplicationRefInServer(Domain me, String sn, String name) {
Servers ss = me.getServers();
List list = ss.getServer();
Server theServer = null;
for (Server s : list) {
if (s.getName().equals(sn)) {
theServer = s;
break;
}
}
ApplicationRef aref = null;
if (theServer != null) {
List arefs = theServer.getApplicationRef();
for (ApplicationRef ar : arefs) {
if (ar.getRef().equals(name)) {
aref = ar;
break;
}
}
}
return aref;
}
public static List getApplicationRefsInServer(Domain me, String sn) {
Server server = getServerNamed(me, sn);
if (server != null) {
return server.getApplicationRef();
} else {
return Collections.EMPTY_LIST;
}
}
public static List getSystemApplicationsReferencedFrom(Domain d, String sn) {
if (d == null || sn == null)
throw new IllegalArgumentException("Null argument");
List allApps = d.getAllDefinedSystemApplications();
if (allApps.isEmpty())
return allApps; //if there are no sys-apps, none can reference one :)
//allApps now contains ALL the system applications
Server s = getServerNamed(d, sn);
List referencedApps = new ArrayList();
List appsReferenced = s.getApplicationRef();
for (ApplicationRef ref : appsReferenced) {
for (Application app : allApps) {
if (ref.getRef().equals(app.getName())) {
referencedApps.add(app);
}
}
}
return Collections.unmodifiableList(referencedApps);
}
public static Application getSystemApplicationReferencedFrom(Domain d, String sn, String appName) {
//returns null in case there is none
List allApps = getSystemApplicationsReferencedFrom(d, sn);
for (Application app : allApps) {
if (app.getName().equals(appName)) {
return app;
}
}
return null;
}
public static boolean isNamedSystemApplicationReferencedFrom(Domain d, String appName, String serverName) {
List referencedApps = getSystemApplicationsReferencedFrom(d, serverName);
for (Application app : referencedApps) {
if (app.getName().equals(appName))
return true;
}
return false;
}
public static Server getServerNamed(Domain d, String name) {
if (d.getServers() == null || name == null)
throw new IllegalArgumentException("no element");
List servers = d.getServers().getServer();
for (Server s : servers) {
if (name.equals(s.getName().trim())) {
return s;
}
}
return null;
}
public static Config getConfigNamed(Domain d, String name) {
if (d.getConfigs() == null || name == null)
throw new IllegalArgumentException("no element");
List configs = d.getConfigs().getConfig();
for (Config c : configs) {
if (name.equals(c.getName().trim())) {
return c;
}
}
return null;
}
public static Cluster getClusterNamed(Domain d, String name) {
if (d.getClusters() == null || name == null) {
return null;
}
List clusters = d.getClusters().getCluster();
for (Cluster c : clusters) {
if (name.equals(c.getName().trim())) {
return c;
}
}
return null;
}
public static Node getNodeNamed(Domain d, String name) {
if (d.getNodes() == null || name == null) {
return null;
}
List nodes = d.getNodes().getNode();
for (Node n : nodes) {
if (name.equals(n.getName().trim())) {
return n;
}
}
return null;
}
public static boolean isCurrentInstanceMatchingTarget(Domain d, String target, String appName, String currentInstance,
List referencedTargets) {
if (target == null || currentInstance == null) {
return false;
}
List targets = new ArrayList();
if (!target.equals("domain")) {
targets.add(target);
} else {
if (referencedTargets == null) {
referencedTargets = d.getAllReferencedTargetsForApplication(appName);
}
targets = referencedTargets;
}
for (String target2 : targets) {
if (currentInstance.equals(target2)) {
// standalone instance case
return true;
}
Cluster cluster = getClusterNamed(d, target2);
if (cluster != null) {
for (Server svr : cluster.getInstances()) {
if (svr.getName().equals(currentInstance)) {
// cluster instance case
return true;
}
}
}
}
return false;
}
public static List getServersInTarget(Domain me, String target) {
List servers = new ArrayList();
Server server = me.getServerNamed(target);
if (server != null) {
servers.add(server);
} else {
Cluster cluster = getClusterNamed(me, target);
if (cluster != null) {
servers.addAll(cluster.getInstances());
}
}
return servers;
}
public static List getApplicationRefsInTarget(Domain me, String target) {
return getApplicationRefsInTarget(me, target, false);
}
public static List getTargets(final Domain me, final String tgt) {
List targets = new ArrayList();
if (!tgt.equals("domain")) {
targets.add(tgt);
} else {
targets = me.getAllTargets();
}
return targets;
}
public static List getApplicationRefsInTarget(Domain me, String tgt, boolean includeInstances) {
List targets = getTargets(me, tgt);
List allAppRefs = new ArrayList();
for (String target : targets) {
Server server = me.getServerNamed(target);
if (server != null) {
allAppRefs.addAll(server.getApplicationRef());
} else {
Cluster cluster = getClusterNamed(me, target);
if (cluster != null) {
allAppRefs.addAll(cluster.getApplicationRef());
if (includeInstances) {
for (Server svr : cluster.getInstances()) {
allAppRefs.addAll(svr.getApplicationRef());
}
}
}
}
}
return allAppRefs;
}
public static ApplicationRef getApplicationRefInTarget(Domain me, String appName, String target) {
for (ApplicationRef ref : getApplicationRefsInTarget(me, target)) {
if (ref.getRef().equals(appName)) {
return ref;
}
}
return null;
}
public static boolean isAppRefEnabledInTarget(Domain me, String appName, String target) {
boolean found = false;
Cluster containingCluster = getClusterForInstance(me, target);
if (containingCluster != null) {
// if this is a clustered instance, check the enable
// attribute of its enclosing cluster first
// and return false if the cluster level enable attribute
// is false
ApplicationRef clusterRef = getApplicationRefInTarget(me, appName, containingCluster.getName());
if (clusterRef == null || !Boolean.valueOf(clusterRef.getEnabled())) {
return false;
}
}
for (ApplicationRef ref : getApplicationRefsInTarget(me, target, true)) {
if (ref.getRef().equals(appName)) {
found = true;
if (!Boolean.valueOf(ref.getEnabled())) {
return false;
}
}
}
// if we found the ref(s) and the enable attribute(s) is/are true
if (found) {
return true;
}
return false;
}
public static boolean isAppEnabledInTarget(Domain me, String appName, String target) {
Application application = me.getApplications().getApplication(appName);
if (application != null && Boolean.valueOf(application.getEnabled())) {
List targets = new ArrayList();
if (!target.equals("domain")) {
targets.add(target);
} else {
targets = getAllReferencedTargetsForApplication(me, appName);
}
for (String tgt : targets) {
if (!isAppRefEnabledInTarget(me, appName, tgt)) {
return false;
}
}
return true;
}
return false;
}
public static List getAllTargets(Domain d) {
List targets = new ArrayList();
// only add non-clustered servers as the cluster
// targets will be separately added
for (Server server : d.getServers().getServer()) {
if (server.getCluster() == null) {
targets.add(server.getName());
}
}
if (d.getClusters() != null) {
for (Cluster cluster : d.getClusters().getCluster()) {
targets.add(cluster.getName());
}
}
return targets;
}
public static List getAllReferencedTargetsForApplication(Domain me, String appName) {
List referencedTargets = new ArrayList();
for (String target : me.getAllTargets()) {
if (me.getApplicationRefInTarget(appName, target) != null) {
referencedTargets.add(target);
}
}
return referencedTargets;
}
public static boolean isAppReferencedByPaaSTarget(Domain me, String appName) {
List referencedTargets = me.getAllReferencedTargetsForApplication(appName);
for (String target : referencedTargets) {
Cluster cluster = me.getClusterNamed(target);
if (cluster != null) {
if (cluster.isVirtual()) {
return true;
}
}
}
return false;
}
public static List getApplicationsInTarget(Domain me, String target) {
if (target.equals("domain")) {
// special target domain
return me.getApplications().getApplications();
}
List apps = new ArrayList();
List applicationRefs = me.getApplicationRefsInTarget(target);
for (ApplicationRef ref : applicationRefs) {
Application app = me.getApplications().getApplication(ref.getRef());
if (app != null) {
apps.add(app);
}
}
return apps;
}
public static String getVirtualServersForApplication(Domain d, String target, String appName) {
ApplicationRef appRef = d.getApplicationRefInTarget(appName, target);
if (appRef != null) {
return appRef.getVirtualServers();
} else {
return null;
}
}
public static String getEnabledForApplication(Domain d, String target, String appName) {
ApplicationRef appRef = d.getApplicationRefInTarget(appName, target);
if (appRef != null) {
return appRef.getEnabled();
} else {
return null;
}
}
public static ReferenceContainer getReferenceContainerNamed(Domain d, String name) {
// Clusters and Servers are ReferenceContainers
Cluster c = getClusterNamed(d, name);
if (c != null)
return c;
return getServerNamed(d, name);
}
public static List getReferenceContainersOf(Domain d, Config config) {
// Clusters and Servers are ReferenceContainers
List sub = new LinkedList();
// both the config and its name need to be sanity-checked
String name = null;
if (config != null)
name = config.getName();
if (!StringUtils.ok(name)) // we choose to make this not an error
return sub;
List all = getAllReferenceContainers(d);
for (ReferenceContainer rc : all) {
if (name.equals(rc.getReference()))
sub.add(rc);
}
return sub;
}
public static List getAllReferenceContainers(Domain d) {
List ReferenceContainers = new LinkedList();
ReferenceContainers.addAll(d.getServers().getServer());
if (d.getClusters() != null) {
ReferenceContainers.addAll(d.getClusters().getCluster());
}
return ReferenceContainers;
}
public static Cluster getClusterForInstance(Domain d, String instanceName) {
List clusterList = d.getClusters().getCluster();
for (Cluster cluster : clusterList) {
List serverRefs = cluster.getServerRef();
for (ServerRef serverRef : serverRefs) {
if (serverRef.getRef().equals(instanceName)) {
return cluster;
}
}
}
return null;
}
public static boolean isServer(Domain d, String name) {
final Server server = d.getServerNamed(name);
return (server != null ? true : false);
}
public static boolean checkIfExtensionExists(Domain d, Class
configBeanType) {
for (DomainExtension extension : d.getExtensions()) {
try {
configBeanType.cast(extension);
return true;
} catch (Exception e) {
// ignore, not the right type.
}
}
return false;
}
}
}