org.glassfish.virtualization.spi.TemplateInstance Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011 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 org.glassfish.virtualization.spi;
import org.glassfish.virtualization.config.Template;
import java.io.File;
import java.io.FileNotFoundException;
/**
* Represents a template instance that can be instantiated in a virtual machine
*
* @author Jerome Dochez
*/
public interface TemplateInstance {
/**
* Returns the static (persisted) information on the template.
*
* @return the template configuration.
*/
Template getConfig();
/**
* Returns true of the template satisfy a condition
*
* @param condition the index which can be a key value pair like a ServiceType:JavaEE or
* any implementation of the {@link TemplateCondition} interface
* @return true if the index is satisfied.
*/
boolean satisfies(TemplateCondition condition);
/**
* Returns the customizer for this template instance.
* The customizer is often looked up in the services registry using the
* {@link ServiceType} index value.
* @return the customizer instance.
*/
TemplateCustomizer getCustomizer();
/**
* Returns the template location where template files were stored.
*
* @return a local disk location
*/
File getLocation();
/**
* Returns the first file in this template location that has this extension.
*
* @param extension the requested file extension
* @return the file if found a matching one.
* @throws java.io.FileNotFoundException when no file with that extension is
* present in this template definition
*/
File getFileByExtension(String extension) throws FileNotFoundException;
}