org.jboss.shrinkwrap.descriptor.api.webapp25.WebAppDescriptor Maven / Gradle / Ivy
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
package org.jboss.shrinkwrap.descriptor.api.webapp25;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.javaee5.ParamValueType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.FilterType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.FilterMappingType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.ListenerType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.ServletType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.ServletMappingType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.SessionConfigType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.MimeMappingType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.WelcomeFileListType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.ErrorPageType;
import org.jboss.shrinkwrap.descriptor.api.jsp21.JspConfigType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.SecurityConstraintType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.LoginConfigType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.SecurityRoleType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.MessageDestinationType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.LocaleEncodingMappingListType;
import org.jboss.shrinkwrap.descriptor.api.webapp25.WebAppVersionType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.IconType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.EnvEntryType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.EjbRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.EjbLocalRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.ResourceRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.ResourceEnvRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.MessageDestinationRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.PersistenceContextRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.PersistenceUnitRefType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.LifecycleCallbackType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.LifecycleCallbackType;
import org.jboss.shrinkwrap.descriptor.api.javaeewebservicesclient12.ServiceRefType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;
import org.jboss.shrinkwrap.descriptor.api.webapp.*;
/**
*
* This deployment descriptor provides the functionalities as described in the specification
*
* Example:
*
*
* WebAppDescriptor descriptor = Descriptors.create(WebAppDescriptor.class);
*
*
*
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface WebAppDescriptor extends Descriptor, DescriptorNamespace,
WebAppCommonDescriptor,
ErrorPageType,
ServletType,
ServletMappingType,
FilterType,
FilterMappingType,
ListenerType,
SessionConfigType,
MimeMappingType,
WelcomeFileListType,
JspConfigType,
SecurityConstraintType,
LoginConfigType,
SecurityRoleType,
MessageDestinationType,
LocaleEncodingMappingListType> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing description elements,
* a new description element
* @param values list of description objects
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing display-name elements,
* a new display-name element
* @param values list of display-name objects
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor displayName(String ... values);
/**
* Returns all display-name elements
* @return list of display-name
*/
public List getAllDisplayName();
/**
* Removes the display-name element
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element will be created and returned.
* Otherwise, the first existing icon element will be returned.
* @return the instance defined for the element icon
*/
public IconType getOrCreateIcon();
/**
* Creates a new icon element
* @return the new created instance of IconType
*/
public IconType createIcon();
/**
* Returns all icon elements
* @return list of icon
*/
public List> getAllIcon();
/**
* Removes all icon elements
* @return the current instance of IconType
*/
public WebAppDescriptor removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:env-entryType ElementType : env-entry
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new env-entry element will be created and returned.
* Otherwise, the first existing env-entry element will be returned.
* @return the instance defined for the element env-entry
*/
public EnvEntryType getOrCreateEnvEntry();
/**
* Creates a new env-entry element
* @return the new created instance of EnvEntryType
*/
public EnvEntryType createEnvEntry();
/**
* Returns all env-entry elements
* @return list of env-entry
*/
public List> getAllEnvEntry();
/**
* Removes all env-entry elements
* @return the current instance of EnvEntryType
*/
public WebAppDescriptor removeAllEnvEntry();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:ejb-refType ElementType : ejb-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new ejb-ref element will be created and returned.
* Otherwise, the first existing ejb-ref element will be returned.
* @return the instance defined for the element ejb-ref
*/
public EjbRefType getOrCreateEjbRef();
/**
* Creates a new ejb-ref element
* @return the new created instance of EjbRefType
*/
public EjbRefType createEjbRef();
/**
* Returns all ejb-ref elements
* @return list of ejb-ref
*/
public List> getAllEjbRef();
/**
* Removes all ejb-ref elements
* @return the current instance of EjbRefType
*/
public WebAppDescriptor removeAllEjbRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:ejb-local-refType ElementType : ejb-local-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new ejb-local-ref element will be created and returned.
* Otherwise, the first existing ejb-local-ref element will be returned.
* @return the instance defined for the element ejb-local-ref
*/
public EjbLocalRefType getOrCreateEjbLocalRef();
/**
* Creates a new ejb-local-ref element
* @return the new created instance of EjbLocalRefType
*/
public EjbLocalRefType createEjbLocalRef();
/**
* Returns all ejb-local-ref elements
* @return list of ejb-local-ref
*/
public List> getAllEjbLocalRef();
/**
* Removes all ejb-local-ref elements
* @return the current instance of EjbLocalRefType
*/
public WebAppDescriptor removeAllEjbLocalRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:resource-refType ElementType : resource-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new resource-ref element will be created and returned.
* Otherwise, the first existing resource-ref element will be returned.
* @return the instance defined for the element resource-ref
*/
public ResourceRefType getOrCreateResourceRef();
/**
* Creates a new resource-ref element
* @return the new created instance of ResourceRefType
*/
public ResourceRefType createResourceRef();
/**
* Returns all resource-ref elements
* @return list of resource-ref
*/
public List> getAllResourceRef();
/**
* Removes all resource-ref elements
* @return the current instance of ResourceRefType
*/
public WebAppDescriptor removeAllResourceRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:resource-env-refType ElementType : resource-env-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new resource-env-ref element will be created and returned.
* Otherwise, the first existing resource-env-ref element will be returned.
* @return the instance defined for the element resource-env-ref
*/
public ResourceEnvRefType getOrCreateResourceEnvRef();
/**
* Creates a new resource-env-ref element
* @return the new created instance of ResourceEnvRefType
*/
public ResourceEnvRefType createResourceEnvRef();
/**
* Returns all resource-env-ref elements
* @return list of resource-env-ref
*/
public List> getAllResourceEnvRef();
/**
* Removes all resource-env-ref elements
* @return the current instance of ResourceEnvRefType
*/
public WebAppDescriptor removeAllResourceEnvRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:message-destination-refType ElementType : message-destination-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new message-destination-ref element will be created and returned.
* Otherwise, the first existing message-destination-ref element will be returned.
* @return the instance defined for the element message-destination-ref
*/
public MessageDestinationRefType getOrCreateMessageDestinationRef();
/**
* Creates a new message-destination-ref element
* @return the new created instance of MessageDestinationRefType
*/
public MessageDestinationRefType createMessageDestinationRef();
/**
* Returns all message-destination-ref elements
* @return list of message-destination-ref
*/
public List> getAllMessageDestinationRef();
/**
* Removes all message-destination-ref elements
* @return the current instance of MessageDestinationRefType
*/
public WebAppDescriptor removeAllMessageDestinationRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:persistence-context-refType ElementType : persistence-context-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new persistence-context-ref element will be created and returned.
* Otherwise, the first existing persistence-context-ref element will be returned.
* @return the instance defined for the element persistence-context-ref
*/
public PersistenceContextRefType getOrCreatePersistenceContextRef();
/**
* Creates a new persistence-context-ref element
* @return the new created instance of PersistenceContextRefType
*/
public PersistenceContextRefType createPersistenceContextRef();
/**
* Returns all persistence-context-ref elements
* @return list of persistence-context-ref
*/
public List> getAllPersistenceContextRef();
/**
* Removes all persistence-context-ref elements
* @return the current instance of PersistenceContextRefType
*/
public WebAppDescriptor removeAllPersistenceContextRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:persistence-unit-refType ElementType : persistence-unit-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new persistence-unit-ref element will be created and returned.
* Otherwise, the first existing persistence-unit-ref element will be returned.
* @return the instance defined for the element persistence-unit-ref
*/
public PersistenceUnitRefType getOrCreatePersistenceUnitRef();
/**
* Creates a new persistence-unit-ref element
* @return the new created instance of PersistenceUnitRefType
*/
public PersistenceUnitRefType createPersistenceUnitRef();
/**
* Returns all persistence-unit-ref elements
* @return list of persistence-unit-ref
*/
public List> getAllPersistenceUnitRef();
/**
* Removes all persistence-unit-ref elements
* @return the current instance of PersistenceUnitRefType
*/
public WebAppDescriptor removeAllPersistenceUnitRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:lifecycle-callbackType ElementType : post-construct
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new post-construct element will be created and returned.
* Otherwise, the first existing post-construct element will be returned.
* @return the instance defined for the element post-construct
*/
public LifecycleCallbackType getOrCreatePostConstruct();
/**
* Creates a new post-construct element
* @return the new created instance of LifecycleCallbackType
*/
public LifecycleCallbackType createPostConstruct();
/**
* Returns all post-construct elements
* @return list of post-construct
*/
public List> getAllPostConstruct();
/**
* Removes all post-construct elements
* @return the current instance of LifecycleCallbackType
*/
public WebAppDescriptor removeAllPostConstruct();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:lifecycle-callbackType ElementType : pre-destroy
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new pre-destroy element will be created and returned.
* Otherwise, the first existing pre-destroy element will be returned.
* @return the instance defined for the element pre-destroy
*/
public LifecycleCallbackType getOrCreatePreDestroy();
/**
* Creates a new pre-destroy element
* @return the new created instance of LifecycleCallbackType
*/
public LifecycleCallbackType createPreDestroy();
/**
* Returns all pre-destroy elements
* @return list of pre-destroy
*/
public List> getAllPreDestroy();
/**
* Removes all pre-destroy elements
* @return the current instance of LifecycleCallbackType
*/
public WebAppDescriptor removeAllPreDestroy();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:service-refType ElementType : service-ref
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new service-ref element will be created and returned.
* Otherwise, the first existing service-ref element will be returned.
* @return the instance defined for the element service-ref
*/
public ServiceRefType getOrCreateServiceRef();
/**
* Creates a new service-ref element
* @return the new created instance of ServiceRefType
*/
public ServiceRefType createServiceRef();
/**
* Returns all service-ref elements
* @return list of service-ref
*/
public List> getAllServiceRef();
/**
* Removes all service-ref elements
* @return the current instance of ServiceRefType
*/
public WebAppDescriptor removeAllServiceRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:emptyType ElementType : distributable
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the distributable element
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor distributable();
/**
* Removes the distributable element
* @return the current instance of WebAppDescriptor
*/
public Boolean isDistributable();
/**
* Removes the distributable element
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor removeDistributable();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:param-valueType ElementType : context-param
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new context-param element will be created and returned.
* Otherwise, the first existing context-param element will be returned.
* @return the instance defined for the element context-param
*/
public ParamValueType getOrCreateContextParam();
/**
* Creates a new context-param element
* @return the new created instance of ParamValueType
*/
public ParamValueType createContextParam();
/**
* Returns all context-param elements
* @return list of context-param
*/
public List> getAllContextParam();
/**
* Removes all context-param elements
* @return the current instance of ParamValueType
*/
public WebAppDescriptor removeAllContextParam();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:filterType ElementType : filter
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new filter element will be created and returned.
* Otherwise, the first existing filter element will be returned.
* @return the instance defined for the element filter
*/
public FilterType getOrCreateFilter();
/**
* Creates a new filter element
* @return the new created instance of FilterType
*/
public FilterType createFilter();
/**
* Returns all filter elements
* @return list of filter
*/
public List> getAllFilter();
/**
* Removes all filter elements
* @return the current instance of FilterType
*/
public WebAppDescriptor removeAllFilter();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:filter-mappingType ElementType : filter-mapping
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new filter-mapping element will be created and returned.
* Otherwise, the first existing filter-mapping element will be returned.
* @return the instance defined for the element filter-mapping
*/
public FilterMappingType getOrCreateFilterMapping();
/**
* Creates a new filter-mapping element
* @return the new created instance of FilterMappingType
*/
public FilterMappingType createFilterMapping();
/**
* Returns all filter-mapping elements
* @return list of filter-mapping
*/
public List> getAllFilterMapping();
/**
* Removes all filter-mapping elements
* @return the current instance of FilterMappingType
*/
public WebAppDescriptor removeAllFilterMapping();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:listenerType ElementType : listener
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new listener element will be created and returned.
* Otherwise, the first existing listener element will be returned.
* @return the instance defined for the element listener
*/
public ListenerType getOrCreateListener();
/**
* Creates a new listener element
* @return the new created instance of ListenerType
*/
public ListenerType createListener();
/**
* Returns all listener elements
* @return list of listener
*/
public List> getAllListener();
/**
* Removes all listener elements
* @return the current instance of ListenerType
*/
public WebAppDescriptor removeAllListener();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:servletType ElementType : servlet
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new servlet element will be created and returned.
* Otherwise, the first existing servlet element will be returned.
* @return the instance defined for the element servlet
*/
public ServletType getOrCreateServlet();
/**
* Creates a new servlet element
* @return the new created instance of ServletType
*/
public ServletType createServlet();
/**
* Returns all servlet elements
* @return list of servlet
*/
public List> getAllServlet();
/**
* Removes all servlet elements
* @return the current instance of ServletType
*/
public WebAppDescriptor removeAllServlet();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:servlet-mappingType ElementType : servlet-mapping
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new servlet-mapping element will be created and returned.
* Otherwise, the first existing servlet-mapping element will be returned.
* @return the instance defined for the element servlet-mapping
*/
public ServletMappingType getOrCreateServletMapping();
/**
* Creates a new servlet-mapping element
* @return the new created instance of ServletMappingType
*/
public ServletMappingType createServletMapping();
/**
* Returns all servlet-mapping elements
* @return list of servlet-mapping
*/
public List> getAllServletMapping();
/**
* Removes all servlet-mapping elements
* @return the current instance of ServletMappingType
*/
public WebAppDescriptor removeAllServletMapping();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:session-configType ElementType : session-config
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new session-config element will be created and returned.
* Otherwise, the first existing session-config element will be returned.
* @return the instance defined for the element session-config
*/
public SessionConfigType getOrCreateSessionConfig();
/**
* Creates a new session-config element
* @return the new created instance of SessionConfigType
*/
public SessionConfigType createSessionConfig();
/**
* Returns all session-config elements
* @return list of session-config
*/
public List> getAllSessionConfig();
/**
* Removes all session-config elements
* @return the current instance of SessionConfigType
*/
public WebAppDescriptor removeAllSessionConfig();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:mime-mappingType ElementType : mime-mapping
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new mime-mapping element will be created and returned.
* Otherwise, the first existing mime-mapping element will be returned.
* @return the instance defined for the element mime-mapping
*/
public MimeMappingType getOrCreateMimeMapping();
/**
* Creates a new mime-mapping element
* @return the new created instance of MimeMappingType
*/
public MimeMappingType createMimeMapping();
/**
* Returns all mime-mapping elements
* @return list of mime-mapping
*/
public List> getAllMimeMapping();
/**
* Removes all mime-mapping elements
* @return the current instance of MimeMappingType
*/
public WebAppDescriptor removeAllMimeMapping();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:welcome-file-listType ElementType : welcome-file-list
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new welcome-file-list element will be created and returned.
* Otherwise, the first existing welcome-file-list element will be returned.
* @return the instance defined for the element welcome-file-list
*/
public WelcomeFileListType getOrCreateWelcomeFileList();
/**
* Creates a new welcome-file-list element
* @return the new created instance of WelcomeFileListType
*/
public WelcomeFileListType createWelcomeFileList();
/**
* Returns all welcome-file-list elements
* @return list of welcome-file-list
*/
public List> getAllWelcomeFileList();
/**
* Removes all welcome-file-list elements
* @return the current instance of WelcomeFileListType
*/
public WebAppDescriptor removeAllWelcomeFileList();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:error-pageType ElementType : error-page
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new error-page element will be created and returned.
* Otherwise, the first existing error-page element will be returned.
* @return the instance defined for the element error-page
*/
public ErrorPageType getOrCreateErrorPage();
/**
* Creates a new error-page element
* @return the new created instance of ErrorPageType
*/
public ErrorPageType createErrorPage();
/**
* Returns all error-page elements
* @return list of error-page
*/
public List> getAllErrorPage();
/**
* Removes all error-page elements
* @return the current instance of ErrorPageType
*/
public WebAppDescriptor removeAllErrorPage();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:jsp-configType ElementType : jsp-config
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new jsp-config element will be created and returned.
* Otherwise, the first existing jsp-config element will be returned.
* @return the instance defined for the element jsp-config
*/
public JspConfigType getOrCreateJspConfig();
/**
* Creates a new jsp-config element
* @return the new created instance of JspConfigType
*/
public JspConfigType createJspConfig();
/**
* Returns all jsp-config elements
* @return list of jsp-config
*/
public List> getAllJspConfig();
/**
* Removes all jsp-config elements
* @return the current instance of JspConfigType
*/
public WebAppDescriptor removeAllJspConfig();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:security-constraintType ElementType : security-constraint
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new security-constraint element will be created and returned.
* Otherwise, the first existing security-constraint element will be returned.
* @return the instance defined for the element security-constraint
*/
public SecurityConstraintType getOrCreateSecurityConstraint();
/**
* Creates a new security-constraint element
* @return the new created instance of SecurityConstraintType
*/
public SecurityConstraintType createSecurityConstraint();
/**
* Returns all security-constraint elements
* @return list of security-constraint
*/
public List> getAllSecurityConstraint();
/**
* Removes all security-constraint elements
* @return the current instance of SecurityConstraintType
*/
public WebAppDescriptor removeAllSecurityConstraint();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:login-configType ElementType : login-config
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new login-config element will be created and returned.
* Otherwise, the first existing login-config element will be returned.
* @return the instance defined for the element login-config
*/
public LoginConfigType getOrCreateLoginConfig();
/**
* Creates a new login-config element
* @return the new created instance of LoginConfigType
*/
public LoginConfigType createLoginConfig();
/**
* Returns all login-config elements
* @return list of login-config
*/
public List> getAllLoginConfig();
/**
* Removes all login-config elements
* @return the current instance of LoginConfigType
*/
public WebAppDescriptor removeAllLoginConfig();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:security-roleType ElementType : security-role
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new security-role element will be created and returned.
* Otherwise, the first existing security-role element will be returned.
* @return the instance defined for the element security-role
*/
public SecurityRoleType getOrCreateSecurityRole();
/**
* Creates a new security-role element
* @return the new created instance of SecurityRoleType
*/
public SecurityRoleType createSecurityRole();
/**
* Returns all security-role elements
* @return list of security-role
*/
public List> getAllSecurityRole();
/**
* Removes all security-role elements
* @return the current instance of SecurityRoleType
*/
public WebAppDescriptor removeAllSecurityRole();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:message-destinationType ElementType : message-destination
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new message-destination element will be created and returned.
* Otherwise, the first existing message-destination element will be returned.
* @return the instance defined for the element message-destination
*/
public MessageDestinationType getOrCreateMessageDestination();
/**
* Creates a new message-destination element
* @return the new created instance of MessageDestinationType
*/
public MessageDestinationType createMessageDestination();
/**
* Returns all message-destination elements
* @return list of message-destination
*/
public List> getAllMessageDestination();
/**
* Removes all message-destination elements
* @return the current instance of MessageDestinationType
*/
public WebAppDescriptor removeAllMessageDestination();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:locale-encoding-mapping-listType ElementType : locale-encoding-mapping-list
// MaxOccurs: -unbounded isGeneric: false isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new locale-encoding-mapping-list element will be created and returned.
* Otherwise, the first existing locale-encoding-mapping-list element will be returned.
* @return the instance defined for the element locale-encoding-mapping-list
*/
public LocaleEncodingMappingListType getOrCreateLocaleEncodingMappingList();
/**
* Creates a new locale-encoding-mapping-list element
* @return the new created instance of LocaleEncodingMappingListType
*/
public LocaleEncodingMappingListType createLocaleEncodingMappingList();
/**
* Returns all locale-encoding-mapping-list elements
* @return list of locale-encoding-mapping-list
*/
public List> getAllLocaleEncodingMappingList();
/**
* Removes all locale-encoding-mapping-list elements
* @return the current instance of LocaleEncodingMappingListType
*/
public WebAppDescriptor removeAllLocaleEncodingMappingList();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: javaee:web-app-versionType ElementType : version
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor version(WebAppVersionType version);
/**
* Sets the version attribute
* @param version the value for the attribute version
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor version(String version);
/**
* Returns the version attribute
* @return the value defined for the attribute version
*/
public WebAppVersionType getVersion();
/**
* Returns the version attribute
* @return the value found for the element version
*/
public String getVersionAsString();
/**
* Removes the version attribute
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor removeVersion();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: xsd:ID ElementType : id
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the id attribute
* @param id the value for the attribute id
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor id(String id);
/**
* Returns the id attribute
* @return the value defined for the attribute id
*/
public String getId();
/**
* Removes the id attribute
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor removeId();
// --------------------------------------------------------------------------------------------------------||
// ClassName: WebAppDescriptor ElementName: xsd:boolean ElementType : metadata-complete
// MaxOccurs: - isGeneric: false isAttribute: true isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the metadata-complete attribute
* @param metadataComplete the value for the attribute metadata-complete
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor metadataComplete(Boolean metadataComplete);
/**
* Returns the metadata-complete attribute
* @return the value defined for the attribute metadata-complete
*/
public Boolean isMetadataComplete();
/**
* Removes the metadata-complete attribute
* @return the current instance of WebAppDescriptor
*/
public WebAppDescriptor removeMetadataComplete();
}