com.sun.enterprise.config.serverbeans.Resources Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-all Show documentation
Show all versions of payara-embedded-all Show documentation
Payara-Embedded-All Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 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 com.sun.enterprise.config.serverbeans;
import org.jvnet.hk2.config.*;
import java.util.*;
/**
* Applications can lookup resources registered in the server. These can be through portable JNDI names
* (eg: resource-ref in standard deployment descriptors like ejb-jar.xml, web.xml etc.,) or by doing direct lookup.
*
* Each of the resource has valid target for defining the resource-ref. (eg: JdbcResource can be referred from Server,
* Cluster, Stand Alone Instance, ServerResource can be referred from Server, Cluster, Stand Alone Instance, Config)
*/
/*
Some of the resource types (sub types of "Resource" config bean) are :
@XmlType(name = "", propOrder = {
"CustomResource Or
ExternalJndiResource Or
JdbcResourceOrMailResource Or
AdminObjectResource Or
ConnectorResource Or
ResourceAdapterConfig Or
JdbcConnectionPool Or
ConnectorConnectionPool Or
ServerResource"
}) */
@Configured
public interface Resources extends ConfigBeanProxy {
/**
* Returns a list of Resources like Custom Resource Or External Jndi Resource Or Jdbc Resource Or Mail Resource Or
* Admin Object Resource Or Connector Resource Or Resource Adapter Config Or Jdbc Connection Pool
* Or Connector Connection Pool.
*
*
* 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 customResource Or
* ExternalJndiResource Or JdbcResource Or MailResource Or AdminObjectResource Or ConnectorResource
* Or ResourceAdapterConfig Or JdbcConnectionPool Or ConnectorConnectionPool.
*
*
* For example, to add a new item, do as follows:
*
* get(CustomResource Or ExternalJndiResource Or JdbcResource Or MailResource Or AdminObjectResource Or
* ConnectorResource Or ResourceAdapterConfig Or JdbcConnectionPool Or ConnectorConnectionPool).add(newItem);
*
*
*
*
* Any sub type(s) of resource is allowed.
*/
@Element("*")
public List getResources();
@DuckTyped
public Collection getResources(Class type);
@DuckTyped
public Resource getResourceByName(Class type, String name);
/*
@DuckTyped
public Collection getResourcesOfPool(String connectionPoolName);
*/
public class Duck {
public static Collection getResources(Resources resources, Class type){
Collection filteredResources = new ArrayList();
for(Resource resource : resources.getResources()){
if (type.isInstance(resource)) {
filteredResources.add(type.cast(resource));
}
}
return filteredResources;
}
public static Resource getResourceByName(Resources resources, Class type, String name) {
Resource foundRes = null;
Iterator itr = resources.getResources(type).iterator();
while (itr.hasNext()) {
Resource res = (Resource)(itr.next());
String resourceName = res.getIdentity();
if (name.equals(resourceName)) {
foundRes = res;
break;
}
}
// make sure that the "type" provided and the matched resource are compatible.
// eg: its possible that the requested resource is "ConnectorResource",
// and matching resource is "JdbcResource" as we filter based on
// the generic type (in this case BindableResource) and not on exact type.
if (type != null && foundRes != null && type.isAssignableFrom(foundRes.getClass())) {
return foundRes;
} else {
return null;
}
}
}
}