WebServiceEndpoint (Deployment Object Library 4.0 API)

java.lang.Object
- java.util.Observable
- - org.glassfish.deployment.common.DynamicAttributesDescriptor
  - - org.glassfish.deployment.common.Descriptor
    - - com.sun.enterprise.deployment.WebServiceEndpoint

All Implemented Interfaces:

HandlerChainContainer, Serializable
```
public class WebServiceEndpoint
extends org.glassfish.deployment.common.Descriptor
implements HandlerChainContainer
```
Represents a single port-component in a webservice in webservices.xml

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLIENT_CERT`
`static String`	`PUBLISHING_SUBCONTEXT`
`static String`	`SOAP11_MTOM_TOKEN`
`static String`	`SOAP11_TOKEN`
`static String`	`SOAP12_MTOM_TOKEN`
`static String`	`SOAP12_TOKEN`
`static String`	`TRANSPORT_CONFIDENTIAL`
`static String`	`TRANSPORT_INTEGRAL`
`static String`	`TRANSPORT_NONE`
`static String`	`XML_TOKEN`

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 and Description

WebServiceEndpoint()

WebServiceEndpoint(WebServiceEndpoint other)

Constructors
Constructor and Description
`WebServiceEndpoint()`
`WebServiceEndpoint(WebServiceEndpoint other)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHandler(WebServiceHandler handler)` Append handler to end of handler chain for this endpoint.
`void`	`addHandlerChain(WebServiceHandlerChain handlerChain)` Append handlerchain to end of handlerchain for this endpoint.
`void`	`addProperty(NameValuePairDescriptor newProp)`
`URL`	`composeEndpointAddress(URL root)` Given the root portion of a URL representing the :: of the webserver, return the endpoint address used to make web service invocations on this endpoint.
`URL`	`composeEndpointAddress(URL root, String contextRoot)`
`URL`	`composeFinalWsdlUrl(URL root)` Generate a URL pointing to the initial wsdl document for this endpoint's web service.
`Addressing`	`getAddressing()`
`String`	`getAuthMethod()`
`BundleDescriptor`	`getBundleDescriptor()`
`String`	`getDebugging()`
`EjbDescriptor`	`getEjbComponentImpl()`
`String`	`getEjbLink()`
`String`	`getEndpointAddressPath()`
`String`	`getEndpointAddressUri()`
`String`	`getEndpointName()`
`LinkedList<WebServiceHandlerChain>`	`getHandlerChain()` Get ordered list of WebServiceHandler handler chains for this endpoint.
`LinkedList`	`getHandlers()` Get ordered list of WebServiceHandler handler for this endpoint.
`String`	`getHttpResponseBufferSize()`
`String`	`getLinkName()`
`MessageSecurityBindingDescriptor`	`getMessageSecurityBinding()`
`String`	`getMtomEnabled()`
`String`	`getMtomThreshold()`
`Iterator`	`getProperties()`
`String`	`getProtocolBinding()`
`String`	`getPublishingUri()` This is the logical equivalent to endpoint address uri, but for url publishing.
`String`	`getRealm()`
`ReliabilityConfig`	`getReliabilityConfig()`
`RespectBinding`	`getRespectBinding()`
`String`	`getServiceEndpointInterface()`
`QName`	`getServiceName()`
`String`	`getServletImplClass()`
`String`	`getSoapAddressPrefix()`
`String`	`getStreamAttachments()`
`String`	`getTieClassName()`
`String`	`getTransportGuarantee()`
`String`	`getValidateRequest()`
`WebComponentDescriptor`	`getWebComponentImpl()`
`String`	`getWebComponentLink()`
`WebService`	`getWebService()`
`String`	`getWsdlContentPath(String requestUri)`
`String`	`getWsdlExposed()`
`QName`	`getWsdlPort()`
`String`	`getWsdlPortNamespacePrefix()`
`QName`	`getWsdlService()`
`String`	`getWsdlServiceNamespacePrefix()`
`boolean`	`hasAuthMethod()`
`boolean`	`hasBasicAuth()`
`boolean`	`hasClientCertAuth()`
`boolean`	`hasEndpointAddressUri()`
`boolean`	`hasHandlerChain()`
`boolean`	`hasHandlers()`
`boolean`	`hasSecurePipeline()`
`boolean`	`hasServiceName()`
`boolean`	`hasServletImplClass()`
`boolean`	`hasTieClassName()`
`boolean`	`hasTransportGuarantee()`
`boolean`	`hasUserSpecifiedProtocolBinding()`
`boolean`	`hasWsdlPort()`
`boolean`	`hasWsdlPortNamespacePrefix()`
`boolean`	`hasWsdlServiceNamespacePrefix()`
`boolean`	`implementedByEjbComponent()`
`boolean`	`implementedByEjbComponent(EjbDescriptor ejb)`
`boolean`	`implementedByWebComponent()`
`boolean`	`implementedByWebComponent(WebComponentDescriptor webComp)`
`boolean`	`isSecure()`
`boolean`	`matchesEjbPublishRequest(String requestUriRaw, String query)` Checks an ejb request uri to see if it represents a legal request for the wsdl content associated with this endpoint's web service.
`void`	`print(StringBuffer toStringBuffer)`
`void`	`removeHandler(WebServiceHandler handler)`
`void`	`removeHandlerByName(String handlerName)`
`void`	`removeHandlerChain(WebServiceHandlerChain handlerChain)`
`boolean`	`resolveComponentLink()` Convert the contents of the ejb-link or servlet-link element to an object representing the implementation component.
`void`	`saveServletImplClass()` Store current contents of servlet impl class in a runtime descriptor element.
`void`	`setAddressing(Addressing addressing)`
`void`	`setAuthMethod(String authType)`
`void`	`setDebugging(String debuggingEnabled)`
`void`	`setEjbComponentImpl(EjbDescriptor ejbComponent)`
`void`	`setEjbLink(String link)`
`void`	`setEndpointAddressUri(String uri)`
`void`	`setEndpointName(String name)`
`void`	`setHttpResponseBufferSize(String httpResponseBufferSize)`
`void`	`setMessageSecurityBinding(MessageSecurityBindingDescriptor messageSecBindingDesc)`
`void`	`setMtomEnabled(String value)`
`void`	`setMtomThreshold(String mtomThreshold)`
`void`	`setProtocolBinding(String value)`
`void`	`setRealm(String realm)`
`void`	`setReliabilityConfig(ReliabilityConfig reliabilityConfig)`
`void`	`setRespectBinding(RespectBinding respectBinding)`
`void`	`setSecurePipeline()`
`void`	`setServiceEndpointInterface(String endpointInterface)`
`void`	`setServiceLocalPart(String localpart)`
`void`	`setServiceNamespaceUri(String uri)`
`void`	`setServletImplClass(String implClass)`
`void`	`setStreamAttachments(String streamAttachments)`
`void`	`setTieClassName(String tieClass)`
`void`	`setTransportGuarantee(String guarantee)`
`void`	`setValidateRequest(String validateRequests)`
`void`	`setWebComponentImpl(WebComponentDescriptor webComponent)`
`void`	`setWebComponentLink(String link)`
`void`	`setWebService(WebService service)`
`void`	`setWsdlExposed(String wsdlExposed)`
`void`	`setWsdlPort(QName port)`
`void`	`setWsdlPort(QName port, String prefix)`
`void`	`setWsdlService(QName service)`
`void`	`setWsdlService(QName svc, String prefix)`

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

Field Detail
- TRANSPORT_NONE
```
public static final String TRANSPORT_NONE
```
  See Also:
  Constant Field Values
- TRANSPORT_INTEGRAL
```
public static final String TRANSPORT_INTEGRAL
```
  See Also:
  Constant Field Values
- TRANSPORT_CONFIDENTIAL
```
public static final String TRANSPORT_CONFIDENTIAL
```
  See Also:
  Constant Field Values
- CLIENT_CERT
```
public static final String CLIENT_CERT
```
  See Also:
  Constant Field Values
- SOAP11_TOKEN
```
public static final String SOAP11_TOKEN
```
  See Also:
  Constant Field Values
- SOAP12_TOKEN
```
public static final String SOAP12_TOKEN
```
  See Also:
  Constant Field Values
- SOAP11_MTOM_TOKEN
```
public static final String SOAP11_MTOM_TOKEN
```
  See Also:
  Constant Field Values
- SOAP12_MTOM_TOKEN
```
public static final String SOAP12_MTOM_TOKEN
```
  See Also:
  Constant Field Values
- XML_TOKEN
```
public static final String XML_TOKEN
```
  See Also:
  Constant Field Values
- PUBLISHING_SUBCONTEXT
```
public static final String PUBLISHING_SUBCONTEXT
```
  See Also:
  Constant Field Values

Constructor Detail

WebServiceEndpoint

public WebServiceEndpoint(WebServiceEndpoint other)

WebServiceEndpoint
```
public WebServiceEndpoint()
```

Method Detail

getWsdlExposed
```
public String getWsdlExposed()
```

setWsdlExposed

public void setWsdlExposed(String wsdlExposed)

getValidateRequest
```
public String getValidateRequest()
```

setValidateRequest

public void setValidateRequest(String validateRequests)

getStreamAttachments
```
public String getStreamAttachments()
```

setStreamAttachments

public void setStreamAttachments(String streamAttachments)

setWebService

public void setWebService(WebService service)

getMtomThreshold
```
public String getMtomThreshold()
```

setMtomThreshold

public void setMtomThreshold(String mtomThreshold)

getWebService
```
public WebService getWebService()
```

getAddressing
```
public Addressing getAddressing()
```

setAddressing

public void setAddressing(Addressing addressing)

getRespectBinding

public RespectBinding getRespectBinding()

setRespectBinding

public void setRespectBinding(RespectBinding respectBinding)

setSecurePipeline
```
public void setSecurePipeline()
```

hasSecurePipeline
```
public boolean hasSecurePipeline()
```

setEndpointName

public void setEndpointName(String name)

getEndpointName
```
public String getEndpointName()
```

setServiceEndpointInterface

public void setServiceEndpointInterface(String endpointInterface)

getServiceEndpointInterface

public String getServiceEndpointInterface()

setProtocolBinding

public void setProtocolBinding(String value)

getProtocolBinding
```
public String getProtocolBinding()
```

hasUserSpecifiedProtocolBinding

public boolean hasUserSpecifiedProtocolBinding()

setMtomEnabled

public void setMtomEnabled(String value)

getMtomEnabled
```
public String getMtomEnabled()
```

setWsdlService

public void setWsdlService(QName svc,
                  String prefix)

setWsdlService

public void setWsdlService(QName service)

getWsdlServiceNamespacePrefix

public String getWsdlServiceNamespacePrefix()

hasWsdlServiceNamespacePrefix

public boolean hasWsdlServiceNamespacePrefix()

getWsdlService
```
public QName getWsdlService()
```

setWsdlPort

public void setWsdlPort(QName port,
               String prefix)

setWsdlPort
```
public void setWsdlPort(QName port)
```

getWsdlPortNamespacePrefix

public String getWsdlPortNamespacePrefix()

hasWsdlPortNamespacePrefix

public boolean hasWsdlPortNamespacePrefix()

hasWsdlPort
```
public boolean hasWsdlPort()
```

getWsdlPort
```
public QName getWsdlPort()
```

setMessageSecurityBinding

public void setMessageSecurityBinding(MessageSecurityBindingDescriptor messageSecBindingDesc)

getMessageSecurityBinding

public MessageSecurityBindingDescriptor getMessageSecurityBinding()

getReliabilityConfig

public ReliabilityConfig getReliabilityConfig()

setReliabilityConfig

public void setReliabilityConfig(ReliabilityConfig reliabilityConfig)

getHttpResponseBufferSize

public String getHttpResponseBufferSize()

setHttpResponseBufferSize

public void setHttpResponseBufferSize(String httpResponseBufferSize)

resolveComponentLink
```
public boolean resolveComponentLink()
```
Convert the contents of the ejb-link or servlet-link element to an object representing the implementation component.

getBundleDescriptor

public BundleDescriptor getBundleDescriptor()

implementedByEjbComponent
```
public boolean implementedByEjbComponent()
```
Returns:
true if this endpoint is implemented by any ejb

implementedByEjbComponent
```
public boolean implementedByEjbComponent(EjbDescriptor ejb)
```
Returns:
true if this endpoint is implemented by a specific ejb

implementedByWebComponent
```
public boolean implementedByWebComponent()
```
Returns:
true if this endpoint is implemented by any web component

implementedByWebComponent
```
public boolean implementedByWebComponent(WebComponentDescriptor webComp)
```
Returns:
true if this endpoint is implemented by a specific web component

getLinkName
```
public String getLinkName()
```

setEjbLink
```
public void setEjbLink(String link)
```

getEjbLink
```
public String getEjbLink()
```

setEjbComponentImpl

public void setEjbComponentImpl(EjbDescriptor ejbComponent)

getEjbComponentImpl

public EjbDescriptor getEjbComponentImpl()

setWebComponentLink

public void setWebComponentLink(String link)

getWebComponentLink
```
public String getWebComponentLink()
```

setWebComponentImpl

public void setWebComponentImpl(WebComponentDescriptor webComponent)

getWebComponentImpl

public WebComponentDescriptor getWebComponentImpl()

hasHandlers
```
public boolean hasHandlers()
```
Returns:
true if this endpoint has at least one handler in its handler chain.

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)

getHandlers
```
public LinkedList getHandlers()
```
Get ordered list of WebServiceHandler handler for this endpoint.

getHandlerChain
```
public LinkedList<WebServiceHandlerChain> getHandlerChain()
```
Get ordered list of WebServiceHandler handler chains for this endpoint.

Specified by:

getHandlerChain in interface HandlerChainContainer

hasHandlerChain
```
public boolean hasHandlerChain()
```
Specified by:

hasHandlerChain in interface HandlerChainContainer

Returns:
true if this endpoint has at least one handler chain

addHandlerChain
```
public void addHandlerChain(WebServiceHandlerChain handlerChain)
```
Append handlerchain to end of handlerchain for this endpoint.

Specified by:

addHandlerChain in interface HandlerChainContainer

removeHandlerChain

public void removeHandlerChain(WebServiceHandlerChain handlerChain)

hasEndpointAddressUri

public boolean hasEndpointAddressUri()

setEndpointAddressUri

public void setEndpointAddressUri(String uri)

getEndpointAddressUri
```
public String getEndpointAddressUri()
```

isSecure
```
public boolean isSecure()
```

composeEndpointAddress
```
public URL composeEndpointAddress(URL root)
                           throws MalformedURLException
```
Given the root portion of a URL representing the :: of the webserver, return the endpoint address used to make web service invocations on this endpoint.

Throws:

MalformedURLException

composeEndpointAddress

public URL composeEndpointAddress(URL root,
                         String contextRoot)
                           throws MalformedURLException

Throws:: MalformedURLException

getEndpointAddressPath

public String getEndpointAddressPath()

composeFinalWsdlUrl
```
public URL composeFinalWsdlUrl(URL root)
                        throws MalformedURLException
```
Generate a URL pointing to the initial wsdl document for this endpoint's web service.

Throws:

MalformedURLException

getPublishingUri
```
public String getPublishingUri()
```
This is the logical equivalent to endpoint address uri, but for url publishing. Like endpoint address uri, it does not include the context root for servlet endpoints.

Returns:
publishing uri without a leading or trailing slash.

matchesEjbPublishRequest
```
public boolean matchesEjbPublishRequest(String requestUriRaw,
                               String query)
```
Checks an ejb request uri to see if it represents a legal request for the wsdl content associated with this endpoint's web service. Equivalent matching for servlets is performed automatically by the web server. Should only be called for HTTP(S) GET.

getWsdlContentPath
```
public String getWsdlContentPath(String requestUri)
```
Returns:
the portion of a request uri that represents the location of wsdl content within a module or null if this request is invalid. Returned value does not have leading slash.

setAuthMethod

public void setAuthMethod(String authType)

getAuthMethod
```
public String getAuthMethod()
```

hasAuthMethod
```
public boolean hasAuthMethod()
```

hasBasicAuth
```
public boolean hasBasicAuth()
```

hasClientCertAuth
```
public boolean hasClientCertAuth()
```

setRealm
```
public void setRealm(String realm)
```

getRealm
```
public String getRealm()
```

setTransportGuarantee

public void setTransportGuarantee(String guarantee)

getTransportGuarantee
```
public String getTransportGuarantee()
```

hasTransportGuarantee

public boolean hasTransportGuarantee()

setServiceNamespaceUri

public void setServiceNamespaceUri(String uri)

setServiceLocalPart

public void setServiceLocalPart(String localpart)

hasServiceName
```
public boolean hasServiceName()
```

getServiceName
```
public QName getServiceName()
```
Returns:
service QName or null if either part of qname is not set

saveServletImplClass
```
public void saveServletImplClass()
```
Store current contents of servlet impl class in a runtime descriptor element. The standard deployment descriptor element will be replaced at deployment time with a container-provided servlet impl, so we need to make a copy of this value in the runtime information.

hasServletImplClass
```
public boolean hasServletImplClass()
```

setServletImplClass

public void setServletImplClass(String implClass)

getServletImplClass
```
public String getServletImplClass()
```

hasTieClassName
```
public boolean hasTieClassName()
```

setTieClassName

public void setTieClassName(String tieClass)

getTieClassName
```
public String getTieClassName()
```

getDebugging
```
public String getDebugging()
```

setDebugging

public void setDebugging(String debuggingEnabled)

addProperty

public void addProperty(NameValuePairDescriptor newProp)

getProperties
```
public Iterator getProperties()
```

getSoapAddressPrefix
```
public String getSoapAddressPrefix()
```

print
```
public void print(StringBuffer toStringBuffer)
```
Overrides:

print in class org.glassfish.deployment.common.Descriptor

Class WebServiceEndpoint

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Field Detail

TRANSPORT_NONE

TRANSPORT_INTEGRAL

TRANSPORT_CONFIDENTIAL

CLIENT_CERT

SOAP11_TOKEN

SOAP12_TOKEN

SOAP11_MTOM_TOKEN

SOAP12_MTOM_TOKEN

XML_TOKEN

PUBLISHING_SUBCONTEXT

Constructor Detail

WebServiceEndpoint

WebServiceEndpoint

Method Detail

getWsdlExposed

setWsdlExposed

getValidateRequest

setValidateRequest

getStreamAttachments

setStreamAttachments

setWebService

getMtomThreshold

setMtomThreshold

getWebService

getAddressing

setAddressing

getRespectBinding

setRespectBinding

setSecurePipeline

hasSecurePipeline

setEndpointName

getEndpointName

setServiceEndpointInterface

getServiceEndpointInterface

setProtocolBinding

getProtocolBinding

hasUserSpecifiedProtocolBinding

setMtomEnabled

getMtomEnabled

setWsdlService

setWsdlService

getWsdlServiceNamespacePrefix

hasWsdlServiceNamespacePrefix

getWsdlService

setWsdlPort

setWsdlPort

getWsdlPortNamespacePrefix

hasWsdlPortNamespacePrefix

hasWsdlPort

getWsdlPort

setMessageSecurityBinding

getMessageSecurityBinding

getReliabilityConfig

setReliabilityConfig

getHttpResponseBufferSize

setHttpResponseBufferSize

resolveComponentLink

getBundleDescriptor

implementedByEjbComponent

implementedByEjbComponent

implementedByWebComponent

implementedByWebComponent

getLinkName

setEjbLink

getEjbLink

setEjbComponentImpl

getEjbComponentImpl

setWebComponentLink

getWebComponentLink

setWebComponentImpl