org.jboss.shrinkwrap.descriptor.api.jboss51
Interface JbossDescriptor

All Superinterfaces:
Descriptor, DescriptorNamespace<JbossDescriptor>

public interface JbossDescriptor
extends Descriptor, DescriptorNamespace<JbossDescriptor>

This deployment descriptor provides the functionalities as described in the specification

Example:

JbossDescriptor descriptor = Descriptors.create(JbossDescriptor.class);

Since:
Generation date :2013-01-26T19:27:00.777+01:00
Author:
Ralf Battenfeld, Andrew Lee Rubinger

Method Summary
 IconType<JbossDescriptor> createIcon()
          Creates a new icon element
 JbossDescriptor description(String... values)
          Creates for all String objects representing description elements, a new description element
 JbossDescriptor displayName(String... values)
          Creates for all String objects representing display-name elements, a new display-name element
 List<String> getAllDescription()
          Returns all description elements
 List<String> getAllDisplayName()
          Returns all display-name elements
 List<IconType<JbossDescriptor>> getAllIcon()
          Returns all icon elements
 String getId()
          Returns the id attribute
 String getJaccContextId()
          Returns the jacc-context-id element
 String getJmxName()
          Returns the jmx-name element
 String getJndiBindingPolicy()
          Returns the jndi-binding-policy element
 AssemblyDescriptorType<JbossDescriptor> getOrCreateAssemblyDescriptor()
          If not already created, a new assembly-descriptor element with the given value will be created.
 EnterpriseBeansType<JbossDescriptor> getOrCreateEnterpriseBeans()
          If not already created, a new enterprise-beans element with the given value will be created.
 IconType<JbossDescriptor> getOrCreateIcon()
          If not already created, a new icon element will be created and returned.
 LoaderRepositoryType<JbossDescriptor> getOrCreateLoaderRepository()
          If not already created, a new loader-repository element with the given value will be created.
 ResourceManagersType<JbossDescriptor> getOrCreateResourceManagers()
          If not already created, a new resource-managers element with the given value will be created.
 WebservicesType<JbossDescriptor> getOrCreateWebservices()
          If not already created, a new webservices element with the given value will be created.
 String getSecurityDomain()
          Returns the security-domain element
 String getUnauthenticatedPrincipal()
          Returns the unauthenticated-principal element
 String getVersion()
          Returns the version attribute
 JbossDescriptor id(String id)
          Sets the id attribute
 Boolean isMetadataComplete()
          Returns the metadata-complete attribute
 Boolean isMissingMethodPermissionsExcludedMode()
          Returns the missing-method-permissions-excluded-mode element
 JbossDescriptor jaccContextId(String jaccContextId)
          Sets the jacc-context-id element
 JbossDescriptor jmxName(String jmxName)
          Sets the jmx-name element
 JbossDescriptor jndiBindingPolicy(String jndiBindingPolicy)
          Sets the jndi-binding-policy element
 JbossDescriptor metadataComplete(Boolean metadataComplete)
          Sets the metadata-complete attribute
 JbossDescriptor missingMethodPermissionsExcludedMode(Boolean missingMethodPermissionsExcludedMode)
          Sets the missing-method-permissions-excluded-mode element
 JbossDescriptor removeAllDescription()
          Removes the description element
 JbossDescriptor removeAllDisplayName()
          Removes the display-name element
 JbossDescriptor removeAllIcon()
          Removes all icon elements
 JbossDescriptor removeAssemblyDescriptor()
          Removes the assembly-descriptor element
 JbossDescriptor removeEnterpriseBeans()
          Removes the enterprise-beans element
 JbossDescriptor removeId()
          Removes the id attribute
 JbossDescriptor removeJaccContextId()
          Removes the jacc-context-id element
 JbossDescriptor removeJmxName()
          Removes the jmx-name element
 JbossDescriptor removeJndiBindingPolicy()
          Removes the jndi-binding-policy element
 JbossDescriptor removeLoaderRepository()
          Removes the loader-repository element
 JbossDescriptor removeMetadataComplete()
          Removes the metadata-complete attribute
 JbossDescriptor removeMissingMethodPermissionsExcludedMode()
          Removes the missing-method-permissions-excluded-mode element
 JbossDescriptor removeResourceManagers()
          Removes the resource-managers element
 JbossDescriptor removeSecurityDomain()
          Removes the security-domain element
 JbossDescriptor removeUnauthenticatedPrincipal()
          Removes the unauthenticated-principal element
 JbossDescriptor removeVersion()
          Removes the version attribute
 JbossDescriptor removeWebservices()
          Removes the webservices element
 JbossDescriptor securityDomain(String securityDomain)
          Sets the security-domain element
 JbossDescriptor unauthenticatedPrincipal(String unauthenticatedPrincipal)
          Sets the unauthenticated-principal element
 JbossDescriptor version(String version)
          Sets the version attribute
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor
exportAsString, exportTo, getDescriptorName
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace
addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces
 

Method Detail

description

JbossDescriptor description(String... values)
Creates for all String objects representing description elements, a new description element

Parameters:
values - list of description objects
Returns:
the current instance of JbossDescriptor

getAllDescription

List<String> getAllDescription()
Returns all description elements

Returns:
list of description

removeAllDescription

JbossDescriptor removeAllDescription()
Removes the description element

Returns:
the current instance of JbossDescriptor

displayName

JbossDescriptor displayName(String... values)
Creates for all String objects representing display-name elements, a new display-name element

Parameters:
values - list of display-name objects
Returns:
the current instance of JbossDescriptor

getAllDisplayName

List<String> getAllDisplayName()
Returns all display-name elements

Returns:
list of display-name

removeAllDisplayName

JbossDescriptor removeAllDisplayName()
Removes the display-name element

Returns:
the current instance of JbossDescriptor

getOrCreateIcon

IconType<JbossDescriptor> getOrCreateIcon()
If not already created, a new icon element will be created and returned. Otherwise, the first existing icon element will be returned.

Returns:
the instance defined for the element icon

createIcon

IconType<JbossDescriptor> createIcon()
Creates a new icon element

Returns:
the new created instance of IconType

getAllIcon

List<IconType<JbossDescriptor>> getAllIcon()
Returns all icon elements

Returns:
list of icon

removeAllIcon

JbossDescriptor removeAllIcon()
Removes all icon elements

Returns:
the current instance of IconType

getOrCreateLoaderRepository

LoaderRepositoryType<JbossDescriptor> getOrCreateLoaderRepository()
If not already created, a new loader-repository element with the given value will be created. Otherwise, the existing loader-repository element will be returned.

Returns:
a new or existing instance of LoaderRepositoryType

removeLoaderRepository

JbossDescriptor removeLoaderRepository()
Removes the loader-repository element

Returns:
the current instance of JbossDescriptor

jmxName

JbossDescriptor jmxName(String jmxName)
Sets the jmx-name element

Parameters:
jmxName - the value for the element jmx-name
Returns:
the current instance of JbossDescriptor

getJmxName

String getJmxName()
Returns the jmx-name element

Returns:
the node defined for the element jmx-name

removeJmxName

JbossDescriptor removeJmxName()
Removes the jmx-name element

Returns:
the current instance of JbossDescriptor

securityDomain

JbossDescriptor securityDomain(String securityDomain)
Sets the security-domain element

Parameters:
securityDomain - the value for the element security-domain
Returns:
the current instance of JbossDescriptor

getSecurityDomain

String getSecurityDomain()
Returns the security-domain element

Returns:
the node defined for the element security-domain

removeSecurityDomain

JbossDescriptor removeSecurityDomain()
Removes the security-domain element

Returns:
the current instance of JbossDescriptor

missingMethodPermissionsExcludedMode

JbossDescriptor missingMethodPermissionsExcludedMode(Boolean missingMethodPermissionsExcludedMode)
Sets the missing-method-permissions-excluded-mode element

Parameters:
missingMethodPermissionsExcludedMode - the value for the element missing-method-permissions-excluded-mode
Returns:
the current instance of JbossDescriptor

isMissingMethodPermissionsExcludedMode

Boolean isMissingMethodPermissionsExcludedMode()
Returns the missing-method-permissions-excluded-mode element

Returns:
the node defined for the element missing-method-permissions-excluded-mode

removeMissingMethodPermissionsExcludedMode

JbossDescriptor removeMissingMethodPermissionsExcludedMode()
Removes the missing-method-permissions-excluded-mode element

Returns:
the current instance of JbossDescriptor

unauthenticatedPrincipal

JbossDescriptor unauthenticatedPrincipal(String unauthenticatedPrincipal)
Sets the unauthenticated-principal element

Parameters:
unauthenticatedPrincipal - the value for the element unauthenticated-principal
Returns:
the current instance of JbossDescriptor

getUnauthenticatedPrincipal

String getUnauthenticatedPrincipal()
Returns the unauthenticated-principal element

Returns:
the node defined for the element unauthenticated-principal

removeUnauthenticatedPrincipal

JbossDescriptor removeUnauthenticatedPrincipal()
Removes the unauthenticated-principal element

Returns:
the current instance of JbossDescriptor

jndiBindingPolicy

JbossDescriptor jndiBindingPolicy(String jndiBindingPolicy)
Sets the jndi-binding-policy element

Parameters:
jndiBindingPolicy - the value for the element jndi-binding-policy
Returns:
the current instance of JbossDescriptor

getJndiBindingPolicy

String getJndiBindingPolicy()
Returns the jndi-binding-policy element

Returns:
the node defined for the element jndi-binding-policy

removeJndiBindingPolicy

JbossDescriptor removeJndiBindingPolicy()
Removes the jndi-binding-policy element

Returns:
the current instance of JbossDescriptor

jaccContextId

JbossDescriptor jaccContextId(String jaccContextId)
Sets the jacc-context-id element

Parameters:
jaccContextId - the value for the element jacc-context-id
Returns:
the current instance of JbossDescriptor

getJaccContextId

String getJaccContextId()
Returns the jacc-context-id element

Returns:
the node defined for the element jacc-context-id

removeJaccContextId

JbossDescriptor removeJaccContextId()
Removes the jacc-context-id element

Returns:
the current instance of JbossDescriptor

getOrCreateWebservices

WebservicesType<JbossDescriptor> getOrCreateWebservices()
If not already created, a new webservices element with the given value will be created. Otherwise, the existing webservices element will be returned.

Returns:
a new or existing instance of WebservicesType

removeWebservices

JbossDescriptor removeWebservices()
Removes the webservices element

Returns:
the current instance of JbossDescriptor

getOrCreateEnterpriseBeans

EnterpriseBeansType<JbossDescriptor> getOrCreateEnterpriseBeans()
If not already created, a new enterprise-beans element with the given value will be created. Otherwise, the existing enterprise-beans element will be returned.

Returns:
a new or existing instance of EnterpriseBeansType

removeEnterpriseBeans

JbossDescriptor removeEnterpriseBeans()
Removes the enterprise-beans element

Returns:
the current instance of JbossDescriptor

getOrCreateAssemblyDescriptor

AssemblyDescriptorType<JbossDescriptor> getOrCreateAssemblyDescriptor()
If not already created, a new assembly-descriptor element with the given value will be created. Otherwise, the existing assembly-descriptor element will be returned.

Returns:
a new or existing instance of AssemblyDescriptorType

removeAssemblyDescriptor

JbossDescriptor removeAssemblyDescriptor()
Removes the assembly-descriptor element

Returns:
the current instance of JbossDescriptor

getOrCreateResourceManagers

ResourceManagersType<JbossDescriptor> getOrCreateResourceManagers()
If not already created, a new resource-managers element with the given value will be created. Otherwise, the existing resource-managers element will be returned.

Returns:
a new or existing instance of ResourceManagersType

removeResourceManagers

JbossDescriptor removeResourceManagers()
Removes the resource-managers element

Returns:
the current instance of JbossDescriptor

version

JbossDescriptor version(String version)
Sets the version attribute

Parameters:
version - the value for the attribute version
Returns:
the current instance of JbossDescriptor

getVersion

String getVersion()
Returns the version attribute

Returns:
the value defined for the attribute version

removeVersion

JbossDescriptor removeVersion()
Removes the version attribute

Returns:
the current instance of JbossDescriptor

metadataComplete

JbossDescriptor metadataComplete(Boolean metadataComplete)
Sets the metadata-complete attribute

Parameters:
metadataComplete - the value for the attribute metadata-complete
Returns:
the current instance of JbossDescriptor

isMetadataComplete

Boolean isMetadataComplete()
Returns the metadata-complete attribute

Returns:
the value defined for the attribute metadata-complete

removeMetadataComplete

JbossDescriptor removeMetadataComplete()
Removes the metadata-complete attribute

Returns:
the current instance of JbossDescriptor

id

JbossDescriptor id(String id)
Sets the id attribute

Parameters:
id - the value for the attribute id
Returns:
the current instance of JbossDescriptor

getId

String getId()
Returns the id attribute

Returns:
the value defined for the attribute id

removeId

JbossDescriptor removeId()
Removes the id attribute

Returns:
the current instance of JbossDescriptor


Copyright © 2013 JBoss, a division of Red Hat, Inc.. All Rights Reserved.