|
||||||||||
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
public abstract class WSHTTPConnection
The view of an HTTP exchange from the point of view of JAX-WS.
Different HTTP server layer uses different implementations of this class so that JAX-WS can be shielded from individuality of such layers. This is an interface implemented as an abstract class, so that future versions of the JAX-WS RI can add new methods.
This class extends PropertySet
so that a transport can
expose its properties to the appliation and pipes. (This object
will be added to DistributedPropertySet.addSatellite(PropertySet)
.)
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.sun.xml.ws.api.PropertySet |
---|
PropertySet.Accessor, PropertySet.Property, PropertySet.PropertyMap |
Field Summary | |
---|---|
static int |
INTERNAL_ERR
|
static int |
MALFORMED_XML
|
static int |
OK
|
static int |
ONEWAY
|
static int |
UNSUPPORTED_MEDIA
|
Constructor Summary | |
---|---|
WSHTTPConnection()
|
Method Summary | |
---|---|
void |
close()
Close the connection |
String |
getBaseAddress()
Gets the absolute URL up to the context path. |
abstract InputStream |
getInput()
Transport's underlying input stream. |
abstract OutputStream |
getOutput()
Transport's underlying output stream |
abstract String |
getPathInfo()
Requested path. |
String |
getProtocol()
Subclasses are expected to override |
abstract String |
getQueryString()
HTTP Query string, such as "foo=bar", or null if none exists. |
abstract String |
getRequestHeader(String headerName)
Gets an HTTP request header. |
abstract Map<String,List<String>> |
getRequestHeaders()
Deprecated. This is a potentially expensive operation. Programs that want to access HTTP headers should consider using other methods such as getRequestHeader(String) . |
abstract String |
getRequestMethod()
HTTP request method, such as "GET" or "POST". |
abstract Map<String,List<String>> |
getResponseHeaders()
|
abstract int |
getStatus()
Gets the last value set by setStatus(int) . |
abstract WebServiceContextDelegate |
getWebServiceContextDelegate()
Returns the WebServiceContextDelegate for this connection. |
boolean |
isClosed()
Retuns whether connection is closed or not. |
abstract boolean |
isSecure()
Whether connection is HTTPS or not |
void |
setContentLengthResponseHeader(int value)
Subclasses are expected to override |
abstract void |
setContentTypeResponseHeader(String value)
Sets the "Content-Type" header. |
abstract void |
setResponseHeaders(Map<String,List<String>> headers)
Overwrites all the HTTP response headers written thus far. |
abstract void |
setStatus(int status)
Sets the HTTP response code like OK . |
Methods inherited from class com.sun.xml.ws.api.PropertySet |
---|
containsKey, createMapView, get, getPropertyMap, parse, put, remove, supports |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int OK
public static final int ONEWAY
public static final int UNSUPPORTED_MEDIA
public static final int MALFORMED_XML
public static final int INTERNAL_ERR
Constructor Detail |
---|
public WSHTTPConnection()
Method Detail |
---|
public abstract void setResponseHeaders(@NotNull Map<String,List<String>> headers)
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.
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.setContentTypeResponseHeader(String)
public abstract void setContentTypeResponseHeader(@NotNull String value)
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.
value
- strings like "application/xml; charset=UTF-8" or
"image/jpeg".public abstract void setStatus(int status)
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 getOutput()
is invoked.
public abstract int getStatus()
setStatus(int)
.
setStatus(int)
has not been invoked yet,
return 0.@NotNull public abstract InputStream getInput() throws IOException
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
.
IOException
@NotNull public abstract OutputStream getOutput() throws IOException
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 setStatus(int)
,
setResponseHeaders(java.util.Map
, and setContentTypeResponseHeader(String)
will never be invoked.
IOException
@NotNull public abstract WebServiceContextDelegate getWebServiceContextDelegate()
WebServiceContextDelegate
for this connection.
@NotNull public abstract String getRequestMethod()
@NotNull public abstract Map<String,List<String>> getRequestHeaders()
getRequestHeader(String)
.
public abstract Map<String,List<String>> getResponseHeaders()
@Nullable public abstract String getRequestHeader(@NotNull String headerName)
if multiple headers are present, this method returns one of them. (The implementation is free to choose which one it returns.)
@Nullable public abstract String getQueryString()
@Nullable public abstract String getPathInfo()
@NotNull public String getBaseAddress()
public abstract boolean isSecure()
public void close()
public boolean isClosed()
public String getProtocol()
public void setContentLengthResponseHeader(int value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |