Interface ConnectorDescriptor
- All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Descriptor,org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace<ConnectorDescriptor>
- All Known Implementing Classes:
ConnectorDescriptorImpl
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 -
Method Summary
Modifier and TypeMethodDescriptionCreates a newiconelementdescription(String... values) Creates for all String objects representingdescriptionelements, a newdescriptionelementdisplayName(String... values) Creates for all String objects representingdisplay-nameelements, a newdisplay-nameelementSets theeis-typeelementReturns alldescriptionelementsReturns alldisplay-nameelementsReturns alliconelementsReturns allrequired-work-contextelementsReturns theeis-typeelementgetId()Returns theidattributeReturns themodule-nameelementIf not already created, a newiconelement will be created and returned.If not already created, a newlicenseelement with the given value will be created.If not already created, a newresourceadapterelement with the given value will be created.Returns theresourceadapter-versionelementReturns thevendor-nameelementReturns theversionattributeSets theidattributeReturns themetadata-completeattributemetadataComplete(Boolean metadataComplete) Sets themetadata-completeattributemoduleName(String moduleName) Sets themodule-nameelementRemoves thedescriptionelementRemoves thedisplay-nameelementRemoves alliconelementsRemoves therequired-work-contextelementRemoves theeis-typeelementremoveId()Removes theidattributeRemoves thelicenseelementRemoves themetadata-completeattributeRemoves themodule-nameelementRemoves theresourceadapterelementRemoves theresourceadapter-versionelementRemoves thevendor-nameelementRemoves theversionattributerequiredWorkContext(String... values) Creates for all String objects representingrequired-work-contextelements, a newrequired-work-contextelementresourceadapterVersion(String resourceadapterVersion) Sets theresourceadapter-versionelementvendorName(String vendorName) Sets thevendor-nameelementSets theversionattributeMethods inherited from interface org.jboss.shrinkwrap.descriptor.api.Descriptor
exportAsString, exportTo, getDescriptorNameMethods inherited from interface org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace
addDefaultNamespaces, addNamespace, getNamespaces, removeAllNamespaces
-
Field Details
-
VERSION
- See Also:
-
-
Method Details
-
description
Creates for all String objects representingdescriptionelements, a newdescriptionelement- Parameters:
values- list ofdescriptionobjects- Returns:
- the current instance of
ConnectorDescriptor
-
getAllDescription
Returns alldescriptionelements- Returns:
- list of
description
-
removeAllDescription
ConnectorDescriptor removeAllDescription()Removes thedescriptionelement- Returns:
- the current instance of
ConnectorDescriptor
-
displayName
Creates for all String objects representingdisplay-nameelements, a newdisplay-nameelement- Parameters:
values- list ofdisplay-nameobjects- Returns:
- the current instance of
ConnectorDescriptor
-
getAllDisplayName
Returns alldisplay-nameelements- Returns:
- list of
display-name
-
removeAllDisplayName
ConnectorDescriptor removeAllDisplayName()Removes thedisplay-nameelement- Returns:
- the current instance of
ConnectorDescriptor
-
getOrCreateIcon
IconType<ConnectorDescriptor> getOrCreateIcon()If not already created, a newiconelement will be created and returned. Otherwise, the first existingiconelement will be returned.- Returns:
- the instance defined for the element
icon
-
createIcon
IconType<ConnectorDescriptor> createIcon()Creates a newiconelement- Returns:
- the new created instance of
IconType
-
getAllIcon
List<IconType<ConnectorDescriptor>> getAllIcon()Returns alliconelements- Returns:
- list of
icon
-
removeAllIcon
ConnectorDescriptor removeAllIcon()Removes alliconelements- Returns:
- the current instance of
IconType
-
moduleName
Sets themodule-nameelement- Parameters:
moduleName- the value for the elementmodule-name- Returns:
- the current instance of
ConnectorDescriptor
-
getModuleName
String getModuleName()Returns themodule-nameelement- Returns:
- the node defined for the element
module-name
-
removeModuleName
ConnectorDescriptor removeModuleName()Removes themodule-nameelement- Returns:
- the current instance of
ConnectorDescriptor
-
vendorName
Sets thevendor-nameelement- Parameters:
vendorName- the value for the elementvendor-name- Returns:
- the current instance of
ConnectorDescriptor
-
getVendorName
String getVendorName()Returns thevendor-nameelement- Returns:
- the node defined for the element
vendor-name
-
removeVendorName
ConnectorDescriptor removeVendorName()Removes thevendor-nameelement- Returns:
- the current instance of
ConnectorDescriptor
-
eisType
Sets theeis-typeelement- Parameters:
eisType- the value for the elementeis-type- Returns:
- the current instance of
ConnectorDescriptor
-
getEisType
String getEisType()Returns theeis-typeelement- Returns:
- the node defined for the element
eis-type
-
removeEisType
ConnectorDescriptor removeEisType()Removes theeis-typeelement- Returns:
- the current instance of
ConnectorDescriptor
-
resourceadapterVersion
Sets theresourceadapter-versionelement- Parameters:
resourceadapterVersion- the value for the elementresourceadapter-version- Returns:
- the current instance of
ConnectorDescriptor
-
getResourceadapterVersion
String getResourceadapterVersion()Returns theresourceadapter-versionelement- Returns:
- the node defined for the element
resourceadapter-version
-
removeResourceadapterVersion
ConnectorDescriptor removeResourceadapterVersion()Removes theresourceadapter-versionelement- Returns:
- the current instance of
ConnectorDescriptor
-
getOrCreateLicense
LicenseType<ConnectorDescriptor> getOrCreateLicense()If not already created, a newlicenseelement with the given value will be created. Otherwise, the existinglicenseelement will be returned.- Returns:
- a new or existing instance of
LicenseType
-
removeLicense
ConnectorDescriptor removeLicense()Removes thelicenseelement- Returns:
- the current instance of
ConnectorDescriptor
-
getOrCreateResourceadapter
ResourceadapterType<ConnectorDescriptor> getOrCreateResourceadapter()If not already created, a newresourceadapterelement with the given value will be created. Otherwise, the existingresourceadapterelement will be returned.- Returns:
- a new or existing instance of
ResourceadapterType
-
removeResourceadapter
ConnectorDescriptor removeResourceadapter()Removes theresourceadapterelement- Returns:
- the current instance of
ConnectorDescriptor
-
requiredWorkContext
Creates for all String objects representingrequired-work-contextelements, a newrequired-work-contextelement- Parameters:
values- list ofrequired-work-contextobjects- Returns:
- the current instance of
ConnectorDescriptor
-
getAllRequiredWorkContext
Returns allrequired-work-contextelements- Returns:
- list of
required-work-context
-
removeAllRequiredWorkContext
ConnectorDescriptor removeAllRequiredWorkContext()Removes therequired-work-contextelement- Returns:
- the current instance of
ConnectorDescriptor
-
version
Sets theversionattribute- Parameters:
version- the value for the attributeversion- Returns:
- the current instance of
ConnectorDescriptor
-
getVersion
String getVersion()Returns theversionattribute- Returns:
- the value defined for the attribute
version
-
removeVersion
ConnectorDescriptor removeVersion()Removes theversionattribute- Returns:
- the current instance of
ConnectorDescriptor
-
metadataComplete
Sets themetadata-completeattribute- Parameters:
metadataComplete- the value for the attributemetadata-complete- Returns:
- the current instance of
ConnectorDescriptor
-
isMetadataComplete
Boolean isMetadataComplete()Returns themetadata-completeattribute- Returns:
- the value defined for the attribute
metadata-complete
-
removeMetadataComplete
ConnectorDescriptor removeMetadataComplete()Removes themetadata-completeattribute- Returns:
- the current instance of
ConnectorDescriptor
-
id
Sets theidattribute- Parameters:
id- the value for the attributeid- Returns:
- the current instance of
ConnectorDescriptor
-
getId
String getId()Returns theidattribute- Returns:
- the value defined for the attribute
id
-
removeId
ConnectorDescriptor removeId()Removes theidattribute- Returns:
- the current instance of
ConnectorDescriptor
-