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, getDescriptorName
addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces
EnvEntryType<JbossWebDescriptor> getOrCreateEnvEntry()
env-entry
element will be created and returned.
Otherwise, the first existing env-entry
element will be returned.env-entry
EnvEntryType<JbossWebDescriptor> createEnvEntry()
env-entry
elementEnvEntryType
List<EnvEntryType<JbossWebDescriptor>> getAllEnvEntry()
env-entry
elementsenv-entry
JbossWebDescriptor removeAllEnvEntry()
env-entry
elementsEnvEntryType
EjbRefType<JbossWebDescriptor> getOrCreateEjbRef()
ejb-ref
element will be created and returned.
Otherwise, the first existing ejb-ref
element will be returned.ejb-ref
EjbRefType<JbossWebDescriptor> createEjbRef()
ejb-ref
elementEjbRefType
List<EjbRefType<JbossWebDescriptor>> getAllEjbRef()
ejb-ref
elementsejb-ref
JbossWebDescriptor removeAllEjbRef()
ejb-ref
elementsEjbRefType
EjbLocalRefType<JbossWebDescriptor> getOrCreateEjbLocalRef()
ejb-local-ref
element will be created and returned.
Otherwise, the first existing ejb-local-ref
element will be returned.ejb-local-ref
EjbLocalRefType<JbossWebDescriptor> createEjbLocalRef()
ejb-local-ref
elementEjbLocalRefType
List<EjbLocalRefType<JbossWebDescriptor>> getAllEjbLocalRef()
ejb-local-ref
elementsejb-local-ref
JbossWebDescriptor removeAllEjbLocalRef()
ejb-local-ref
elementsEjbLocalRefType
ResourceRefType<JbossWebDescriptor> getOrCreateResourceRef()
resource-ref
element will be created and returned.
Otherwise, the first existing resource-ref
element will be returned.resource-ref
ResourceRefType<JbossWebDescriptor> createResourceRef()
resource-ref
elementResourceRefType
List<ResourceRefType<JbossWebDescriptor>> getAllResourceRef()
resource-ref
elementsresource-ref
JbossWebDescriptor removeAllResourceRef()
resource-ref
elementsResourceRefType
ResourceEnvRefType<JbossWebDescriptor> getOrCreateResourceEnvRef()
resource-env-ref
element will be created and returned.
Otherwise, the first existing resource-env-ref
element will be returned.resource-env-ref
ResourceEnvRefType<JbossWebDescriptor> createResourceEnvRef()
resource-env-ref
elementResourceEnvRefType
List<ResourceEnvRefType<JbossWebDescriptor>> getAllResourceEnvRef()
resource-env-ref
elementsresource-env-ref
JbossWebDescriptor removeAllResourceEnvRef()
resource-env-ref
elementsResourceEnvRefType
MessageDestinationRefType<JbossWebDescriptor> getOrCreateMessageDestinationRef()
message-destination-ref
element will be created and returned.
Otherwise, the first existing message-destination-ref
element will be returned.message-destination-ref
MessageDestinationRefType<JbossWebDescriptor> createMessageDestinationRef()
message-destination-ref
elementMessageDestinationRefType
List<MessageDestinationRefType<JbossWebDescriptor>> getAllMessageDestinationRef()
message-destination-ref
elementsmessage-destination-ref
JbossWebDescriptor removeAllMessageDestinationRef()
message-destination-ref
elementsMessageDestinationRefType
PersistenceContextRefType<JbossWebDescriptor> getOrCreatePersistenceContextRef()
persistence-context-ref
element will be created and returned.
Otherwise, the first existing persistence-context-ref
element will be returned.persistence-context-ref
PersistenceContextRefType<JbossWebDescriptor> createPersistenceContextRef()
persistence-context-ref
elementPersistenceContextRefType
List<PersistenceContextRefType<JbossWebDescriptor>> getAllPersistenceContextRef()
persistence-context-ref
elementspersistence-context-ref
JbossWebDescriptor removeAllPersistenceContextRef()
persistence-context-ref
elementsPersistenceContextRefType
PersistenceUnitRefType<JbossWebDescriptor> getOrCreatePersistenceUnitRef()
persistence-unit-ref
element will be created and returned.
Otherwise, the first existing persistence-unit-ref
element will be returned.persistence-unit-ref
PersistenceUnitRefType<JbossWebDescriptor> createPersistenceUnitRef()
persistence-unit-ref
elementPersistenceUnitRefType
List<PersistenceUnitRefType<JbossWebDescriptor>> getAllPersistenceUnitRef()
persistence-unit-ref
elementspersistence-unit-ref
JbossWebDescriptor removeAllPersistenceUnitRef()
persistence-unit-ref
elementsPersistenceUnitRefType
LifecycleCallbackType<JbossWebDescriptor> getOrCreatePostConstruct()
post-construct
element will be created and returned.
Otherwise, the first existing post-construct
element will be returned.post-construct
LifecycleCallbackType<JbossWebDescriptor> createPostConstruct()
post-construct
elementLifecycleCallbackType
List<LifecycleCallbackType<JbossWebDescriptor>> getAllPostConstruct()
post-construct
elementspost-construct
JbossWebDescriptor removeAllPostConstruct()
post-construct
elementsLifecycleCallbackType
LifecycleCallbackType<JbossWebDescriptor> getOrCreatePreDestroy()
pre-destroy
element will be created and returned.
Otherwise, the first existing pre-destroy
element will be returned.pre-destroy
LifecycleCallbackType<JbossWebDescriptor> createPreDestroy()
pre-destroy
elementLifecycleCallbackType
List<LifecycleCallbackType<JbossWebDescriptor>> getAllPreDestroy()
pre-destroy
elementspre-destroy
JbossWebDescriptor removeAllPreDestroy()
pre-destroy
elementsLifecycleCallbackType
DataSourceType<JbossWebDescriptor> getOrCreateDataSource()
data-source
element will be created and returned.
Otherwise, the first existing data-source
element will be returned.data-source
DataSourceType<JbossWebDescriptor> createDataSource()
data-source
elementDataSourceType
List<DataSourceType<JbossWebDescriptor>> getAllDataSource()
data-source
elementsdata-source
JbossWebDescriptor removeAllDataSource()
data-source
elementsDataSourceType
ServiceRefType<JbossWebDescriptor> getOrCreateServiceRef()
service-ref
element will be created and returned.
Otherwise, the first existing service-ref
element will be returned.service-ref
ServiceRefType<JbossWebDescriptor> createServiceRef()
service-ref
elementServiceRefType
List<ServiceRefType<JbossWebDescriptor>> getAllServiceRef()
service-ref
elementsservice-ref
JbossWebDescriptor removeAllServiceRef()
service-ref
elementsServiceRefType
ClassLoadingType<JbossWebDescriptor> getOrCreateClassLoading()
class-loading
element with the given value will be created.
Otherwise, the existing class-loading
element will be returned.ClassLoadingType
JbossWebDescriptor removeClassLoading()
class-loading
elementJbossWebDescriptor
JbossWebDescriptor securityDomain(String securityDomain)
security-domain
elementsecurityDomain
- the value for the element security-domain
JbossWebDescriptor
String getSecurityDomain()
security-domain
elementsecurity-domain
JbossWebDescriptor removeSecurityDomain()
security-domain
elementJbossWebDescriptor
JbossWebDescriptor jaccStarRoleAllow(GenericBooleanType jaccStarRoleAllow)
jacc-star-role-allow
elementjaccStarRoleAllow
- the value for the element jacc-star-role-allow
JbossWebDescriptor
JbossWebDescriptor jaccStarRoleAllow(String jaccStarRoleAllow)
jacc-star-role-allow
elementjaccStarRoleAllow
- the value for the element jacc-star-role-allow
JbossWebDescriptor
GenericBooleanType getJaccStarRoleAllow()
jacc-star-role-allow
elementjacc-star-role-allow
String getJaccStarRoleAllowAsString()
jacc-star-role-allow
elementjacc-star-role-allow
JbossWebDescriptor removeJaccStarRoleAllow()
jacc-star-role-allow
attributeJbossWebDescriptor
JbossWebDescriptor contextRoot(String contextRoot)
context-root
elementcontextRoot
- the value for the element context-root
JbossWebDescriptor
String getContextRoot()
context-root
elementcontext-root
JbossWebDescriptor removeContextRoot()
context-root
elementJbossWebDescriptor
JbossWebDescriptor virtualHost(String... values)
virtual-host
elements,
a new virtual-host
elementvalues
- list of virtual-host
objectsJbossWebDescriptor
List<String> getAllVirtualHost()
virtual-host
elementsvirtual-host
JbossWebDescriptor removeAllVirtualHost()
virtual-host
elementJbossWebDescriptor
JbossWebDescriptor useSessionCookies(GenericBooleanType useSessionCookies)
use-session-cookies
elementuseSessionCookies
- the value for the element use-session-cookies
JbossWebDescriptor
JbossWebDescriptor useSessionCookies(String useSessionCookies)
use-session-cookies
elementuseSessionCookies
- the value for the element use-session-cookies
JbossWebDescriptor
GenericBooleanType getUseSessionCookies()
use-session-cookies
elementuse-session-cookies
String getUseSessionCookiesAsString()
use-session-cookies
elementuse-session-cookies
JbossWebDescriptor removeUseSessionCookies()
use-session-cookies
attributeJbossWebDescriptor
ReplicationConfigType<JbossWebDescriptor> getOrCreateReplicationConfig()
replication-config
element with the given value will be created.
Otherwise, the existing replication-config
element will be returned.ReplicationConfigType
JbossWebDescriptor removeReplicationConfig()
replication-config
elementJbossWebDescriptor
SecurityRoleType<JbossWebDescriptor> getOrCreateSecurityRole()
security-role
element will be created and returned.
Otherwise, the first existing security-role
element will be returned.security-role
SecurityRoleType<JbossWebDescriptor> createSecurityRole()
security-role
elementSecurityRoleType
List<SecurityRoleType<JbossWebDescriptor>> getAllSecurityRole()
security-role
elementssecurity-role
JbossWebDescriptor removeAllSecurityRole()
security-role
elementsSecurityRoleType
MessageDestinationType<JbossWebDescriptor> getOrCreateMessageDestination()
message-destination
element will be created and returned.
Otherwise, the first existing message-destination
element will be returned.message-destination
MessageDestinationType<JbossWebDescriptor> createMessageDestination()
message-destination
elementMessageDestinationType
List<MessageDestinationType<JbossWebDescriptor>> getAllMessageDestination()
message-destination
elementsmessage-destination
JbossWebDescriptor removeAllMessageDestination()
message-destination
elementsMessageDestinationType
WebserviceDescriptionType<JbossWebDescriptor> getOrCreateWebserviceDescription()
webservice-description
element will be created and returned.
Otherwise, the first existing webservice-description
element will be returned.webservice-description
WebserviceDescriptionType<JbossWebDescriptor> createWebserviceDescription()
webservice-description
elementWebserviceDescriptionType
List<WebserviceDescriptionType<JbossWebDescriptor>> getAllWebserviceDescription()
webservice-description
elementswebservice-description
JbossWebDescriptor removeAllWebserviceDescription()
webservice-description
elementsWebserviceDescriptionType
JbossWebDescriptor depends(String... values)
depends
elements,
a new depends
elementvalues
- list of depends
objectsJbossWebDescriptor
JbossWebDescriptor removeAllDepends()
depends
elementJbossWebDescriptor
ServletType<JbossWebDescriptor> getOrCreateServlet()
servlet
element will be created and returned.
Otherwise, the first existing servlet
element will be returned.servlet
ServletType<JbossWebDescriptor> createServlet()
servlet
elementServletType
List<ServletType<JbossWebDescriptor>> getAllServlet()
servlet
elementsservlet
JbossWebDescriptor removeAllServlet()
servlet
elementsServletType
JbossWebDescriptor maxActiveSessions(Integer maxActiveSessions)
max-active-sessions
elementmaxActiveSessions
- the value for the element max-active-sessions
JbossWebDescriptor
Integer getMaxActiveSessions()
max-active-sessions
elementmax-active-sessions
JbossWebDescriptor removeMaxActiveSessions()
max-active-sessions
elementJbossWebDescriptor
PassivationConfigType<JbossWebDescriptor> getOrCreatePassivationConfig()
passivation-config
element with the given value will be created.
Otherwise, the existing passivation-config
element will be returned.PassivationConfigType
JbossWebDescriptor removePassivationConfig()
passivation-config
elementJbossWebDescriptor
AnnotationType<JbossWebDescriptor> getOrCreateAnnotation()
annotation
element with the given value will be created.
Otherwise, the existing annotation
element will be returned.AnnotationType
JbossWebDescriptor removeAnnotation()
annotation
elementJbossWebDescriptor
JbossWebDescriptor version(JbossWebVersionType version)
version
attributeversion
- the value for the attribute version
JbossWebDescriptor
JbossWebDescriptor version(String version)
version
attributeversion
- the value for the attribute version
JbossWebDescriptor
JbossWebVersionType getVersion()
version
attributeversion
String getVersionAsString()
version
attributeversion
JbossWebDescriptor removeVersion()
version
attributeJbossWebDescriptor
Copyright © 2015 JBoss by Red Hat. All rights reserved.