com.identityx.auth.def.IRequest Maven / Gradle / Ivy

Go to download
/*
* Copyright Daon.
*
* 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 com.identityx.auth.def;

import com.identityx.auth.impl.HttpMethod;
import com.identityx.auth.impl.QueryString;

import java.io.InputStream;
import java.net.URI;

public interface IRequest extends IHttpMessage {

    HttpMethod getMethod();

    /**
     * Returns the request target resource's Uniform Resource Locator location without a query string.  Query
     * string parameters are maintained separately via the {@link #getQueryString() queryString} property.
     * 
     * This URI can be thought of the request fully qualified URL before any question mark indicating query parameters,
     * e.g. the parts in bold only:
     * 
     * https://some.host.com/some/resource/path/here?some=param&another=param.
     * 
     * Any potential question mark itself and anything after it are not included.
     *
     * @return the request target resource's Uniform Resource Locator location without a query string.
     */
    URI getResourceUrl();

    QueryString getQueryString();

    void setQueryString(QueryString queryString);

    void setBody(InputStream body, long length);
}