com.sun.enterprise.config.serverbeans.Applications Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro 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.
*/
// Portions Copyright [2018-2021] Payara Foundation and/or affiliates
package com.sun.enterprise.config.serverbeans;
import org.glassfish.api.admin.RestRedirect;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.DuckTyped;
import org.jvnet.hk2.config.Element;
import java.util.*;
import org.glassfish.api.admin.config.ApplicationName;
@Configured
public interface Applications extends ConfigBeanProxy {
/**
* Gets the value of the MbeanorApplication property.
* Objects of the following type(s) are allowed in the list
* {@link Application }
* @return
*/
@Element("*")
@RestRedirect(opType= RestRedirect.OpType.PUT, commandName="deploy")
public List getModules();
/**
* Gets a subset of {@link #getModules()} that has the given type.
* @param
* @param type
* @return
*/
@DuckTyped
List getModules(Class type);
@DuckTyped
T getModule(Class type, String moduleID);
@DuckTyped
List getApplications();
/**
* Return the application with the given module ID (name), or null if
* no such application exists.
*
* @param moduleID the module ID of the application
* @return the Application object, or null if no such app
*/
@DuckTyped
Application getApplication(String moduleID);
@DuckTyped
List getApplicationsWithSnifferType(String snifferType);
@DuckTyped
List getApplicationsWithSnifferType(String snifferType, boolean onlyStandaloneModules);
public class Duck {
public static List getModules(Applications apps, Class type) {
List modules = new ArrayList();
for (Object module : apps.getModules()) {
if (type.isInstance(module)) {
modules.add(type.cast(module));
}
}
// you have to return an umodifiable list since this list
// is not the real list of elements as maintained by this config bean
return Collections.unmodifiableList(modules);
}
public static T getModule(Applications apps, Class type, String moduleID) {
if (moduleID == null) {
return null;
}
for (ApplicationName module : apps.getModules())
if (type.isInstance(module) && moduleID.equals(module.getName()))
return type.cast(module);
return null;
}
public static List getApplications(Applications apps) {
return getModules(apps, Application.class);
}
public static Application getApplication(Applications apps, String moduleID) {
if (moduleID == null) {
return null;
}
for (ApplicationName module : apps.getModules()) {
if (module instanceof Application && moduleID.equals(module.getName())) {
return (Application)module;
}
}
return null;
}
public static List getApplicationsWithSnifferType(
Applications apps, String snifferType) {
return getApplicationsWithSnifferType(apps, snifferType, false);
}
public static List getApplicationsWithSnifferType(
Applications apps, String snifferType,
boolean onlyStandaloneModules) {
List result = new ArrayList() {
};
List applications =
getModules(apps, Application.class);
for (Application app : applications) {
if (app.containsSnifferType(snifferType)) {
if (onlyStandaloneModules) {
if (app.isStandaloneModule()) {
result.add(app);
}
} else {
result.add(app);
}
}
}
return Collections.unmodifiableList(result);
}
}
}