core/src/main/java/net/oauth/http/HttpResponseMessage.java

/*
 * Copyright 2008 Netflix, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.oauth.http;

import java.io.IOException;
import java.net.URL;
import java.util.Map;

/**
 * An HTTP response.
 * 
 * @author John Kristian
 * @hide
 */
public abstract class HttpResponseMessage extends HttpMessage {

    protected HttpResponseMessage(String method, URL url) {
        super(method, url);
    }

    @Override
    public void dump(Map<String, Object> into) throws IOException {
        super.dump(into);
        into.put(STATUS_CODE, Integer.valueOf(getStatusCode()));
        String location = getHeader(LOCATION);
        if (location != null) {
            into.put(LOCATION, location);
        }
    }

    public abstract int getStatusCode() throws IOException;

    /** The name of a dump entry whose value is the response Location header. */
    public static final String LOCATION = "Location";

    /** The name of a dump entry whose value is the HTTP status code. */
    public static final String STATUS_CODE = "HTTP status";

    /** The statusCode that indicates a normal outcome. */
    public static final int STATUS_OK = 200;

    /** The standard end-of-line marker in an HTTP message. */
    public static final String EOL = "\r\n";

}