Package com.sun.enterprise.deployment

Class ConnectorDescriptor

java.lang.Object

java.util.Observable

org.glassfish.deployment.common.DynamicAttributesDescriptor

org.glassfish.deployment.common.Descriptor

org.glassfish.deployment.common.RootDeploymentDescriptor

com.sun.enterprise.deployment.BundleDescriptor

com.sun.enterprise.deployment.CommonResourceBundleDescriptor

com.sun.enterprise.deployment.ConnectorDescriptor

All Implemented Interfaces:

Roles, Serializable

public class ConnectorDescriptor
extends CommonResourceBundleDescriptor

Deployment Information for connector

Author:

Tony Ng, Qingqing Ouyang

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sun.enterprise.deployment.BundleDescriptor

rootNodes

Fields inherited from class org.glassfish.deployment.common.RootDeploymentDescriptor

classLoader, deplLogger, extensions, moduleDescriptor, moduleID

Fields inherited from class org.glassfish.deployment.common.Descriptor

DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED

Constructor Summary

Constructors

Constructor	Description
ConnectorDescriptor()

Method Summary

Modifier and Type	Method	Description
void	addAdminObject(AdminObject admin)	set admin object
boolean	addAuthMechanism(int mech)	Deprecated.
boolean	addAuthMechanism(AuthMechanism mech)	Deprecated.
void	addConfigProperty(ConnectorConfigProperty configProperty)	add a configProperty to the set
void	addConfigPropertyAnnotation(String className, AnnotationInfo info)
void	addConfigPropertyProcessedClass(String className)
void	addConnectorAnnotation(AnnotationInfo c)
void	addDefaultResourceName(String resourceName)	add a default resource to list of default resource names
void	addRequiredWorkContext(String workContextClass)
void	addSecurityPermission(SecurityPermission permission)	Add a SecurityPermission object to the set
AdminObject	getAdminObject(String adminObjectInterface, String adminObjectClass)
Set	getAdminObjects()
List<AdminObject>	getAdminObjectsByClass(String adminObjectClass)
List<AdminObject>	getAdminObjectsByType(String type)
Map<String,Set<AnnotationInfo>>	getAllConfigPropertyAnnotations()
Set	getAuthMechanisms()	Deprecated.
ComponentVisitor	getBundleVisitor()
Set	getConfigProperties()	Set of ConnectorConfigProperty
Collection<AnnotationInfo>	getConfigPropertyAnnotations(String className)
Set<String>	getConfigPropertyProcessedClasses()
ConnectionDefDescriptor	getConnectionDefinitionByCFType(String type)
ConnectionDefDescriptor	getConnectionDefinitionByCFType(String type, boolean useDefault)
String	getConnectionFactoryImpl()	Deprecated.
String	getConnectionFactoryInterface()	Deprecated.
String	getConnectionImpl()	Deprecated.
String	getConnectionInterface()	Deprecated.
Set<AnnotationInfo>	getConnectorAnnotations()
String	getConnectorDescription()	get the connector description
Collection<String>	getDefaultResourcesNames()	names of default resources created for this resource-adapter computed at runtime (during RAR start) Used while detecting RARs referred by deployed applications
String	getDefaultSpecVersion()
String	getDeployName()	return name used for deployment
String	getEisType()	get eisType
boolean	getInBoundDefined()
InboundResourceAdapter	getInboundResourceAdapter()
LicenseDescriptor	getLicenseDescriptor()
String	getManagedConnectionFactoryImpl()	Deprecated.
ArchiveType	getModuleType()
int	getNumOfSupportedCFs()
boolean	getOutBoundDefined()
OutboundResourceAdapter	getOutboundResourceAdapter()
String	getReauthenticationSupport()	Deprecated.
Set	getRequiredWorkContexts()
String	getResourceAdapterClass()
String	getResourceAdapterVersion()	get value for resourceadapter version (1.5 schema
Set	getSecurityPermissions()	Set of SecurityPermission objects
Set	getServiceReferenceDescriptors()
SunConnector	getSunDescriptor()	This returns the extra ejb sun specific info not in the RI DID.
MessageListener	getSupportedMessageListener(String type)
DescriptorVisitor	getTracerVisitor()
int	getTransactionSupport()	Deprecated.
String	getTransSupport()	Deprecated.
boolean	getValidConnectorAnnotationProcessed()
String	getVendorName()	get value for vendorName
String	getVersion()	get value for version
boolean	hasAdminObjects()
boolean	isEmpty()	Return true if this root deployment descriptor does not describe anything
boolean	isMessageListenerSupported(String type)	Deprecated.
boolean	isSpecVersionSet()	END Deployment Consolidation to Suppport Multiple Deployment API Clients
void	print(StringBuilder toStringBuilder)	A formatted string representing my state.
void	removeAdminObject(AdminObject admin)
boolean	removeAuthMechanism(int mech)	Deprecated.
boolean	removeAuthMechanism(AuthMechanism mech)	Deprecated.
void	removeConfigProperty(ConnectorConfigProperty configProperty)	remove a configProperty from the set
void	removeRequiredWorkContext(String workContextClass)
void	removeSecurityPermission(SecurityPermission permission)	Remove a SecurityPermission object to the set
void	setConnectionFactoryImpl(String connectionFactoryImpl)	Deprecated.
void	setConnectionFactoryInterface(String connectionFactoryInterface)	Deprecated.
void	setConnectionImpl(String connectionImpl)	Deprecated.
void	setConnectionInterface(String connectionInterface)	Deprecated.
void	setConnectorDescription(String description)	set the connector description
void	setEisType(String eisType)	set eisType
void	setInboundResourceAdapter(InboundResourceAdapter inboundRA)
void	setLicenseDescriptor(LicenseDescriptor licenseDescriptor)
void	setManagedConnectionFactoryImpl(String managedConnectionFactoryImpl)	Deprecated.
void	setOutboundResourceAdapter(OutboundResourceAdapter outboundRA)
void	setReauthenticationSupport(boolean reauthenticationSupport)	Deprecated.
void	setReauthenticationSupport(String reauthSupport)	Deprecated.
void	setResourceAdapterClass(String raClass)
void	setResourceAdapterVersion(String resourceAdapterVersion)	set value for resourceadater version (1.5 schema)
void	setSunDescriptor(SunConnector connector)	This sets the extra connector sun specific info not in the RI DID.
void	setTransactionSupport(int transactionSupport)	Deprecated.
void	setTransactionSupport(String support)	Deprecated.
void	setValidConnectorAnnotationProcessed(boolean processed)
void	setVendorName(String vendorName)	set value for vendorName
void	setVersion(String version)	set value for version
boolean	supportsReauthentication()	Deprecated.
void	visit(DescriptorVisitor aVisitor)	visit the descriptor and all sub descriptors with a DOL visitor implementation

Methods inherited from class com.sun.enterprise.deployment.CommonResourceBundleDescriptor

addResourceDescriptor, getAllResourcesDescriptors, getAllResourcesDescriptors, getResourceDescriptor, getResourceDescriptors, removeResourceDescriptor

Methods inherited from class com.sun.enterprise.deployment.BundleDescriptor

addBundleDescriptor, addEntityManagerFactory, addManagedBean, addMessageDestination, addRole, addRole, addRootNode, findDefaultPU, findReferencedPU, findReferencedPUs, findReferencedPUsViaPCRefs, findReferencedPUsViaPURefs, findReferencedPUViaEMFRef, findReferencedPUViaEMRef, getApplication, getClassLoader, getCompatibility, getDeploymentDescriptorDir, getEntityManagerFactories, getEntityManagerFactory, getInjectableResources, getInjectableResourcesByClass, getInjectionInfoByClass, getKeepState, getManagedBeanByBeanClass, getManagedBeans, getMessageDestinationByName, getMessageDestinations, getModuleID, getModuleName, getNamedDescriptorsFrom, getNamedReferencePairsFrom, getPostConstructDescriptorByClass, getPreDestroyDescriptorByClass, getRawModuleID, getRoles, getRootNode, getUniqueFriendlyId, getVisiblePUs, getWebServiceEndpointByName, getWebServices, getWsdlDir, hasManagedBeanByBeanClass, hasMessageDestinationByName, hasWebServiceClients, hasWebServices, isApplication, isDDWithNoAnnotationAllowed, isDefaultGroupPrincipalMapping, isFullAttribute, isFullFlag, isPackagedAsSingleModule, isPolicyModified, isStandalone, removeMessageDestination, removeRole, setApplication, setCompatibility, setDefaultGroupPrincipalMapping, setFullAttribute, setFullFlag, setKeepState, setPolicyModified, visit

Methods inherited from class org.glassfish.deployment.common.RootDeploymentDescriptor

addExtensionDescriptor, getDisplayName, getExtensionsDescriptors, getExtensionsDescriptors, getExtensionsDescriptors, getMainDescriptor, getModuleDescriptor, getName, getSchemaLocation, getSpecVersion, isExtensionDescriptor, setClassLoader, setDisplayName, setModuleDescriptor, setModuleID, setName, setSchemaLocation, setSpecVersion

Methods inherited from class org.glassfish.deployment.common.Descriptor

addDescriptorExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDescriptorExtension, getDescriptorExtensions, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getPrefixMapping, getSmallIconUri, isBoundsChecking, setBoundsChecking, setDescription, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setSmallIconUri

Methods inherited from class org.glassfish.deployment.common.DynamicAttributesDescriptor

addExtraAttribute, getExtraAttribute, getExtraAttributes, removeExtraAttribute, toString

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectorDescriptor

public ConnectorDescriptor()

Method Detail

getRequiredWorkContexts

public Set getRequiredWorkContexts()

addRequiredWorkContext

public void addRequiredWorkContext(String workContextClass)

removeRequiredWorkContext

public void removeRequiredWorkContext(String workContextClass)

getDefaultSpecVersion

public String getDefaultSpecVersion()

Specified by:

getDefaultSpecVersion in class RootDeploymentDescriptor

Returns:

the default version of the deployment descriptor loaded by this descriptor

getConnectionFactoryInterface

public String getConnectionFactoryInterface()

Deprecated.

Returns:

setConnectionFactoryInterface

public void setConnectionFactoryInterface(String connectionFactoryInterface)

Deprecated.

Parameters:

connectionFactoryInterface -

getConnectionFactoryImpl

public String getConnectionFactoryImpl()

Deprecated.

setConnectionFactoryImpl

public void setConnectionFactoryImpl(String connectionFactoryImpl)

Deprecated.

Parameters:

connectionFactoryImpl -

getConnectionInterface

public String getConnectionInterface()

Deprecated.

Returns:

setConnectionInterface

public void setConnectionInterface(String connectionInterface)

Deprecated.

Parameters:

connectionInterface -

getConnectionImpl

public String getConnectionImpl()

Deprecated.

Returns:

setConnectionImpl

public void setConnectionImpl(String connectionImpl)

Deprecated.

Parameters:

connectionImpl -

getManagedConnectionFactoryImpl

public String getManagedConnectionFactoryImpl()

Deprecated.

Returns:

setManagedConnectionFactoryImpl

public void setManagedConnectionFactoryImpl(String managedConnectionFactoryImpl)

Deprecated.

Parameters:

managedConnectionFactoryImpl -

supportsReauthentication

public boolean supportsReauthentication()

Deprecated.

Returns:

getReauthenticationSupport

public String getReauthenticationSupport()

Deprecated.

Returns:

setReauthenticationSupport

public void setReauthenticationSupport(boolean reauthenticationSupport)

Deprecated.

Parameters:

reauthenticationSupport -

setReauthenticationSupport

public void setReauthenticationSupport(String reauthSupport)

Deprecated.

getTransSupport

public String getTransSupport()

Deprecated.

Returns:

getTransactionSupport

public int getTransactionSupport()

Deprecated.

Returns:

setTransactionSupport

public void setTransactionSupport(int transactionSupport)

Deprecated.

Parameters:

transactionSupport -

setTransactionSupport

public void setTransactionSupport(String support)

Deprecated.

Parameters:

support -

getAuthMechanisms

public Set getAuthMechanisms()

Deprecated.

Returns:

getServiceReferenceDescriptors

public Set getServiceReferenceDescriptors()

Returns:

a set of service-ref from this bundle or null if none

getSecurityPermissions

public Set getSecurityPermissions()

Set of SecurityPermission objects

Returns:

addAuthMechanism

public boolean addAuthMechanism(AuthMechanism mech)

Deprecated.

Parameters:

mech -

Returns:

removeAuthMechanism

public boolean removeAuthMechanism(AuthMechanism mech)

Deprecated.

Parameters:

mech -

Returns:

addAuthMechanism

public boolean addAuthMechanism(int mech)

Deprecated.

Parameters:

mech -

Returns:

removeAuthMechanism

public boolean removeAuthMechanism(int mech)

Deprecated.

Parameters:

mech -

Returns:

addSecurityPermission

public void addSecurityPermission(SecurityPermission permission)

Add a SecurityPermission object to the set

Parameters:

permission -

removeSecurityPermission

public void removeSecurityPermission(SecurityPermission permission)

Remove a SecurityPermission object to the set

Parameters:

permission -

getResourceAdapterClass

public String getResourceAdapterClass()

setResourceAdapterClass

public void setResourceAdapterClass(String raClass)

getConfigProperties

public Set getConfigProperties()

Set of ConnectorConfigProperty

Returns:

addConfigProperty

public void addConfigProperty(ConnectorConfigProperty configProperty)

add a configProperty to the set

Parameters:

configProperty -

removeConfigProperty

public void removeConfigProperty(ConnectorConfigProperty configProperty)

remove a configProperty from the set

Parameters:

configProperty -

getLicenseDescriptor

public LicenseDescriptor getLicenseDescriptor()

setLicenseDescriptor

public void setLicenseDescriptor(LicenseDescriptor licenseDescriptor)

getOutboundResourceAdapter

public OutboundResourceAdapter getOutboundResourceAdapter()

setOutboundResourceAdapter

public void setOutboundResourceAdapter(OutboundResourceAdapter outboundRA)

getInboundResourceAdapter

public InboundResourceAdapter getInboundResourceAdapter()

setInboundResourceAdapter

public void setInboundResourceAdapter(InboundResourceAdapter inboundRA)

getAdminObjects

public Set getAdminObjects()

Returns:

admin objects

addAdminObject

public void addAdminObject(AdminObject admin)

set admin object

Parameters:

admin -

removeAdminObject

public void removeAdminObject(AdminObject admin)

hasAdminObjects

public boolean hasAdminObjects()

getOutBoundDefined

public boolean getOutBoundDefined()

getInBoundDefined

public boolean getInBoundDefined()

getConnectorDescription

public String getConnectorDescription()

get the connector description

Returns:

setConnectorDescription

public void setConnectorDescription(String description)

set the connector description

Parameters:

description -

getVendorName

public String getVendorName()

get value for vendorName

Returns:

setVendorName

public void setVendorName(String vendorName)

set value for vendorName

Parameters:

vendorName -

getEisType

public String getEisType()

get eisType

Returns:

setEisType

public void setEisType(String eisType)

set eisType

Parameters:

eisType -

getVersion

public String getVersion()

get value for version

Returns:

setVersion

public void setVersion(String version)

set value for version

Parameters:

version -

getResourceAdapterVersion

public String getResourceAdapterVersion()

get value for resourceadapter version (1.5 schema

Returns:

Since:

1.5

setResourceAdapterVersion

public void setResourceAdapterVersion(String resourceAdapterVersion)

set value for resourceadater version (1.5 schema)

Parameters:

resourceAdapterVersion -

Since:

1.5

getDeployName

public String getDeployName()

return name used for deployment

Returns:

visit

public void visit(DescriptorVisitor aVisitor)

visit the descriptor and all sub descriptors with a DOL visitor implementation

Overrides:

visit in class Descriptor

Parameters:

aVisitor - visitor to traverse the descriptors

getConnectionDefinitionByCFType

public ConnectionDefDescriptor getConnectionDefinitionByCFType(String type)

Parameters:

type - The full qualified name for connection factory interface

Returns:

getConnectionDefinitionByCFType

public ConnectionDefDescriptor getConnectionDefinitionByCFType(String type,
                                                               boolean useDefault)

Parameters:

type - The full qualified name for connection factory interface

useDefault - This param is to support the backward compatibility of connector 1.0 resource adapter where there is only one connection factory type. If type is null and useDefault is true, the only CF will be returned.

Returns:

getNumOfSupportedCFs

public int getNumOfSupportedCFs()

getAdminObject

public AdminObject getAdminObject(String adminObjectInterface,
                                  String adminObjectClass)

getAdminObjectsByType

public List<AdminObject> getAdminObjectsByType(String type)

getAdminObjectsByClass

public List<AdminObject> getAdminObjectsByClass(String adminObjectClass)

print

public void print(StringBuilder toStringBuilder)

A formatted string representing my state.

Overrides:

print in class BundleDescriptor

Parameters:

toStringBuilder -

getModuleType

public ArchiveType getModuleType()

Specified by:

getModuleType in class BundleDescriptor

Returns:

the module type for this bundle descriptor

getTracerVisitor

public DescriptorVisitor getTracerVisitor()

Overrides:

getTracerVisitor in class RootDeploymentDescriptor

Returns:

the tracer visitor for this descriptor

getBundleVisitor

public ComponentVisitor getBundleVisitor()

Overrides:

getBundleVisitor in class BundleDescriptor

Returns:

the visitor for this bundle descriptor

getSupportedMessageListener

public MessageListener getSupportedMessageListener(String type)

Parameters:

type - message listener type

Returns:

isMessageListenerSupported

public boolean isMessageListenerSupported(String type)

Deprecated.

Parameters:

type -

Returns:

isEmpty

public boolean isEmpty()

Description copied from class: RootDeploymentDescriptor

Return true if this root deployment descriptor does not describe anything

Specified by:

isEmpty in class RootDeploymentDescriptor

Returns:

true if this root descriptor is empty

getSunDescriptor

public SunConnector getSunDescriptor()

This returns the extra ejb sun specific info not in the RI DID.

Returns:

object representation of connector deployment descriptor

setSunDescriptor

public void setSunDescriptor(SunConnector connector)

This sets the extra connector sun specific info not in the RI DID.

Parameters:

connector - SunConnector object representation of connector deployment descriptor

isSpecVersionSet

public boolean isSpecVersionSet()

END Deployment Consolidation to Suppport Multiple Deployment API Clients

addConnectorAnnotation

public void addConnectorAnnotation(AnnotationInfo c)

getConnectorAnnotations

public Set<AnnotationInfo> getConnectorAnnotations()

setValidConnectorAnnotationProcessed

public void setValidConnectorAnnotationProcessed(boolean processed)

getValidConnectorAnnotationProcessed

public boolean getValidConnectorAnnotationProcessed()

addConfigPropertyAnnotation

public void addConfigPropertyAnnotation(String className,
                                        AnnotationInfo info)

getConfigPropertyAnnotations

public Collection<AnnotationInfo> getConfigPropertyAnnotations(String className)

getAllConfigPropertyAnnotations

public Map<String,Set<AnnotationInfo>> getAllConfigPropertyAnnotations()

getConfigPropertyProcessedClasses

public Set<String> getConfigPropertyProcessedClasses()

addConfigPropertyProcessedClass

public void addConfigPropertyProcessedClass(String className)

getDefaultResourcesNames

public Collection<String> getDefaultResourcesNames()

names of default resources created for this resource-adapter computed at runtime (during RAR start) Used while detecting RARs referred by deployed applications

Returns:

default resources' names

addDefaultResourceName

public void addDefaultResourceName(String resourceName)

add a default resource to list of default resource names

Parameters:

resourceName - resource-name