public final class W3CEndpointReferenceBuilder extends Object
W3CEndpointReference
instances. The intended use of this clsss is for
an application component, for example a factory component,
to create an W3CEndpointReference
for a
web service endpoint published by the same
Java EE application. It can also be used to create
W3CEndpointReferences
for an Java SE based
endpoint by providing the address
property.
When creating a W3CEndpointReference
for an
endpoint that is not published by the same Java EE application,
the address
property MUST be specified.
When creating a W3CEndpointReference
for an endpoint
published by the same Java EE application, the address
property MAY be null
but then the serviceName
and endpointName
MUST specify an endpoint published by
the same Java EE application.
When the wsdlDocumentLocation
is specified it MUST refer
to a valid WSDL document and the serviceName
and
endpointName
(if specified) MUST match a service and port
in the WSDL document.
Constructor and Description |
---|
W3CEndpointReferenceBuilder()
Creates a new
W3CEndpointReferenceBuilder instance. |
Modifier and Type | Method and Description |
---|---|
W3CEndpointReferenceBuilder |
address(String address)
Sets the
address to the
W3CEndpointReference instance's
wsa:Address . |
W3CEndpointReferenceBuilder |
attribute(QName name,
String value)
Adds an extension attribute to the
W3CEndpointReference instance's
wsa:EndpointReference element. |
W3CEndpointReference |
build()
Builds a
W3CEndpointReference from the accumulated
properties set on this W3CEndpointReferenceBuilder
instance. |
W3CEndpointReferenceBuilder |
element(Element element)
Adds an extension element to the
W3CEndpointReference instance's
wsa:EndpointReference element. |
W3CEndpointReferenceBuilder |
endpointName(QName endpointName)
Sets the
endpointName as
wsam:ServiceName/@EndpointName in the
wsa:Metadata element. |
W3CEndpointReferenceBuilder |
interfaceName(QName interfaceName)
Sets the
interfaceName as the
wsam:InterfaceName element in the
wsa:Metadata element. |
W3CEndpointReferenceBuilder |
metadata(Element metadataElement)
Adds the
metadataElement to the
W3CEndpointReference instance's
wsa:Metadata element. |
W3CEndpointReferenceBuilder |
referenceParameter(Element referenceParameter)
Adds the
referenceParameter to the
W3CEndpointReference instance
wsa:ReferenceParameters element. |
W3CEndpointReferenceBuilder |
serviceName(QName serviceName)
Sets the
serviceName as the
wsam:ServiceName element in the
wsa:Metadata element. |
W3CEndpointReferenceBuilder |
wsdlDocumentLocation(String wsdlDocumentLocation)
Sets the
wsdlDocumentLocation that will be referenced
as wsa:Metadata/@wsdli:wsdlLocation . |
public W3CEndpointReferenceBuilder()
W3CEndpointReferenceBuilder
instance.public W3CEndpointReferenceBuilder address(String address)
address
to the
W3CEndpointReference
instance's
wsa:Address
.
The address
MUST be set to a non-null
value when building a W3CEndpointReference
for a
web service endpoint that is not published by the same
Java EE application or when running on Java SE.
address
- The address of the endpoint to be targeted
by the returned W3CEndpointReference
.W3CEndpointReferenceBuilder
instance with
the address
set to the wsa:Address
.public W3CEndpointReferenceBuilder interfaceName(QName interfaceName)
interfaceName
as the
wsam:InterfaceName
element in the
wsa:Metadata
element.
See
2.1 Referencing WSDL Metadata from an EPR for more details.interfaceName
- The port type name of the endpoint to be targeted
by the returned W3CEndpointReference
.W3CEndpointReferenceBuilder
instance with
the interfaceName
as wsam:InterfaceName
element added to the wsa:Metadata
elementpublic W3CEndpointReferenceBuilder serviceName(QName serviceName)
serviceName
as the
wsam:ServiceName
element in the
wsa:Metadata
element.
See
2.1 Referencing WSDL Metadata from an EPR for more details.serviceName
- The service name of the endpoint to be targeted
by the returned W3CEndpointReference
. This property
may also be used with the endpointName
(portName)
property to lookup the address
of a web service
endpoint that is published by the same Java EE application.W3CEndpointReferenceBuilder
instance with
the serviceName
as wsam:ServiceName
element added to the wsa:Metadata
elementpublic W3CEndpointReferenceBuilder endpointName(QName endpointName)
endpointName
as
wsam:ServiceName/@EndpointName
in the
wsa:Metadata
element. This method can only be called
after the serviceName(QName)
method has been called.
See 2.1 Referencing WSDL Metadata from an EPR for more details.
endpointName
- The name of the endpoint to be targeted
by the returned W3CEndpointReference
. The
endpointName
(portName) property may also be
used with the serviceName
property to lookup
the address
of a web service
endpoint published by the same Java EE application.W3CEndpointReferenceBuilder
instance with
the endpointName
as
wsam:ServiceName/@EndpointName
in the
wsa:Metadata
element.IllegalStateException
- if the serviceName
has not been setIllegalArgumentException
- if the endpointName
's
Namespace URI doesn't match serviceName
's Namespace URIpublic W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation)
wsdlDocumentLocation
that will be referenced
as wsa:Metadata/@wsdli:wsdlLocation
. The namespace name
for the wsdli:wsdlLocation's value can be taken from the WSDL itself.
See 2.1 Referencing WSDL Metadata from an EPR for more details.
wsdlDocumentLocation
- The location of the WSDL document to
be referenced in the wsa:Metadata
of the
W3CEndpointReference
.W3CEndpointReferenceBuilder
instance with
the wsdlDocumentLocation
that is to be referenced.public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter)
referenceParameter
to the
W3CEndpointReference
instance
wsa:ReferenceParameters
element.referenceParameter
- The element to be added to the
wsa:ReferenceParameters
element.W3CEndpointReferenceBuilder
instance with
the referenceParameter
added to the
wsa:ReferenceParameters
element.IllegalArgumentException
- if referenceParameter
is null
.public W3CEndpointReferenceBuilder metadata(Element metadataElement)
metadataElement
to the
W3CEndpointReference
instance's
wsa:Metadata
element.metadataElement
- The element to be added to the
wsa:Metadata
element.W3CEndpointReferenceBuilder
instance with
the metadataElement
added to the
wsa:Metadata
element.IllegalArgumentException
- if metadataElement
is null
.public W3CEndpointReferenceBuilder element(Element element)
W3CEndpointReference
instance's
wsa:EndpointReference
element.element
- The extension element to be added to the
W3CEndpointReference
W3CEndpointReferenceBuilder
instance with
the extension element
added to the
W3CEndpointReference
instance.IllegalArgumentException
- if element
is null
.public W3CEndpointReferenceBuilder attribute(QName name, String value)
W3CEndpointReference
instance's
wsa:EndpointReference
element.name
- The name of the extension attribute to be added to the
W3CEndpointReference
value
- extension attribute valueW3CEndpointReferenceBuilder
instance with
the extension attribute added to the W3CEndpointReference
instance.IllegalArgumentException
- if name
or value
is null
.public W3CEndpointReference build()
W3CEndpointReference
from the accumulated
properties set on this W3CEndpointReferenceBuilder
instance.
This method can be used to create a W3CEndpointReference
for any endpoint by specifying the address
property along
with any other desired properties. This method
can also be used to create a W3CEndpointReference
for
an endpoint that is published by the same Java EE application.
This method can automatically determine the address
of
an endpoint published by the same Java EE application that is identified by the
serviceName
and
endpointName
properties. If the address
is
null
and the serviceName
and
endpointName
do not identify an endpoint published by the same Java EE application, a
java.lang.IllegalStateException
MUST be thrown.
W3CEndpointReference
from the accumulated
properties set on this W3CEndpointReferenceBuilder
instance. This method never returns null
.IllegalStateException
- address
, serviceName
and
endpointName
are all null
.
serviceName
service is null
and the
endpointName
is NOT null
.
address
property is null
and
the serviceName
and endpointName
do not
specify a valid endpoint published by the same Java EE
application.
serviceName
is NOT null
and is not present in the specified WSDL.
endpointName
port is not null
and it
is not present in serviceName
service in the WSDL.
wsdlDocumentLocation
is NOT null
and does not represent a valid WSDL.
WebServiceException
- If an error occurs while creating the
W3CEndpointReference
.Copyright © 2020 JBoss by Red Hat. All rights reserved.