001: package com.ibm.webdav;
002:
003: /*
004: * (C) Copyright IBM Corp. 2000 All rights reserved.
005: *
006: * The program is provided "AS IS" without any warranty express or
007: * implied, including the warranty of non-infringement and the implied
008: * warranties of merchantibility and fitness for a particular purpose.
009: * IBM will not be liable for any damages suffered by you as a result
010: * of using the Program. In no event will IBM be liable for any
011: * special, indirect or consequential damages or lost profits even if
012: * IBM has been advised of the possibility of their occurrence. IBM
013: * will not be liable for any third party claims against you.
014: */
015:
016: /** A ResourceContext represents additional information about the resource
017: * that may effect how a method is executed, or reflect information that
018: * is returned from a method execution. It contains two HTTPHeaders object
019: * representing the method request and response Headers. A ResourceContext
020: * also includs a status code which indicates the success or failure of the
021: * method request.
022: * <p>
023: * Values for the request context are set before calling a method of
024: * Resource or Collection, and provide additional parameters for
025: * the method or context in which it is executed. After the method returns,
026: * additional information about the method execution is available in the
027: * context.</p>
028: * <p>
029: * Many of these headers are only used internally by the ResourceHTTPStub
030: * class to marshall arguments between the client and server using the HTTP
031: * protocol. Some of this information can be more conveniently obtained through
032: * the parameters and return values of class Resource.</p>
033: * <p>
034: * @author Jim Amsden <jamsden@us.ibm.com>
035: */
036: public class ResourceContext {
037: protected HTTPHeaders requestContext = new HTTPHeaders();
038: protected HTTPHeaders responseContext = new HTTPHeaders();
039: protected WebDAVStatus statusCode = new WebDAVStatus();
040: protected String methodName = "unknown";
041:
042: /**
043: * Insert the method's description here.
044: * Creation date: (4/14/2000 3:04:10 PM)
045: * @return com.ibm.webdav.HTTPHeaders
046: */
047: public HTTPHeaders getRequestContext() {
048: return requestContext;
049: }
050:
051: /**
052: * Insert the method's description here.
053: * Creation date: (4/14/2000 3:04:10 PM)
054: * @return com.ibm.webdav.HTTPHeaders
055: */
056: public HTTPHeaders getResponseContext() {
057: return responseContext;
058: }
059:
060: /**
061: * Insert the method's description here.
062: * Creation date: (4/14/2000 3:04:10 PM)
063: * @return com.ibm.webdav.WebDAVStatus
064: */
065: public WebDAVStatus getStatusCode() {
066: return statusCode;
067: }
068:
069: public String getMethodName() {
070: return methodName;
071: }
072:
073: /**
074: * Insert the method's description here.
075: * Creation date: (4/14/2000 3:04:10 PM)
076: * @param newRequestContext com.ibm.webdav.HTTPHeaders
077: */
078: public void setRequestContext(HTTPHeaders newRequestContext) {
079: requestContext = newRequestContext;
080: }
081:
082: /**
083: * Insert the method's description here.
084: * Creation date: (4/14/2000 3:04:10 PM)
085: * @param newResponseContext com.ibm.webdav.HTTPHeaders
086: */
087: public void setResponseContext(HTTPHeaders newResponseContext) {
088: responseContext = newResponseContext;
089: }
090:
091: /**
092: * Insert the method's description here.
093: * Creation date: (4/14/2000 3:04:10 PM)
094: * @param newStatusCode com.ibm.webdav.WebDAVStatus
095: */
096: public void setStatusCode(WebDAVStatus newStatusCode) {
097: statusCode = newStatusCode;
098: }
099:
100: public void setMethodName(String newMethodName) {
101: methodName = newMethodName;
102: }
103: }
|