com.sun.enterprise.config.serverbeans.LifecycleModule Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 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.Attribute;
import org.jvnet.hk2.config.Element;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.component.Injectable;
import java.beans.PropertyVetoException;
import java.util.List;
import org.glassfish.api.admin.config.*;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import org.glassfish.quality.ToDo;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Min;
/**
*
*/
/* @XmlType(name = "", propOrder = {
"description",
"property"
}) */
@Configured
@Deprecated
public interface LifecycleModule extends Injectable, ApplicationName, PropertyBag {
/**
* Gets the value of the className property.
*
* Fully qualified name of the startup class
*
* @return possible object is
* {@link String }
*/
@Attribute
@NotNull
String getClassName();
/**
* Sets the value of the className property.
*
* @param value allowed object is
* {@link String }
*/
void setClassName(String value) throws PropertyVetoException;
/**
* Gets the value of the classpath property.
*
* Where this module is actually located, if it is not
* under applications-root
*
* @return possible object is
* {@link String }
*/
@Attribute
String getClasspath();
/**
* Sets the value of the classpath property.
*
* @param value allowed object is
* {@link String }
*/
void setClasspath(String value) throws PropertyVetoException;
/**
* Gets the value of the loadOrder property.
*
* integer value that can be used to force the order in which deployed
* lifecycle modules are loaded at server start up. Smaller numbered modules
* get loaded sooner. Order is unspecified if two or more lifecycle modules
* have the same load-order value.
*
* @return possible object is
* {@link String }
*/
@Attribute
@Min(value=1)
String getLoadOrder();
/**
* Sets the value of the loadOrder property.
*
* @param value allowed object is
* {@link String }
*/
void setLoadOrder(String value) throws PropertyVetoException;
/**
* Gets the value of the isFailureFatal property.
*
* If true, aborts server start up if this module does not load properly
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="false",dataType=Boolean.class)
String getIsFailureFatal();
/**
* Sets the value of the isFailureFatal property.
*
* @param value allowed object is
* {@link String }
*/
void setIsFailureFatal(String value) throws PropertyVetoException;
/**
* Gets the value of the objectType property.
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="user")
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.
*
* boolean attribute. If set to "false" this module will not be loaded at
* server start up.
*
* @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 description property.
*
* @return possible object is
* {@link String }
*/
@Element
String getDescription();
/**
* Sets the value of the description property.
*
* @param value allowed object is
* {@link String }
*/
void setDescription(String value) throws PropertyVetoException;
/**
Properties as per {@link org.jvnet.hk2.config.types.PropertyBag}
*/
@ToDo(priority=ToDo.Priority.IMPORTANT, details="Provide PropertyDesc for legal props" )
@PropertiesDesc(props={})
@Element
List getProperty();
}