Resource.java

/**
 * Copyright (c) 2008-2011 Sonatype, Inc.
 * All rights reserved. Includes the third-party code listed at http://www.sonatype.com/products/nexus/attributions.
 *
 * This program is free software: you can redistribute it and/or modify it only under the terms of the GNU Affero General
 * Public License Version 3 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License Version 3
 * for more details.
 *
 * You should have received a copy of the GNU Affero General Public License Version 3 along with this program.  If not, see
 * http://www.gnu.org/licenses.
 *
 * Sonatype Nexus (TM) Open Source Version is available from Sonatype, Inc. Sonatype and Sonatype Nexus are trademarks of
 * Sonatype, Inc. Apache Maven is a trademark of the Apache Foundation. M2Eclipse is a trademark of the Eclipse Foundation.
 * All other trademarks are the property of their respective owners.
 */
package org.sonatype.gwt.client.resource;

import java.util.Map;

import org.sonatype.gwt.client.request.RESTRequestBuilder;

/**
 * A REST Resource.
 * 
 * @author cstamas
 */
public interface Resource
    extends Uniform
{

    /**
     * Returns the resource URI of this resources.
     * 
     * @return
     */
    String getPath();

    /**
     * Returns the parent of this resource.
     * 
     * @return
     */
    Resource getParent();

    /**
     * Returns the child of this resource.
     * 
     * @param id a single pathelem to form subpath of this resource
     * @return
     */
    Resource getChild( String id );

    /**
     * Returns a resource by relative or absolute path from this resource, depending on the input parameter.
     * 
     * @param path
     * @return
     */
    Resource getResource( String path );

    /**
     * Returns the RESTRequestBuilder used by this resource.
     * 
     * @return
     */
    RESTRequestBuilder getRestRequestBuilder();

    /**
     * Adds a header field to the request
     * 
     * @param name the name of the header
     * @param value the value of the header
     */
    void addHeader( String name, String value );

    /**
     * Merge the given headers to the existing ones. Existing entries will be
     * overwritten with the new values.
     * 
     * @param headers the headers to be added to the existing ones.
     */
    public void addHeaders( Map<String, String> headers );

    /**
     * Get all of the headers
     * 
     * @return the headers
     */
    Map<String, String> getHeaders();

}