|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.xml.ws.api.PropertySet
com.sun.xml.ws.transport.http.WSHTTPConnection
com.sun.xml.ws.transport.http.server.ServerConnectionImpl
final class ServerConnectionImpl
WSHTTPConnection
used with Java SE endpoints. It provides connection
implementation using HttpExchange
object.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.sun.xml.ws.api.PropertySet |
---|
PropertySet.Accessor, PropertySet.Property, PropertySet.PropertyMap |
Field Summary |
---|
Fields inherited from class com.sun.xml.ws.transport.http.WSHTTPConnection |
---|
INTERNAL_ERR, MALFORMED_XML, OK, ONEWAY, UNSUPPORTED_MEDIA |
Constructor Summary | |
---|---|
ServerConnectionImpl(HttpAdapter adapter,
com.sun.net.httpserver.HttpExchange httpExchange)
|
Method Summary | |
---|---|
String |
getBaseAddress()
Gets the absolute URL up to the context path. |
String |
getEPRAddress(Packet request,
WSEndpoint endpoint)
Gets the address of the endpoint. |
com.sun.net.httpserver.HttpExchange |
getExchange()
|
InputStream |
getInput()
Transport's underlying input stream. |
OutputStream |
getOutput()
Transport's underlying output stream |
String |
getPathInfo()
Requested path. |
protected PropertySet.PropertyMap |
getPropertyMap()
Map representing the Fields and Methods annotated with PropertySet.Property . |
String |
getProtocol()
Subclasses are expected to override |
String |
getQueryString()
HTTP Query string, such as "foo=bar", or null if none exists. |
String |
getRequestHeader(String headerName)
Gets an HTTP request header. |
Map<String,List<String>> |
getRequestHeaders()
HTTP request headers. |
String |
getRequestMethod()
HTTP request method, such as "GET" or "POST". |
Map<String,List<String>> |
getResponseHeaders()
|
int |
getStatus()
Gets the last value set by WSHTTPConnection.setStatus(int) . |
Principal |
getUserPrincipal(Packet request)
Implements WebServiceContext.getUserPrincipal()
for the given packet. |
WebServiceContextDelegate |
getWebServiceContextDelegate()
Returns the WebServiceContextDelegate for this connection. |
String |
getWSDLAddress(Packet request,
WSEndpoint endpoint)
Gets the address of the primary WSDL. |
boolean |
isSecure()
Whether connection is HTTPS or not |
boolean |
isUserInRole(Packet request,
String role)
Implements WebServiceContext.isUserInRole(String)
for the given packet. |
void |
setContentLengthResponseHeader(int value)
Subclasses are expected to override |
void |
setContentTypeResponseHeader(String value)
Sets the "Content-Type" header. |
void |
setResponseHeaders(Map<String,List<String>> headers)
Overwrites all the HTTP response headers written thus far. |
void |
setStatus(int status)
Sets the HTTP response code like WSHTTPConnection.OK . |
Methods inherited from class com.sun.xml.ws.transport.http.WSHTTPConnection |
---|
close, isClosed |
Methods inherited from class com.sun.xml.ws.api.PropertySet |
---|
containsKey, createMapView, get, parse, put, remove, supports |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ServerConnectionImpl(@NotNull HttpAdapter adapter, @NotNull com.sun.net.httpserver.HttpExchange httpExchange)
Method Detail |
---|
@NotNull public Map<String,List<String>> getRequestHeaders()
WSHTTPConnection
getRequestHeaders
in class WSHTTPConnection
public String getRequestHeader(String headerName)
WSHTTPConnection
if multiple headers are present, this method returns one of them. (The implementation is free to choose which one it returns.)
getRequestHeader
in class WSHTTPConnection
public void setResponseHeaders(Map<String,List<String>> headers)
WSHTTPConnection
The implementation should copy the contents of the Map
,
rather than retaining a reference. The Map
passed as a
parameter may change after this method is invoked.
This method may be called repeatedly, although in normal use case that's rare (so the implementation is encourage to take advantage of this usage pattern to improve performance, if possible.)
Initially, no header is set.
This parameter is usually exposed to WebServiceContext
as Packet.OUTBOUND_TRANSPORT_HEADERS
, and thus it
should ignore Content-Type and Content-Length headers.
setResponseHeaders
in class WSHTTPConnection
headers
- See URLConnection.getHeaderFields()
for the format.
This parameter may not be null, but since the user application
code may invoke this method, a graceful error checking with
an helpful error message should be provided if it's actually null.WSHTTPConnection.setContentTypeResponseHeader(String)
public Map<String,List<String>> getResponseHeaders()
getResponseHeaders
in class WSHTTPConnection
public void setContentTypeResponseHeader(@NotNull String value)
WSHTTPConnection
If the Content-Type header has already been set, this method will overwrite the previously set value. If not, this method adds it.
Note that this method and #setResponseHeaders(Map
may be invoked in any arbitrary order.
setContentTypeResponseHeader
in class WSHTTPConnection
value
- strings like "application/xml; charset=UTF-8" or
"image/jpeg".public void setStatus(int status)
WSHTTPConnection
WSHTTPConnection.OK
.
While JAX-WS processes a WSHTTPConnection
, it
will at least call this method once to set a valid HTTP response code.
Note that this method may be invoked multiple times (from user code),
so do not consider the value to be final until WSHTTPConnection.getOutput()
is invoked.
setStatus
in class WSHTTPConnection
public int getStatus()
WSHTTPConnection
WSHTTPConnection.setStatus(int)
.
getStatus
in class WSHTTPConnection
WSHTTPConnection.setStatus(int)
has not been invoked yet,
return 0.@NotNull public InputStream getInput()
WSHTTPConnection
This method will be invoked at most once by the JAX-WS RI to
read the request body. If there's no request body, this method
should return an empty InputStream
.
getInput
in class WSHTTPConnection
@NotNull public OutputStream getOutput() throws IOException
WSHTTPConnection
This method will be invoked exactly once by the JAX-WS RI to start writing the response body (unless the processing aborts abnormally.) Even if there's no response body to write, this method will still be invoked only to be closed immediately.
Once this method is called, the status code and response
headers will never change (IOW WSHTTPConnection.setStatus(int)
,
WSHTTPConnection.setResponseHeaders(java.util.Map
, and WSHTTPConnection.setContentTypeResponseHeader(String)
will never be invoked.
getOutput
in class WSHTTPConnection
IOException
@NotNull public WebServiceContextDelegate getWebServiceContextDelegate()
WSHTTPConnection
WebServiceContextDelegate
for this connection.
getWebServiceContextDelegate
in class WSHTTPConnection
public Principal getUserPrincipal(Packet request)
WebServiceContextDelegate
WebServiceContext.getUserPrincipal()
for the given packet.
getUserPrincipal
in interface WebServiceContextDelegate
request
- Always non-null. See class javadoc.WebServiceContext.getUserPrincipal()
public boolean isUserInRole(Packet request, String role)
WebServiceContextDelegate
WebServiceContext.isUserInRole(String)
for the given packet.
isUserInRole
in interface WebServiceContextDelegate
request
- Always non-null. See class javadoc.WebServiceContext.isUserInRole(String)
@NotNull public String getEPRAddress(Packet request, WSEndpoint endpoint)
WebServiceContextDelegate
The "address" of endpoints is always affected by a particular client being served, hence it's up to transport to provide this information.
getEPRAddress
in interface WebServiceContextDelegate
request
- Always non-null. See class javadoc.endpoint
- The endpoint whose address will be returned.
WebServiceContext.getEndpointReference(org.w3c.dom.Element...)
public String getWSDLAddress(@NotNull Packet request, @NotNull WSEndpoint endpoint)
WebServiceContextDelegate
If a transport supports publishing of WSDL by itself (instead/in addition to MEX),
then it should implement this method so that the rest of the JAX-WS RI can
use that information.
For example, HTTP transports often use the convention getEPRAddress()+"?wsdl"
for publishing WSDL on HTTP.
Some transports may not have such WSDL publishing mechanism on its own.
Those transports may choose to return null, indicating that WSDL
is not published. If such transports are always used in conjunction with
other transports that support WSDL publishing (such as SOAP/TCP used
with Servlet transport), then such transport may
choose to find the corresponding servlet endpoint by Module.getBoundEndpoints()
and try to obtain the address from there.
This information is used to put a metadata reference inside an EPR, among other things. Clients that do not support MEX rely on this WSDL URL to retrieve metadata, it is desirable for transports to support this, but not mandatory.
This method will be never invoked if the WSEndpoint
does not have a corresponding WSDL to begin with
(IOW returning null
.
getWSDLAddress
in interface WebServiceContextDelegate
request
- Always non-null. See class javadoc.endpoint
- The endpoint whose address will be returned.
public boolean isSecure()
WSHTTPConnection
isSecure
in class WSHTTPConnection
@NotNull public String getRequestMethod()
WSHTTPConnection
getRequestMethod
in class WSHTTPConnection
public String getQueryString()
WSHTTPConnection
getQueryString
in class WSHTTPConnection
public String getPathInfo()
WSHTTPConnection
getPathInfo
in class WSHTTPConnection
public com.sun.net.httpserver.HttpExchange getExchange()
@NotNull public String getBaseAddress()
WSHTTPConnection
getBaseAddress
in class WSHTTPConnection
public String getProtocol()
WSHTTPConnection
getProtocol
in class WSHTTPConnection
public void setContentLengthResponseHeader(int value)
WSHTTPConnection
setContentLengthResponseHeader
in class WSHTTPConnection
protected PropertySet.PropertyMap getPropertyMap()
PropertySet
PropertySet.Property
.
Model of PropertySet
class.
At the end of the derivation chain this method just needs to be implemented as:
private static final PropertyMap model; static { model = parse(MyDerivedClass.class); } protected PropertyMap getPropertyMap() { return model; }
getPropertyMap
in class PropertySet
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |