com.sun.enterprise.config.serverbeans.WebModule 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.Configured;
import org.jvnet.hk2.config.Element;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import org.jvnet.hk2.component.Injectable;
import java.beans.PropertyVetoException;
import java.util.List;
import org.glassfish.api.admin.config.*;
import org.glassfish.quality.ToDo;
@Configured
@Deprecated
public interface WebModule extends Injectable, ApplicationName, PropertyBag {
/**
* Gets the value of the contextRoot property.
*
* context-root must match the pattern for the hpath production in RFC 1738
* which can be found at: ttp://www.w3.org/Addressing/rfc1738.txt.
* This is flattened to the following regular expression in XML Schema's
* pattern language: The validation process however, does not impose any
* restrictions on the choice of context-root.
*
* @return possible object is
* {@link String }
*/
@Attribute
public String getContextRoot();
/**
* Sets the value of the contextRoot property.
*
* @param value allowed object is
* {@link String }
*/
public void setContextRoot(String value) throws PropertyVetoException;
/**
* Gets the value of the location property.
*
* @return possible object is
* {@link String }
*/
@Attribute
public String getLocation();
/**
* Sets the value of the location property.
*
* @param value allowed object is
* {@link String }
*/
public void setLocation(String value) throws PropertyVetoException;
/**
* Gets the value of the objectType property.
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="user")
public String getObjectType();
/**
* Sets the value of the objectType property.
*
* @param value allowed object is
* {@link String }
*/
public void setObjectType(String value) throws PropertyVetoException;
/**
* Gets the value of the enabled property.
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="true",dataType=Boolean.class)
public String getEnabled();
/**
* Sets the value of the enabled property.
*
* @param value allowed object is
* {@link String }
*/
public void setEnabled(String value) throws PropertyVetoException;
/**
* Gets the value of the libraries property.
*
* System dependent path separator[: for Unix/Solaris/Linux & ; for Windows]
* separated list of jar paths. These paths could be either relative
* [relative to {com.sun.aas.instanceRoot}/lib/applibs] or absolute paths.
* These dependencies appears *after* the libraries defined in
* classpath-prefix in the java-config and *before* the application server
* provided over-rideable jar set. The libraries would be made available to
* the application in the order in which they were specified
*
* @return possible object is
* {@link String }
*/
@Attribute
public String getLibraries();
/**
* Sets the value of the libraries property.
*
* @param value allowed object is
* {@link String }
*/
public void setLibraries(String value) throws PropertyVetoException;
/**
* Gets the value of the availabilityEnabled property.
*
* Controls whether availability is enabled for HTTP Session Persistence.
* If this is "false", then all session persistence is disabled for the
* given web module. If it is "true" (and providing that all the
* availability-enabled attributes above in precedence are also "true", then
* the web module may be ha enabled. Finer-grained control exists at lower
* level (see sun-web.xml).
*
* If this attribute is missing, it defaults to "false"
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="false",dataType=Boolean.class)
public String getAvailabilityEnabled();
/**
* Sets the value of the availabilityEnabled property.
*
* @param value allowed object is
* {@link String }
*/
public void setAvailabilityEnabled(String value) throws PropertyVetoException;
/**
* Gets the value of the directoryDeployed property.
*
* Indicates whether the application has been deployed to a directory or not
*
* @return possible object is
* {@link String }
*/
@Attribute (defaultValue="false",dataType=Boolean.class)
public String getDirectoryDeployed();
/**
* Sets the value of the directoryDeployed property.
*
* @param value allowed object is
* {@link String }
*/
public void setDirectoryDeployed(String value) throws PropertyVetoException;
/**
* Gets the value of the description property.
*
* @return possible object is
* {@link String }
*/
@Attribute
public String getDescription();
/**
* Sets the value of the description property.
*
* @param value allowed object is
* {@link String }
*/
public void setDescription(String value) throws PropertyVetoException;
/**
* Gets the value of the webServiceEndpoint 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 webServiceEndpoint property.
*
*
* For example, to add a new item, do as follows:
*
* getWebServiceEndpoint().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link WebServiceEndpoint }
*/
@Element
public List getWebServiceEndpoint();
/**
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();
}