Package com.sun.enterprise.deployment

Class ServiceReferenceDescriptor

java.lang.Object

java.util.Observable

org.glassfish.deployment.common.DynamicAttributesDescriptor

org.glassfish.deployment.common.Descriptor

com.sun.enterprise.deployment.EnvironmentProperty

com.sun.enterprise.deployment.ServiceReferenceDescriptor

All Implemented Interfaces:

InjectionCapable, ApplicationParam, HandlerChainContainer, ContextParameter, EnvironmentEntry, InitializationParameter, NameValuePair, WebDescriptor, Serializable

public class ServiceReferenceDescriptor
extends EnvironmentProperty
implements HandlerChainContainer

Information about a Jakarta EE web service client.

Author:

Kenneth Saks

See Also:

Serialized Form

Field Summary

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

lookupName

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
ServiceReferenceDescriptor()
ServiceReferenceDescriptor(ServiceReferenceDescriptor other)
ServiceReferenceDescriptor(String name, String description, String service)

Method Summary

Modifier and Type	Method	Description
void	addCallProperty(NameValuePairDescriptor property)	Add call property, using property name as a key.
ServiceRefPortInfo	addContainerManagedPort(String serviceEndpointInterface)
void	addHandler(WebServiceHandler handler)	Append handler to end of handler chain for this endpoint.
void	addHandlerChain(WebServiceHandlerChain handler)	HandlerChain related setters, getters, adders, finders
void	addPortInfo(ServiceRefPortInfo portInfo)
void	addRuntimePortInfo(ServiceRefPortInfo runtimePortInfo)	Special handling of case where runtime port info is added.
boolean	equals(Object object)	Returns true if the argument is an environment property of the same name, false else.
Addressing	getAddressing()
BundleDescriptor	getBundleDescriptor()
Set<NameValuePairDescriptor>	getCallProperties()	Runtime information.
NameValuePairDescriptor	getCallPropertyByName(String name)
LinkedList<WebServiceHandlerChain>	getHandlerChain()
LinkedList<WebServiceHandler>	getHandlers()	Get ordered list of WebServiceHandler handlers for this endpoint.
String	getInjectionTargetType()
String	getMappedName()
File	getMappingFile()
String	getMappingFileUri()
int	getMtomThreshold()
Map<Class<? extends Annotation>,Annotation>	getOtherAnnotations()
ServiceRefPortInfo	getPortInfo(String serviceEndpointInterface)	Lookup port info by service endpoint interface.
ServiceRefPortInfo	getPortInfoByPort(QName wsdlPort)	Lookup port info by wsdl port.
ServiceRefPortInfo	getPortInfoBySEI(String serviceEndpointInterface)	Lookup port info by service endpoint interface.
Set<ServiceRefPortInfo>	getPortsInfo()
RespectBinding	getRespectBinding()
String	getServiceImplClassName()
String	getServiceInterface()
String	getServiceLocalPart()
QName	getServiceName()
String	getServiceNameNamespacePrefix()
String	getServiceNamespaceUri()
String	getWsdlFileUri()
URL	getWsdlFileUrl()
URL	getWsdlOverride()
boolean	hasClientManagedPorts()
boolean	hasContainerManagedPorts()
boolean	hasGeneratedServiceInterface()
boolean	hasGenericServiceInterface()
boolean	hasHandlerChain()
boolean	hasHandlers()
int	hashCode()	The hashCode of an environment property is the same as that of the name String.
boolean	hasMappingFile()
boolean	hasMtomEnabled()
boolean	hasServiceImplClassName()
boolean	hasServiceName()
boolean	hasWsdlFile()
boolean	hasWsdlOverride()
boolean	isAddressingEnabled()
boolean	isAddressingRequired()
boolean	isConflict(ServiceReferenceDescriptor other)
boolean	isMtomEnabled()
boolean	isRespectBindingEnabled()
void	removeCallProperty(NameValuePairDescriptor property)	Remove call property, using property name as a key.
void	removeHandler(WebServiceHandler handler)
void	removeHandlerByName(String handlerName)
void	removeHandlerChain(WebServiceHandlerChain handler)
void	removePortInfo(ServiceRefPortInfo portInfo)
void	setAddressing(Addressing addressing)
void	setBundleDescriptor(BundleDescriptor bundle)
void	setInjectionTargetType(String type)
void	setMappedName(String value)
void	setMappingFile(File file)	Derived, non-peristent location of mapping file.
void	setMappingFileUri(String uri)
void	setMtomEnabled(boolean mtomEnabled)
void	setMtomThreshold(int mtomThreshold)
void	setOtherAnnotations(Map<Class<? extends Annotation>,Annotation> otherAnnotations)
void	setRespectBinding(RespectBinding respectBinding)
void	setServiceImplClassName(String className)
void	setServiceInterface(String service)
void	setServiceLocalPart(String localpart)
void	setServiceName(QName serviceName)
void	setServiceName(QName serviceName, String prefix)
void	setServiceNameNamespacePrefix(String prefix)
void	setServiceNamespaceUri(String uri)
void	setWsdlFileUri(String uri)
void	setWsdlFileUrl(URL url)	Derived, non-peristent location of wsdl file.
void	setWsdlOverride(URL override)

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

addInjectionTarget, getComponentEnvName, getInjectionTargets, getInjectResourceType, getLookupName, getResolvedValue, getResolvedValueObject, getType, getValue, getValueObject, getValueType, hasAValue, hasInjectionTargetFromXml, hasLookupName, isConflict, isConflictResourceGroup, isInjectable, isSetValueCalled, print, printInjectableResourceInfo, setInjectResourceType, setLookupName, setType, setValue

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

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

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sun.enterprise.deployment.web.NameValuePair

getDescription, getName, setDescription, setName

Methods inherited from interface com.sun.enterprise.deployment.web.WebDescriptor

getDescription, getLargeIconUri, getName, getSmallIconUri, setDescription, setLargeIconUri, setName, setSmallIconUri

Constructor Detail

ServiceReferenceDescriptor

public ServiceReferenceDescriptor(ServiceReferenceDescriptor other)

ServiceReferenceDescriptor

public ServiceReferenceDescriptor(String name,
                                  String description,
                                  String service)

ServiceReferenceDescriptor

public ServiceReferenceDescriptor()

Method Detail

getOtherAnnotations

public Map<Class<? extends Annotation>,Annotation> getOtherAnnotations()

setOtherAnnotations

public void setOtherAnnotations(Map<Class<? extends Annotation>,Annotation> otherAnnotations)

isRespectBindingEnabled

public boolean isRespectBindingEnabled()

getAddressing

public Addressing getAddressing()

getRespectBinding

public RespectBinding getRespectBinding()

setRespectBinding

public void setRespectBinding(RespectBinding respectBinding)

hasMtomEnabled

public boolean hasMtomEnabled()

isMtomEnabled

public boolean isMtomEnabled()

setMtomEnabled

public void setMtomEnabled(boolean mtomEnabled)

isAddressingEnabled

public boolean isAddressingEnabled()

setAddressing

public void setAddressing(Addressing addressing)

isAddressingRequired

public boolean isAddressingRequired()

getMtomThreshold

public int getMtomThreshold()

setMtomThreshold

public void setMtomThreshold(int mtomThreshold)

getMappedName

public String getMappedName()

Overrides:

getMappedName in class EnvironmentProperty

Returns:

the mapped name or an empty string if not set

setMappedName

public void setMappedName(String value)

Overrides:

setMappedName in class EnvironmentProperty

setBundleDescriptor

public void setBundleDescriptor(BundleDescriptor bundle)

getBundleDescriptor

public BundleDescriptor getBundleDescriptor()

hasGenericServiceInterface

public boolean hasGenericServiceInterface()

hasGeneratedServiceInterface

public boolean hasGeneratedServiceInterface()

setServiceInterface

public void setServiceInterface(String service)

getServiceInterface

public String getServiceInterface()

hasWsdlFile

public boolean hasWsdlFile()

setWsdlFileUrl

public void setWsdlFileUrl(URL url)

Derived, non-peristent location of wsdl file. Only used at deployment/runtime.

getWsdlFileUrl

public URL getWsdlFileUrl()

setWsdlFileUri

public void setWsdlFileUri(String uri)

getWsdlFileUri

public String getWsdlFileUri()

hasMappingFile

public boolean hasMappingFile()

setMappingFile

public void setMappingFile(File file)

Derived, non-peristent location of mapping file. Only used at deployment/runtime.

getMappingFile

public File getMappingFile()

setMappingFileUri

public void setMappingFileUri(String uri)

getMappingFileUri

public String getMappingFileUri()

setServiceName

public void setServiceName(QName serviceName)

setServiceName

public void setServiceName(QName serviceName,
                           String prefix)

setServiceNamespaceUri

public void setServiceNamespaceUri(String uri)

getServiceNamespaceUri

public String getServiceNamespaceUri()

setServiceLocalPart

public void setServiceLocalPart(String localpart)

getServiceLocalPart

public String getServiceLocalPart()

setServiceNameNamespacePrefix

public void setServiceNameNamespacePrefix(String prefix)

getServiceNameNamespacePrefix

public String getServiceNameNamespacePrefix()

hasServiceName

public boolean hasServiceName()

getServiceName

public QName getServiceName()

Returns:

service QName or null if either part of qname is not set

getPortsInfo

public Set<ServiceRefPortInfo> getPortsInfo()

addPortInfo

public void addPortInfo(ServiceRefPortInfo portInfo)

removePortInfo

public void removePortInfo(ServiceRefPortInfo portInfo)

addRuntimePortInfo

public void addRuntimePortInfo(ServiceRefPortInfo runtimePortInfo)

Special handling of case where runtime port info is added. Ensures that port info is not duplicated when multiple runtime info instances are parsed using same standard descriptor.

addContainerManagedPort

public ServiceRefPortInfo addContainerManagedPort(String serviceEndpointInterface)

hasContainerManagedPorts

public boolean hasContainerManagedPorts()

hasClientManagedPorts

public boolean hasClientManagedPorts()

getPortInfo

public ServiceRefPortInfo getPortInfo(String serviceEndpointInterface)

Lookup port info by service endpoint interface.

getPortInfoBySEI

public ServiceRefPortInfo getPortInfoBySEI(String serviceEndpointInterface)

Lookup port info by service endpoint interface.

getPortInfoByPort

public ServiceRefPortInfo getPortInfoByPort(QName wsdlPort)

Lookup port info by wsdl port.

addHandler

public void addHandler(WebServiceHandler handler)

Append handler to end of handler chain for this endpoint.

removeHandler

public void removeHandler(WebServiceHandler handler)

removeHandlerByName

public void removeHandlerByName(String handlerName)

hasHandlers

public boolean hasHandlers()

getHandlers

public LinkedList<WebServiceHandler> getHandlers()

Get ordered list of WebServiceHandler handlers for this endpoint.

addHandlerChain

public void addHandlerChain(WebServiceHandlerChain handler)

HandlerChain related setters, getters, adders, finders

Specified by:

addHandlerChain in interface HandlerChainContainer

removeHandlerChain

public void removeHandlerChain(WebServiceHandlerChain handler)

hasHandlerChain

public boolean hasHandlerChain()

Specified by:

hasHandlerChain in interface HandlerChainContainer

getHandlerChain

public LinkedList<WebServiceHandlerChain> getHandlerChain()

Specified by:

getHandlerChain in interface HandlerChainContainer

getCallProperties

public Set<NameValuePairDescriptor> getCallProperties()

Runtime information.

getCallPropertyByName

public NameValuePairDescriptor getCallPropertyByName(String name)

addCallProperty

public void addCallProperty(NameValuePairDescriptor property)

Add call property, using property name as a key. This will replace the property value of any existing stub property with the same name.

removeCallProperty

public void removeCallProperty(NameValuePairDescriptor property)

Remove call property, using property name as a key. This will remove the property value of an existing stub property with the matching name.

hasServiceImplClassName

public boolean hasServiceImplClassName()

setServiceImplClassName

public void setServiceImplClassName(String className)

getServiceImplClassName

public String getServiceImplClassName()

hasWsdlOverride

public boolean hasWsdlOverride()

setWsdlOverride

public void setWsdlOverride(URL override)

getWsdlOverride

public URL getWsdlOverride()

setInjectionTargetType

public void setInjectionTargetType(String type)

getInjectionTargetType

public String getInjectionTargetType()

equals

public boolean equals(Object object)

Description copied from class: EnvironmentProperty

Returns true if the argument is an environment property of the same name, false else.

Overrides:

equals in class EnvironmentProperty

hashCode

public int hashCode()

Description copied from class: EnvironmentProperty

The hashCode of an environment property is the same as that of the name String.

Overrides:

hashCode in class EnvironmentProperty

isConflict

public boolean isConflict(ServiceReferenceDescriptor other)