ConnectorDescriptor (IronJacamar Embedded)

All Superinterfaces:

org.jboss.shrinkwrap.descriptor.api.Descriptor, org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>
```
public interface ConnectorDescriptor
extends org.jboss.shrinkwrap.descriptor.api.Descriptor, org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>
```
This deployment descriptor provides the functionalities as described in the specification
Example:
ConnectorDescriptor descriptor = Descriptors.create(ConnectorDescriptor.class);

Field Summary

Fields
Modifier and Type Field and Description

static String VERSION

Fields
Modifier and Type	Field and Description
`static String`	`VERSION`

Method Summary

Methods
Modifier and Type	Method and Description
`IconType<ConnectorDescriptor>`	`createIcon()` Creates a new `icon` element
`ConnectorDescriptor`	`description(String... values)` Creates for all String objects representing `description` elements, a new `description` element
`ConnectorDescriptor`	`displayName(String... values)` Creates for all String objects representing `display-name` elements, a new `display-name` element
`ConnectorDescriptor`	`eisType(String eisType)` Sets the `eis-type` element
`List<String>`	`getAllDescription()` Returns all `description` elements
`List<String>`	`getAllDisplayName()` Returns all `display-name` elements
`List<IconType<ConnectorDescriptor>>`	`getAllIcon()` Returns all `icon` elements
`List<String>`	`getAllRequiredWorkContext()` Returns all `required-work-context` elements
`String`	`getEisType()` Returns the `eis-type` element
`String`	`getId()` Returns the `id` attribute
`String`	`getModuleName()` Returns the `module-name` element
`IconType<ConnectorDescriptor>`	`getOrCreateIcon()` If not already created, a new `icon` element will be created and returned.
`LicenseType<ConnectorDescriptor>`	`getOrCreateLicense()` If not already created, a new `license` element with the given value will be created.
`ResourceadapterType<ConnectorDescriptor>`	`getOrCreateResourceadapter()` If not already created, a new `resourceadapter` element with the given value will be created.
`String`	`getResourceadapterVersion()` Returns the `resourceadapter-version` element
`String`	`getVendorName()` Returns the `vendor-name` element
`String`	`getVersion()` Returns the `version` attribute
`ConnectorDescriptor`	`id(String id)` Sets the `id` attribute
`Boolean`	`isMetadataComplete()` Returns the `metadata-complete` attribute
`ConnectorDescriptor`	`metadataComplete(Boolean metadataComplete)` Sets the `metadata-complete` attribute
`ConnectorDescriptor`	`moduleName(String moduleName)` Sets the `module-name` element
`ConnectorDescriptor`	`removeAllDescription()` Removes the `description` element
`ConnectorDescriptor`	`removeAllDisplayName()` Removes the `display-name` element
`ConnectorDescriptor`	`removeAllIcon()` Removes all `icon` elements
`ConnectorDescriptor`	`removeAllRequiredWorkContext()` Removes the `required-work-context` element
`ConnectorDescriptor`	`removeEisType()` Removes the `eis-type` element
`ConnectorDescriptor`	`removeId()` Removes the `id` attribute
`ConnectorDescriptor`	`removeLicense()` Removes the `license` element
`ConnectorDescriptor`	`removeMetadataComplete()` Removes the `metadata-complete` attribute
`ConnectorDescriptor`	`removeModuleName()` Removes the `module-name` element
`ConnectorDescriptor`	`removeResourceadapter()` Removes the `resourceadapter` element
`ConnectorDescriptor`	`removeResourceadapterVersion()` Removes the `resourceadapter-version` element
`ConnectorDescriptor`	`removeVendorName()` Removes the `vendor-name` element
`ConnectorDescriptor`	`removeVersion()` Removes the `version` attribute
`ConnectorDescriptor`	`requiredWorkContext(String... values)` Creates for all String objects representing `required-work-context` elements, a new `required-work-context` element
`ConnectorDescriptor`	`resourceadapterVersion(String resourceadapterVersion)` Sets the `resourceadapter-version` element
`ConnectorDescriptor`	`vendorName(String vendorName)` Sets the `vendor-name` element
`ConnectorDescriptor`	`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

- Field Detail
  - VERSION
```
static final String VERSION
```
    See Also:
    Constant Field Values
- Method Detail
  - description
```
ConnectorDescriptor 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 ConnectorDescriptor
  - getAllDescription
```
List<String> getAllDescription()
```
    Returns all description elements
    
    Returns:
    list of description
  - removeAllDescription
```
ConnectorDescriptor removeAllDescription()
```
    Removes the description element
    
    Returns:
    the current instance of ConnectorDescriptor
  - displayName
```
ConnectorDescriptor 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 ConnectorDescriptor
  - getAllDisplayName
```
List<String> getAllDisplayName()
```
    Returns all display-name elements
    
    Returns:
    list of display-name
  - removeAllDisplayName
```
ConnectorDescriptor removeAllDisplayName()
```
    Removes the display-name element
    
    Returns:
    the current instance of ConnectorDescriptor
  - getOrCreateIcon
```
IconType<ConnectorDescriptor> 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<ConnectorDescriptor> createIcon()
```
    Creates a new icon element
    
    Returns:
    the new created instance of IconType
  - getAllIcon
```
List<IconType<ConnectorDescriptor>> getAllIcon()
```
    Returns all icon elements
    
    Returns:
    list of icon
  - removeAllIcon
```
ConnectorDescriptor removeAllIcon()
```
    Removes all icon elements
    
    Returns:
    the current instance of IconType
  - moduleName
```
ConnectorDescriptor moduleName(String moduleName)
```
    Sets the module-name element
    
    Parameters:
    moduleName - the value for the element module-name
    
    Returns:
    the current instance of ConnectorDescriptor
  - getModuleName
```
String getModuleName()
```
    Returns the module-name element
    
    Returns:
    the node defined for the element module-name
  - removeModuleName
```
ConnectorDescriptor removeModuleName()
```
    Removes the module-name element
    
    Returns:
    the current instance of ConnectorDescriptor
  - vendorName
```
ConnectorDescriptor vendorName(String vendorName)
```
    Sets the vendor-name element
    
    Parameters:
    vendorName - the value for the element vendor-name
    
    Returns:
    the current instance of ConnectorDescriptor
  - getVendorName
```
String getVendorName()
```
    Returns the vendor-name element
    
    Returns:
    the node defined for the element vendor-name
  - removeVendorName
```
ConnectorDescriptor removeVendorName()
```
    Removes the vendor-name element
    
    Returns:
    the current instance of ConnectorDescriptor
  - eisType
```
ConnectorDescriptor eisType(String eisType)
```
    Sets the eis-type element
    
    Parameters:
    eisType - the value for the element eis-type
    
    Returns:
    the current instance of ConnectorDescriptor
  - getEisType
```
String getEisType()
```
    Returns the eis-type element
    
    Returns:
    the node defined for the element eis-type
  - removeEisType
```
ConnectorDescriptor removeEisType()
```
    Removes the eis-type element
    
    Returns:
    the current instance of ConnectorDescriptor
  - resourceadapterVersion
```
ConnectorDescriptor resourceadapterVersion(String resourceadapterVersion)
```
    Sets the resourceadapter-version element
    
    Parameters:
    resourceadapterVersion - the value for the element resourceadapter-version
    
    Returns:
    the current instance of ConnectorDescriptor
  - getResourceadapterVersion
```
String getResourceadapterVersion()
```
    Returns the resourceadapter-version element
    
    Returns:
    the node defined for the element resourceadapter-version
  - removeResourceadapterVersion
```
ConnectorDescriptor removeResourceadapterVersion()
```
    Removes the resourceadapter-version element
    
    Returns:
    the current instance of ConnectorDescriptor
  - getOrCreateLicense
```
LicenseType<ConnectorDescriptor> getOrCreateLicense()
```
    If not already created, a new license element with the given value will be created. Otherwise, the existing license element will be returned.
    
    Returns:
    a new or existing instance of LicenseType
  - removeLicense
```
ConnectorDescriptor removeLicense()
```
    Removes the license element
    
    Returns:
    the current instance of ConnectorDescriptor
  - getOrCreateResourceadapter
```
ResourceadapterType<ConnectorDescriptor> getOrCreateResourceadapter()
```
    If not already created, a new resourceadapter element with the given value will be created. Otherwise, the existing resourceadapter element will be returned.
    
    Returns:
    a new or existing instance of ResourceadapterType
  - removeResourceadapter
```
ConnectorDescriptor removeResourceadapter()
```
    Removes the resourceadapter element
    
    Returns:
    the current instance of ConnectorDescriptor
  - requiredWorkContext
```
ConnectorDescriptor requiredWorkContext(String... values)
```
    Creates for all String objects representing required-work-context elements, a new required-work-context element
    
    Parameters:
    values - list of required-work-context objects
    
    Returns:
    the current instance of ConnectorDescriptor
  - getAllRequiredWorkContext
```
List<String> getAllRequiredWorkContext()
```
    Returns all required-work-context elements
    
    Returns:
    list of required-work-context
  - removeAllRequiredWorkContext
```
ConnectorDescriptor removeAllRequiredWorkContext()
```
    Removes the required-work-context element
    
    Returns:
    the current instance of ConnectorDescriptor
  - version
```
ConnectorDescriptor version(String version)
```
    Sets the version attribute
    
    Parameters:
    version - the value for the attribute version
    
    Returns:
    the current instance of ConnectorDescriptor
  - getVersion
```
String getVersion()
```
    Returns the version attribute
    
    Returns:
    the value defined for the attribute version
  - removeVersion
```
ConnectorDescriptor removeVersion()
```
    Removes the version attribute
    
    Returns:
    the current instance of ConnectorDescriptor
  - metadataComplete
```
ConnectorDescriptor metadataComplete(Boolean metadataComplete)
```
    Sets the metadata-complete attribute
    
    Parameters:
    metadataComplete - the value for the attribute metadata-complete
    
    Returns:
    the current instance of ConnectorDescriptor
  - isMetadataComplete
```
Boolean isMetadataComplete()
```
    Returns the metadata-complete attribute
    
    Returns:
    the value defined for the attribute metadata-complete
  - removeMetadataComplete
```
ConnectorDescriptor removeMetadataComplete()
```
    Removes the metadata-complete attribute
    
    Returns:
    the current instance of ConnectorDescriptor
  - id
```
ConnectorDescriptor id(String id)
```
    Sets the id attribute
    
    Parameters:
    id - the value for the attribute id
    
    Returns:
    the current instance of ConnectorDescriptor
  - getId
```
String getId()
```
    Returns the id attribute
    
    Returns:
    the value defined for the attribute id
  - removeId
```
ConnectorDescriptor removeId()
```
    Removes the id attribute
    
    Returns:
    the current instance of ConnectorDescriptor

Interface ConnectorDescriptor

Field Summary

Method Summary

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace

Field Detail

VERSION

Method Detail

description

getAllDescription

removeAllDescription

displayName

getAllDisplayName

removeAllDisplayName

getOrCreateIcon

createIcon

getAllIcon

removeAllIcon

moduleName

getModuleName

removeModuleName

vendorName

getVendorName

removeVendorName

eisType

getEisType

removeEisType

resourceadapterVersion

getResourceadapterVersion

removeResourceadapterVersion

getOrCreateLicense

removeLicense

getOrCreateResourceadapter

removeResourceadapter

requiredWorkContext

getAllRequiredWorkContext

removeAllRequiredWorkContext

version

getVersion

removeVersion

metadataComplete

isMetadataComplete

removeMetadataComplete

id

getId

removeId