SAP NetWeaver '04

com.sapportals.wcm.util.http
Interface IRequest

[contained in: com.sap.netweaver.bc.util.par - bc.util.public_api.jar]
All Known Implementing Classes:
HttpRequest

public interface IRequest

Interface for HTTP request passed on to a IWDRequester, which performs the request. The request has information about the base URL for all requests. As a consequence all URIs used in requests are relative to the base URL.

Copyright (c) SAP AG 2001-2002


Method Summary
 void addHeader(java.lang.String name, java.lang.String value)
          Add header field for request.
 boolean expectsResponseDocument()
           
 boolean expectsResponseStream()
           
 java.lang.String getBody()
           
 java.io.InputStream getBodyStream()
           
 java.lang.String getHeader(java.lang.String name)
           
 java.util.Iterator getHeaderNames()
           
 java.lang.String getMethod()
           
 IUriReference getReference()
           
 java.lang.String getURI()
           
 boolean hasBody()
           
 void setHeader(java.lang.String name, java.lang.String value)
          Set header field for request.
 boolean wasAddedHeader(java.lang.String name)
           
 

Method Detail

getBody

public java.lang.String getBody()
Returns:
the body of the request as string or null

getBodyStream

public java.io.InputStream getBodyStream()
Returns:
the body of the request as input stream or null

getHeader

public java.lang.String getHeader(java.lang.String name)
Parameters:
name - TBD: Description of the incoming method parameter
Returns:
header information for given name (or null).

wasAddedHeader

public boolean wasAddedHeader(java.lang.String name)
Parameters:
name - TBD: Description of the incoming method parameter
Returns:
if header information for name was added (using comma as separator)

getHeaderNames

public java.util.Iterator getHeaderNames()
Returns:
all headers set for the request

getMethod

public java.lang.String getMethod()
Returns:
method of request

getURI

public java.lang.String getURI()
Returns:
URI used for request relative to base URL of requester

getReference

public IUriReference getReference()
Returns:
Uri reference used for request relative to base URL of requester

hasBody

public boolean hasBody()
Returns:
if a body has been set for the request

expectsResponseDocument

public boolean expectsResponseDocument()
Returns:
if the request expects a XML Document in response

expectsResponseStream

public boolean expectsResponseStream()
Returns:
if the request expects an InputStream for the response body

setHeader

public void setHeader(java.lang.String name,
                      java.lang.String value)
Set header field for request. Replaces any existing header information with the same name.
Parameters:
name - name of header field
value - value of header field

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)
Add header field for request. Will keep any existing header information with the same name.
Parameters:
name - name of header field
value - value of header field

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.