jakarta.ws.rs.client.ClientResponseContext Maven / Gradle / Ivy
Show all versions of jakarta.ws.rs-api Show documentation
/*
* Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.ws.rs.client;
import java.io.InputStream;
import java.net.URI;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;
import jakarta.ws.rs.core.EntityTag;
import jakarta.ws.rs.core.Link;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.NewCookie;
import jakarta.ws.rs.core.Response;
/**
* Client response filter context.
*
* A mutable class that provides response-specific information for the filter, such as message headers, message entity
* or request-scoped properties. The exposed setters allow modification of the exposed response-specific information.
*
* @author Marek Potociar
* @since 2.0
*/
public interface ClientResponseContext {
/**
* Get the status code associated with the response.
*
* @return the response status code or -1 if the status was not set.
*/
public int getStatus();
/**
* Set a new response status code.
*
* @param code new status code.
*/
public void setStatus(int code);
/**
* Get the complete status information associated with the response.
*
* @return the response status information or {@code null} if the status was not set.
*/
public Response.StatusType getStatusInfo();
/**
* Set the complete status information (status code and reason phrase) associated with the response.
*
* @param statusInfo the response status information.
*/
public void setStatusInfo(Response.StatusType statusInfo);
/**
* Get the mutable response headers multivalued map.
*
* @return mutable multivalued map of response headers.
* @see #getHeaderString(String)
*/
public MultivaluedMap getHeaders();
/**
* Get a message header as a single string value.
*
* @param name the message header.
* @return the message header value. If the message header is not present then {@code null} is returned. If the message
* header is present but has no value then the empty string is returned. If the message header is present more than once
* then the values of joined together and separated by a ',' character.
* @see #getHeaders()
*/
public String getHeaderString(String name);
/**
* Checks whether a header with a specific name and value (or item of the token-separated value list) exists.
*
*
* For example: {@code containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase)} will return {@code true} if
* a {@code Cache-Control} header exists that has the value {@code no-store}, the value {@code No-Store} or the value
* {@code Max-Age, NO-STORE, no-transform}, but {@code false} when it has the value {@code no-store;no-transform}
* (missing comma), or the value {@code no - store} (whitespace within value).
*
* @param name the message header.
* @param valueSeparatorRegex Regular expression that separates the header value into single values.
* {@code null} does not split.
* @param valuePredicate value must fulfil this predicate.
* @return {@code true} if and only if a header with the given name exists, having either a whitespace-trimmed value
* matching the predicate, or having at least one whitespace-trimmed single value in a token-separated list of single values.
* @see #getHeaders()
* @see #getHeaderString(String)
* @since 4.0
*/
public boolean containsHeaderString(String name, String valueSeparatorRegex, Predicate valuePredicate);
/**
* Checks whether a header with a specific name and value (or item of the comma-separated value list) exists.
*
*
* For example: {@code containsHeaderString("cache-control", "no-store"::equalsIgnoreCase)} will return {@code true} if
* a {@code Cache-Control} header exists that has the value {@code no-store}, the value {@code No-Store} or the value
* {@code Max-Age, NO-STORE, no-transform}, but {@code false} when it has the value {@code no-store;no-transform}
* (missing comma), or the value {@code no - store} (whitespace within value).
*
* @param name the message header.
* @param valuePredicate value must fulfil this predicate.
* @return {@code true} if and only if a header with the given name exists, having either a whitespace-trimmed value
* matching the predicate, or having at least one whitespace-trimmed single value in a comma-separated list of single values.
* @see #getHeaders()
* @see #getHeaderString(String)
* @since 4.0
*/
public default boolean containsHeaderString(String name, Predicate valuePredicate) {
return containsHeaderString(name, ",", valuePredicate);
}
/**
* Get the allowed HTTP methods from the Allow HTTP header.
*
* @return the allowed HTTP methods, all methods will returned as upper case strings.
*/
public Set getAllowedMethods();
/**
* Get message date.
*
* @return the message date, otherwise {@code null} if not present.
*/
public Date getDate();
/**
* Get the language of the entity.
*
* @return the language of the entity or {@code null} if not specified
*/
public Locale getLanguage();
/**
* Get Content-Length value.
*
* @return Content-Length as integer if present and valid number. In other cases returns -1.
*/
public int getLength();
/**
* Get the media type of the entity.
*
* @return the media type or {@code null} if not specified (e.g. there's no response entity).
*/
public MediaType getMediaType();
/**
* Get any new cookies set on the response message.
*
* @return a read-only map of cookie name (String) to a {@link NewCookie new cookie}.
*/
public Map getCookies();
/**
* Get the entity tag.
*
* @return the entity tag, otherwise {@code null} if not present.
*/
public EntityTag getEntityTag();
/**
* Get the last modified date.
*
* @return the last modified date, otherwise {@code null} if not present.
*/
public Date getLastModified();
/**
* Get the location.
*
* @return the location URI, otherwise {@code null} if not present.
*/
public URI getLocation();
/**
* Get the links attached to the message as header.
*
* @return links, may return empty {@link Set} if no links are present. Never returns {@code null}.
*/
public Set getLinks();
/**
* Check if link for relation exists.
*
* @param relation link relation.
* @return {@code true} if the for the relation link exists, {@code false} otherwise.
*/
boolean hasLink(String relation);
/**
* Get the link for the relation.
*
* @param relation link relation.
* @return the link for the relation, otherwise {@code null} if not present.
*/
public Link getLink(String relation);
/**
* Convenience method that returns a {@link jakarta.ws.rs.core.Link.Builder Link.Builder} for the relation.
*
* @param relation link relation.
* @return the link builder for the relation, otherwise {@code null} if not present.
*/
public Link.Builder getLinkBuilder(String relation);
/**
* Check if there is a non-empty entity input stream is available in the response message.
*
* The method returns {@code true} if the entity is present, returns {@code false} otherwise.
*
* @return {@code true} if there is an entity present in the message, {@code false} otherwise.
*/
public boolean hasEntity();
/**
* Get the entity input stream. The JAX-RS runtime is responsible for closing the input stream.
*
* @return entity input stream.
*/
public InputStream getEntityStream();
/**
* Set a new entity input stream. The JAX-RS runtime is responsible for closing the input stream.
*
* @param input new entity input stream.
*/
public void setEntityStream(InputStream input);
}