
public interface JbossWebDescriptor extends Descriptor, DescriptorNamespace<JbossWebDescriptor>
This deployment descriptor provides the functionalities as described in the specification
Example:
JbossWebDescriptor descriptor = Descriptors.create(JbossWebDescriptor.class);
| Modifier and Type | Method and Description |
|---|---|
JbossWebDescriptor |
contextRoot(String contextRoot)
Sets the
context-root element |
DataSourceType<JbossWebDescriptor> |
createDataSource()
Creates a new
data-source element |
EjbLocalRefType<JbossWebDescriptor> |
createEjbLocalRef()
Creates a new
ejb-local-ref element |
EjbRefType<JbossWebDescriptor> |
createEjbRef()
Creates a new
ejb-ref element |
EnvEntryType<JbossWebDescriptor> |
createEnvEntry()
Creates a new
env-entry element |
MessageDestinationType<JbossWebDescriptor> |
createMessageDestination()
Creates a new
message-destination element |
MessageDestinationRefType<JbossWebDescriptor> |
createMessageDestinationRef()
Creates a new
message-destination-ref element |
PersistenceContextRefType<JbossWebDescriptor> |
createPersistenceContextRef()
Creates a new
persistence-context-ref element |
PersistenceUnitRefType<JbossWebDescriptor> |
createPersistenceUnitRef()
Creates a new
persistence-unit-ref element |
LifecycleCallbackType<JbossWebDescriptor> |
createPostConstruct()
Creates a new
post-construct element |
LifecycleCallbackType<JbossWebDescriptor> |
createPreDestroy()
Creates a new
pre-destroy element |
ResourceEnvRefType<JbossWebDescriptor> |
createResourceEnvRef()
Creates a new
resource-env-ref element |
ResourceRefType<JbossWebDescriptor> |
createResourceRef()
Creates a new
resource-ref element |
SecurityRoleType<JbossWebDescriptor> |
createSecurityRole()
Creates a new
security-role element |
ServiceRefType<JbossWebDescriptor> |
createServiceRef()
Creates a new
service-ref element |
ServletType<JbossWebDescriptor> |
createServlet()
Creates a new
servlet element |
WebserviceDescriptionType<JbossWebDescriptor> |
createWebserviceDescription()
Creates a new
webservice-description element |
JbossWebDescriptor |
depends(String... values)
Creates for all String objects representing
depends elements,
a new depends element |
List<DataSourceType<JbossWebDescriptor>> |
getAllDataSource()
Returns all
data-source elements |
List<String> |
getAllDepends()
Returns all
depends elements |
List<EjbLocalRefType<JbossWebDescriptor>> |
getAllEjbLocalRef()
Returns all
ejb-local-ref elements |
List<EjbRefType<JbossWebDescriptor>> |
getAllEjbRef()
Returns all
ejb-ref elements |
List<EnvEntryType<JbossWebDescriptor>> |
getAllEnvEntry()
Returns all
env-entry elements |
List<MessageDestinationType<JbossWebDescriptor>> |
getAllMessageDestination()
Returns all
message-destination elements |
List<MessageDestinationRefType<JbossWebDescriptor>> |
getAllMessageDestinationRef()
Returns all
message-destination-ref elements |
List<PersistenceContextRefType<JbossWebDescriptor>> |
getAllPersistenceContextRef()
Returns all
persistence-context-ref elements |
List<PersistenceUnitRefType<JbossWebDescriptor>> |
getAllPersistenceUnitRef()
Returns all
persistence-unit-ref elements |
List<LifecycleCallbackType<JbossWebDescriptor>> |
getAllPostConstruct()
Returns all
post-construct elements |
List<LifecycleCallbackType<JbossWebDescriptor>> |
getAllPreDestroy()
Returns all
pre-destroy elements |
List<ResourceEnvRefType<JbossWebDescriptor>> |
getAllResourceEnvRef()
Returns all
resource-env-ref elements |
List<ResourceRefType<JbossWebDescriptor>> |
getAllResourceRef()
Returns all
resource-ref elements |
List<SecurityRoleType<JbossWebDescriptor>> |
getAllSecurityRole()
Returns all
security-role elements |
List<ServiceRefType<JbossWebDescriptor>> |
getAllServiceRef()
Returns all
service-ref elements |
List<ServletType<JbossWebDescriptor>> |
getAllServlet()
Returns all
servlet elements |
List<String> |
getAllVirtualHost()
Returns all
virtual-host elements |
List<WebserviceDescriptionType<JbossWebDescriptor>> |
getAllWebserviceDescription()
Returns all
webservice-description elements |
String |
getContextRoot()
Returns the
context-root element |
GenericBooleanType |
getJaccStarRoleAllow()
Returns the
jacc-star-role-allow element |
String |
getJaccStarRoleAllowAsString()
Returns the
jacc-star-role-allow element |
Integer |
getMaxActiveSessions()
Returns the
max-active-sessions element |
AnnotationType<JbossWebDescriptor> |
getOrCreateAnnotation()
If not already created, a new
annotation element with the given value will be created. |
ClassLoadingType<JbossWebDescriptor> |
getOrCreateClassLoading()
If not already created, a new
class-loading element with the given value will be created. |
DataSourceType<JbossWebDescriptor> |
getOrCreateDataSource()
If not already created, a new
data-source element will be created and returned. |
EjbLocalRefType<JbossWebDescriptor> |
getOrCreateEjbLocalRef()
If not already created, a new
ejb-local-ref element will be created and returned. |
EjbRefType<JbossWebDescriptor> |
getOrCreateEjbRef()
If not already created, a new
ejb-ref element will be created and returned. |
EnvEntryType<JbossWebDescriptor> |
getOrCreateEnvEntry()
If not already created, a new
env-entry element will be created and returned. |
MessageDestinationType<JbossWebDescriptor> |
getOrCreateMessageDestination()
If not already created, a new
message-destination element will be created and returned. |
MessageDestinationRefType<JbossWebDescriptor> |
getOrCreateMessageDestinationRef()
If not already created, a new
message-destination-ref element will be created and returned. |
PassivationConfigType<JbossWebDescriptor> |
getOrCreatePassivationConfig()
If not already created, a new
passivation-config element with the given value will be created. |
PersistenceContextRefType<JbossWebDescriptor> |
getOrCreatePersistenceContextRef()
If not already created, a new
persistence-context-ref element will be created and returned. |
PersistenceUnitRefType<JbossWebDescriptor> |
getOrCreatePersistenceUnitRef()
If not already created, a new
persistence-unit-ref element will be created and returned. |
LifecycleCallbackType<JbossWebDescriptor> |
getOrCreatePostConstruct()
If not already created, a new
post-construct element will be created and returned. |
LifecycleCallbackType<JbossWebDescriptor> |
getOrCreatePreDestroy()
If not already created, a new
pre-destroy element will be created and returned. |
ReplicationConfigType<JbossWebDescriptor> |
getOrCreateReplicationConfig()
If not already created, a new
replication-config element with the given value will be created. |
ResourceEnvRefType<JbossWebDescriptor> |
getOrCreateResourceEnvRef()
If not already created, a new
resource-env-ref element will be created and returned. |
ResourceRefType<JbossWebDescriptor> |
getOrCreateResourceRef()
If not already created, a new
resource-ref element will be created and returned. |
SecurityRoleType<JbossWebDescriptor> |
getOrCreateSecurityRole()
If not already created, a new
security-role element will be created and returned. |
ServiceRefType<JbossWebDescriptor> |
getOrCreateServiceRef()
If not already created, a new
service-ref element will be created and returned. |
ServletType<JbossWebDescriptor> |
getOrCreateServlet()
If not already created, a new
servlet element will be created and returned. |
WebserviceDescriptionType<JbossWebDescriptor> |
getOrCreateWebserviceDescription()
If not already created, a new
webservice-description element will be created and returned. |
String |
getSecurityDomain()
Returns the
security-domain element |
GenericBooleanType |
getUseSessionCookies()
Returns the
use-session-cookies element |
String |
getUseSessionCookiesAsString()
Returns the
use-session-cookies element |
JbossWebVersionType |
getVersion()
Returns the
version attribute |
String |
getVersionAsString()
Returns the
version attribute |
JbossWebDescriptor |
jaccStarRoleAllow(GenericBooleanType jaccStarRoleAllow)
Sets the
jacc-star-role-allow element |
JbossWebDescriptor |
jaccStarRoleAllow(String jaccStarRoleAllow)
Sets the
jacc-star-role-allow element |
JbossWebDescriptor |
maxActiveSessions(Integer maxActiveSessions)
Sets the
max-active-sessions element |
JbossWebDescriptor |
removeAllDataSource()
Removes all
data-source elements |
JbossWebDescriptor |
removeAllDepends()
Removes the
depends element |
JbossWebDescriptor |
removeAllEjbLocalRef()
Removes all
ejb-local-ref elements |
JbossWebDescriptor |
removeAllEjbRef()
Removes all
ejb-ref elements |
JbossWebDescriptor |
removeAllEnvEntry()
Removes all
env-entry elements |
JbossWebDescriptor |
removeAllMessageDestination()
Removes all
message-destination elements |
JbossWebDescriptor |
removeAllMessageDestinationRef()
Removes all
message-destination-ref elements |
JbossWebDescriptor |
removeAllPersistenceContextRef()
Removes all
persistence-context-ref elements |
JbossWebDescriptor |
removeAllPersistenceUnitRef()
Removes all
persistence-unit-ref elements |
JbossWebDescriptor |
removeAllPostConstruct()
Removes all
post-construct elements |
JbossWebDescriptor |
removeAllPreDestroy()
Removes all
pre-destroy elements |
JbossWebDescriptor |
removeAllResourceEnvRef()
Removes all
resource-env-ref elements |
JbossWebDescriptor |
removeAllResourceRef()
Removes all
resource-ref elements |
JbossWebDescriptor |
removeAllSecurityRole()
Removes all
security-role elements |
JbossWebDescriptor |
removeAllServiceRef()
Removes all
service-ref elements |
JbossWebDescriptor |
removeAllServlet()
Removes all
servlet elements |
JbossWebDescriptor |
removeAllVirtualHost()
Removes the
virtual-host element |
JbossWebDescriptor |
removeAllWebserviceDescription()
Removes all
webservice-description elements |
JbossWebDescriptor |
removeAnnotation()
Removes the
annotation element |
JbossWebDescriptor |
removeClassLoading()
Removes the
class-loading element |
JbossWebDescriptor |
removeContextRoot()
Removes the
context-root element |
JbossWebDescriptor |
removeJaccStarRoleAllow()
Removes the
jacc-star-role-allow attribute |
JbossWebDescriptor |
removeMaxActiveSessions()
Removes the
max-active-sessions element |
JbossWebDescriptor |
removePassivationConfig()
Removes the
passivation-config element |
JbossWebDescriptor |
removeReplicationConfig()
Removes the
replication-config element |
JbossWebDescriptor |
removeSecurityDomain()
Removes the
security-domain element |
JbossWebDescriptor |
removeUseSessionCookies()
Removes the
use-session-cookies attribute |
JbossWebDescriptor |
removeVersion()
Removes the
version attribute |
JbossWebDescriptor |
securityDomain(String securityDomain)
Sets the
security-domain element |
JbossWebDescriptor |
useSessionCookies(GenericBooleanType useSessionCookies)
Sets the
use-session-cookies element |
JbossWebDescriptor |
useSessionCookies(String useSessionCookies)
Sets the
use-session-cookies element |
JbossWebDescriptor |
version(JbossWebVersionType version)
Sets the
version attribute |
JbossWebDescriptor |
version(String version)
Sets the
version attribute |
JbossWebDescriptor |
virtualHost(String... values)
Creates for all String objects representing
virtual-host elements,
a new virtual-host element |
exportAsString, exportTo, getDescriptorNameaddDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespacesEnvEntryType<JbossWebDescriptor> getOrCreateEnvEntry()
env-entry element will be created and returned.
Otherwise, the first existing env-entry element will be returned.env-entryEnvEntryType<JbossWebDescriptor> createEnvEntry()
env-entry elementEnvEntryTypeList<EnvEntryType<JbossWebDescriptor>> getAllEnvEntry()
env-entry elementsenv-entryJbossWebDescriptor removeAllEnvEntry()
env-entry elementsEnvEntryTypeEjbRefType<JbossWebDescriptor> getOrCreateEjbRef()
ejb-ref element will be created and returned.
Otherwise, the first existing ejb-ref element will be returned.ejb-refEjbRefType<JbossWebDescriptor> createEjbRef()
ejb-ref elementEjbRefTypeList<EjbRefType<JbossWebDescriptor>> getAllEjbRef()
ejb-ref elementsejb-refJbossWebDescriptor removeAllEjbRef()
ejb-ref elementsEjbRefTypeEjbLocalRefType<JbossWebDescriptor> getOrCreateEjbLocalRef()
ejb-local-ref element will be created and returned.
Otherwise, the first existing ejb-local-ref element will be returned.ejb-local-refEjbLocalRefType<JbossWebDescriptor> createEjbLocalRef()
ejb-local-ref elementEjbLocalRefTypeList<EjbLocalRefType<JbossWebDescriptor>> getAllEjbLocalRef()
ejb-local-ref elementsejb-local-refJbossWebDescriptor removeAllEjbLocalRef()
ejb-local-ref elementsEjbLocalRefTypeResourceRefType<JbossWebDescriptor> getOrCreateResourceRef()
resource-ref element will be created and returned.
Otherwise, the first existing resource-ref element will be returned.resource-refResourceRefType<JbossWebDescriptor> createResourceRef()
resource-ref elementResourceRefTypeList<ResourceRefType<JbossWebDescriptor>> getAllResourceRef()
resource-ref elementsresource-refJbossWebDescriptor removeAllResourceRef()
resource-ref elementsResourceRefTypeResourceEnvRefType<JbossWebDescriptor> getOrCreateResourceEnvRef()
resource-env-ref element will be created and returned.
Otherwise, the first existing resource-env-ref element will be returned.resource-env-refResourceEnvRefType<JbossWebDescriptor> createResourceEnvRef()
resource-env-ref elementResourceEnvRefTypeList<ResourceEnvRefType<JbossWebDescriptor>> getAllResourceEnvRef()
resource-env-ref elementsresource-env-refJbossWebDescriptor removeAllResourceEnvRef()
resource-env-ref elementsResourceEnvRefTypeMessageDestinationRefType<JbossWebDescriptor> getOrCreateMessageDestinationRef()
message-destination-ref element will be created and returned.
Otherwise, the first existing message-destination-ref element will be returned.message-destination-refMessageDestinationRefType<JbossWebDescriptor> createMessageDestinationRef()
message-destination-ref elementMessageDestinationRefTypeList<MessageDestinationRefType<JbossWebDescriptor>> getAllMessageDestinationRef()
message-destination-ref elementsmessage-destination-refJbossWebDescriptor removeAllMessageDestinationRef()
message-destination-ref elementsMessageDestinationRefTypePersistenceContextRefType<JbossWebDescriptor> getOrCreatePersistenceContextRef()
persistence-context-ref element will be created and returned.
Otherwise, the first existing persistence-context-ref element will be returned.persistence-context-refPersistenceContextRefType<JbossWebDescriptor> createPersistenceContextRef()
persistence-context-ref elementPersistenceContextRefTypeList<PersistenceContextRefType<JbossWebDescriptor>> getAllPersistenceContextRef()
persistence-context-ref elementspersistence-context-refJbossWebDescriptor removeAllPersistenceContextRef()
persistence-context-ref elementsPersistenceContextRefTypePersistenceUnitRefType<JbossWebDescriptor> getOrCreatePersistenceUnitRef()
persistence-unit-ref element will be created and returned.
Otherwise, the first existing persistence-unit-ref element will be returned.persistence-unit-refPersistenceUnitRefType<JbossWebDescriptor> createPersistenceUnitRef()
persistence-unit-ref elementPersistenceUnitRefTypeList<PersistenceUnitRefType<JbossWebDescriptor>> getAllPersistenceUnitRef()
persistence-unit-ref elementspersistence-unit-refJbossWebDescriptor removeAllPersistenceUnitRef()
persistence-unit-ref elementsPersistenceUnitRefTypeLifecycleCallbackType<JbossWebDescriptor> getOrCreatePostConstruct()
post-construct element will be created and returned.
Otherwise, the first existing post-construct element will be returned.post-constructLifecycleCallbackType<JbossWebDescriptor> createPostConstruct()
post-construct elementLifecycleCallbackTypeList<LifecycleCallbackType<JbossWebDescriptor>> getAllPostConstruct()
post-construct elementspost-constructJbossWebDescriptor removeAllPostConstruct()
post-construct elementsLifecycleCallbackTypeLifecycleCallbackType<JbossWebDescriptor> getOrCreatePreDestroy()
pre-destroy element will be created and returned.
Otherwise, the first existing pre-destroy element will be returned.pre-destroyLifecycleCallbackType<JbossWebDescriptor> createPreDestroy()
pre-destroy elementLifecycleCallbackTypeList<LifecycleCallbackType<JbossWebDescriptor>> getAllPreDestroy()
pre-destroy elementspre-destroyJbossWebDescriptor removeAllPreDestroy()
pre-destroy elementsLifecycleCallbackTypeDataSourceType<JbossWebDescriptor> getOrCreateDataSource()
data-source element will be created and returned.
Otherwise, the first existing data-source element will be returned.data-sourceDataSourceType<JbossWebDescriptor> createDataSource()
data-source elementDataSourceTypeList<DataSourceType<JbossWebDescriptor>> getAllDataSource()
data-source elementsdata-sourceJbossWebDescriptor removeAllDataSource()
data-source elementsDataSourceTypeServiceRefType<JbossWebDescriptor> getOrCreateServiceRef()
service-ref element will be created and returned.
Otherwise, the first existing service-ref element will be returned.service-refServiceRefType<JbossWebDescriptor> createServiceRef()
service-ref elementServiceRefTypeList<ServiceRefType<JbossWebDescriptor>> getAllServiceRef()
service-ref elementsservice-refJbossWebDescriptor removeAllServiceRef()
service-ref elementsServiceRefTypeClassLoadingType<JbossWebDescriptor> getOrCreateClassLoading()
class-loading element with the given value will be created.
Otherwise, the existing class-loading element will be returned.ClassLoadingTypeJbossWebDescriptor removeClassLoading()
class-loading elementJbossWebDescriptorJbossWebDescriptor securityDomain(String securityDomain)
security-domain elementsecurityDomain - the value for the element security-domainJbossWebDescriptorString getSecurityDomain()
security-domain elementsecurity-domainJbossWebDescriptor removeSecurityDomain()
security-domain elementJbossWebDescriptorJbossWebDescriptor jaccStarRoleAllow(GenericBooleanType jaccStarRoleAllow)
jacc-star-role-allow elementjaccStarRoleAllow - the value for the element jacc-star-role-allowJbossWebDescriptorJbossWebDescriptor jaccStarRoleAllow(String jaccStarRoleAllow)
jacc-star-role-allow elementjaccStarRoleAllow - the value for the element jacc-star-role-allowJbossWebDescriptorGenericBooleanType getJaccStarRoleAllow()
jacc-star-role-allow elementjacc-star-role-allowString getJaccStarRoleAllowAsString()
jacc-star-role-allow elementjacc-star-role-allowJbossWebDescriptor removeJaccStarRoleAllow()
jacc-star-role-allow attributeJbossWebDescriptorJbossWebDescriptor contextRoot(String contextRoot)
context-root elementcontextRoot - the value for the element context-rootJbossWebDescriptorString getContextRoot()
context-root elementcontext-rootJbossWebDescriptor removeContextRoot()
context-root elementJbossWebDescriptorJbossWebDescriptor virtualHost(String... values)
virtual-host elements,
a new virtual-host elementvalues - list of virtual-host objectsJbossWebDescriptorList<String> getAllVirtualHost()
virtual-host elementsvirtual-hostJbossWebDescriptor removeAllVirtualHost()
virtual-host elementJbossWebDescriptorJbossWebDescriptor useSessionCookies(GenericBooleanType useSessionCookies)
use-session-cookies elementuseSessionCookies - the value for the element use-session-cookiesJbossWebDescriptorJbossWebDescriptor useSessionCookies(String useSessionCookies)
use-session-cookies elementuseSessionCookies - the value for the element use-session-cookiesJbossWebDescriptorGenericBooleanType getUseSessionCookies()
use-session-cookies elementuse-session-cookiesString getUseSessionCookiesAsString()
use-session-cookies elementuse-session-cookiesJbossWebDescriptor removeUseSessionCookies()
use-session-cookies attributeJbossWebDescriptorReplicationConfigType<JbossWebDescriptor> getOrCreateReplicationConfig()
replication-config element with the given value will be created.
Otherwise, the existing replication-config element will be returned.ReplicationConfigTypeJbossWebDescriptor removeReplicationConfig()
replication-config elementJbossWebDescriptorSecurityRoleType<JbossWebDescriptor> getOrCreateSecurityRole()
security-role element will be created and returned.
Otherwise, the first existing security-role element will be returned.security-roleSecurityRoleType<JbossWebDescriptor> createSecurityRole()
security-role elementSecurityRoleTypeList<SecurityRoleType<JbossWebDescriptor>> getAllSecurityRole()
security-role elementssecurity-roleJbossWebDescriptor removeAllSecurityRole()
security-role elementsSecurityRoleTypeMessageDestinationType<JbossWebDescriptor> getOrCreateMessageDestination()
message-destination element will be created and returned.
Otherwise, the first existing message-destination element will be returned.message-destinationMessageDestinationType<JbossWebDescriptor> createMessageDestination()
message-destination elementMessageDestinationTypeList<MessageDestinationType<JbossWebDescriptor>> getAllMessageDestination()
message-destination elementsmessage-destinationJbossWebDescriptor removeAllMessageDestination()
message-destination elementsMessageDestinationTypeWebserviceDescriptionType<JbossWebDescriptor> getOrCreateWebserviceDescription()
webservice-description element will be created and returned.
Otherwise, the first existing webservice-description element will be returned.webservice-descriptionWebserviceDescriptionType<JbossWebDescriptor> createWebserviceDescription()
webservice-description elementWebserviceDescriptionTypeList<WebserviceDescriptionType<JbossWebDescriptor>> getAllWebserviceDescription()
webservice-description elementswebservice-descriptionJbossWebDescriptor removeAllWebserviceDescription()
webservice-description elementsWebserviceDescriptionTypeJbossWebDescriptor depends(String... values)
depends elements,
a new depends elementvalues - list of depends objectsJbossWebDescriptorJbossWebDescriptor removeAllDepends()
depends elementJbossWebDescriptorServletType<JbossWebDescriptor> getOrCreateServlet()
servlet element will be created and returned.
Otherwise, the first existing servlet element will be returned.servletServletType<JbossWebDescriptor> createServlet()
servlet elementServletTypeList<ServletType<JbossWebDescriptor>> getAllServlet()
servlet elementsservletJbossWebDescriptor removeAllServlet()
servlet elementsServletTypeJbossWebDescriptor maxActiveSessions(Integer maxActiveSessions)
max-active-sessions elementmaxActiveSessions - the value for the element max-active-sessionsJbossWebDescriptorInteger getMaxActiveSessions()
max-active-sessions elementmax-active-sessionsJbossWebDescriptor removeMaxActiveSessions()
max-active-sessions elementJbossWebDescriptorPassivationConfigType<JbossWebDescriptor> getOrCreatePassivationConfig()
passivation-config element with the given value will be created.
Otherwise, the existing passivation-config element will be returned.PassivationConfigTypeJbossWebDescriptor removePassivationConfig()
passivation-config elementJbossWebDescriptorAnnotationType<JbossWebDescriptor> getOrCreateAnnotation()
annotation element with the given value will be created.
Otherwise, the existing annotation element will be returned.AnnotationTypeJbossWebDescriptor removeAnnotation()
annotation elementJbossWebDescriptorJbossWebDescriptor version(JbossWebVersionType version)
version attributeversion - the value for the attribute versionJbossWebDescriptorJbossWebDescriptor version(String version)
version attributeversion - the value for the attribute versionJbossWebDescriptorJbossWebVersionType getVersion()
version attributeversionString getVersionAsString()
version attributeversionJbossWebDescriptor removeVersion()
version attributeJbossWebDescriptorCopyright © 2021 JBoss by Red Hat. All rights reserved.