http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/build.properties ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/build.properties b/com.ibm.team.juno.client/build.properties index e6fbc0e..fec46c9 100755 --- a/com.ibm.team.juno.client/build.properties +++ b/com.ibm.team.juno.client/build.properties @@ -1,15 +1,18 @@ -############################################################################### -# -# Licensed Materials - Property of IBM -# (c) Copyright IBM Corporation 2014. All Rights Reserved. -# -# Note to U.S. Government Users Restricted Rights: -# Use, duplication or disclosure restricted by GSA ADP Schedule -# Contract with IBM Corp. -# -############################################################################### -source.. = src/ -output.. = bin/ +# *************************************************************************************************************************** +# * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file +# * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file +# * to you 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. +# * +# *************************************************************************************************************************** +source.. = src/main/java/ +output.. = target/classes bin.includes = META-INF/,\ .,\ OSGI-INF/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/AllowAllRedirects.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/AllowAllRedirects.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/AllowAllRedirects.java deleted file mode 100755 index 7f68ef0..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/AllowAllRedirects.java +++ /dev/null @@ -1,27 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2014, 2015. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import org.apache.http.impl.client.*; - -/** - * Redirect strategy that allows for redirects on any request type, not just <code>GET</code> or <code>HEAD</code>. - * <p> - * Note: This class is similar to <code>org.apache.http.impl.client.LaxRedirectStrategy</code> - * in Apache HttpClient 4.2, but also allows for redirects on <code>PUTs</code> and <code>DELETEs</code>. - * - * @author James Bognar ([email protected]) - */ -public class AllowAllRedirects extends DefaultRedirectStrategy { - - @Override /* DefaultRedirectStrategy */ - protected boolean isRedirectable(final String method) { - return true; - } -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/DateHeader.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/DateHeader.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/DateHeader.java deleted file mode 100755 index 47247d5..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/DateHeader.java +++ /dev/null @@ -1,39 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2014. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import java.util.*; - -import org.apache.http.client.utils.*; -import org.apache.http.message.*; - -/** - * Convenience class for setting date headers in RFC2616 format. - * <p> - * Equivalent to the following code: - * <p class='bcode'> - * Header h = <jk>new</jk> Header(name, DateUtils.<jsm>formatDate</jsm>(value)); - * </p> - * - * @author James Bognar ([email protected]) - */ -public final class DateHeader extends BasicHeader { - - private static final long serialVersionUID = 1L; - - /** - * Creates a date request property in RFC2616 format. - * - * @param name The header name. - * @param value The header value. - */ - public DateHeader(String name, Date value) { - super(name, DateUtils.formatDate(value)); - } -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/HttpMethod.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/HttpMethod.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/HttpMethod.java deleted file mode 100755 index 773ada1..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/HttpMethod.java +++ /dev/null @@ -1,60 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2015. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -/** - * Enumeration of HTTP methods. - * <p> - * - * @author James Bognar ([email protected]) - */ -public enum HttpMethod { - - /** HTTP GET */ - GET(false), - - /** HTTP PUT */ - PUT(true), - - /** HTTP POST */ - POST(true), - - /** HTTP DELETE */ - DELETE(false), - - /** HTTP OPTIONS */ - OPTIONS(false), - - /** HTTP HEAD */ - HEAD(false), - - /** HTTP TRACE */ - TRACE(false), - - /** HTTP CONNECT */ - CONNECT(false), - - /** HTTP MOVE */ - MOVE(false); - - private boolean hasContent; - - HttpMethod(boolean hasContent) { - this.hasContent = hasContent; - } - - /** - * Returns whether this HTTP method normally has content. - * - * @return <jk>true</jk> if this HTTP method normally has content. - */ - public boolean hasContent() { - return hasContent; - } -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/NameValuePairs.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/NameValuePairs.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/NameValuePairs.java deleted file mode 100755 index 9e6e65b..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/NameValuePairs.java +++ /dev/null @@ -1,44 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2014, 2015. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import java.util.*; - -import org.apache.http.*; -import org.apache.http.client.entity.*; - -/** - * Convenience class for constructing instances of <code>List<NameValuePair></code> - * for the {@link UrlEncodedFormEntity} class. - * - * <h6 class='topic'>Example</h6> - * <p class='bcode'> - * NameValuePairs params = <jk>new</jk> NameValuePairs() - * .append(<jk>new</jk> BasicNameValuePair(<js>"j_username"</js>, user)) - * .append(<jk>new</jk> BasicNameValuePair(<js>"j_password"</js>, pw)); - * request.setEntity(<jk>new</jk> UrlEncodedFormEntity(params)); - * </p> - * - * @author James Bognar ([email protected]) - */ -public final class NameValuePairs extends LinkedList<NameValuePair> { - - private static final long serialVersionUID = 1L; - - /** - * Appends the specified pair to the end of this list. - * - * @param pair The pair to append to this list. - * @return This object (for method chaining). - */ - public NameValuePairs append(NameValuePair pair) { - super.add(pair); - return this; - } -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/ResponsePattern.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/ResponsePattern.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/ResponsePattern.java deleted file mode 100755 index a10e939..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/ResponsePattern.java +++ /dev/null @@ -1,134 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2015. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import java.io.*; -import java.util.regex.*; - -/** - * Used to find regular expression matches in REST responses made through {@link RestCall}. - * <p> - * Response patterns are applied to REST calls through the {@link RestCall#addResponsePattern(ResponsePattern)} method. - * <p> - * <h6 class='topic'>Example</h6> - * This example shows how to use a response pattern finder to find and capture patterns for <js>"x=number"</js> and <js>"y=string"</js> - * from a response body. - * <p> - * <p class='bcode'> - * <jk>final</jk> List<Number> xList = <jk>new</jk> ArrayList<Number>(); - * <jk>final</jk> List<String> yList = <jk>new</jk> ArrayList<String>(); - * - * restClient.doGet(<jsf>URL</jsf>) - * .addResponsePattern( - * <jk>new</jk> ResponsePattern(<js>"x=(\\d+)"</js>) { - * <ja>@Override</ja> - * <jk>public void</jk> onMatch(RestCall restCall, Matcher m) <jk>throws</jk> RestCallException { - * xList.add(Integer.<jsm>parseInt</jsm>(m.group(1))); - * } - * <ja>@Override</ja> - * <jk>public void</jk> onNoMatch(RestCall restCall) <jk>throws</jk> RestCallException { - * <jk>throw new</jk> RestCallException(<js>"No X's found!"</js>); - * } - * } - * ) - * .addResponsePattern( - * <jk>new</jk> ResponsePattern(<js>"y=(\\S+)"</js>) { - * <ja>@Override</ja> - * <jk>public void</jk> onMatch(RestCall restCall, Matcher m) <jk>throws</jk> RestCallException { - * yList.add(m.group(1)); - * } - * <ja>@Override</ja> - * <jk>public void</jk> onNoMatch(RestCall restCall) <jk>throws</jk> RestCallException { - * <jk>throw new</jk> RestCallException(<js>"No Y's found!"</js>); - * } - * } - * ) - * .run(); - * </p> - * <p> - * <h5 class='notes'>Important Notes:</h5> - * <ol class='notes'> - * <li><p> - * Using response patterns does not affect the functionality of any of the other methods - * used to retrieve the response such as {@link RestCall#getResponseAsString()} or {@link RestCall#getResponse(Class)}.<br> - * HOWEVER, if you want to retrieve the entire text of the response from inside the match methods, - * use {@link RestCall#getCapturedResponse()} since this method will not absorb the response for those other methods. - * </p> - * <li><p> - * Response pattern methods are NOT executed if a REST exception occurs during the request. - * </p> - * <li><p> - * The {@link RestCall#successPattern(String)} and {@link RestCall#failurePattern(String)} methods use instances of - * this class to throw {@link RestCallException RestCallExceptions} when success patterns are not found or failure patterns - * are found. - * </p> - * <li><p> - * {@link ResponsePattern} objects are reusable and thread-safe. - * </p> - * </ol> - * - * @author James Bognar ([email protected]) - */ -public abstract class ResponsePattern { - - private Pattern pattern; - - /** - * Constructor. - * - * @param pattern Regular expression pattern. - */ - public ResponsePattern(String pattern) { - this.pattern = Pattern.compile(pattern); - } - - void match(RestCall rc) throws RestCallException { - try { - Matcher m = pattern.matcher(rc.getCapturedResponse()); - boolean found = false; - while (m.find()) { - onMatch(rc, m); - found = true; - } - if (! found) - onNoMatch(rc); - } catch (IOException e) { - throw new RestCallException(e); - } - } - - /** - * Returns the pattern passed in through the constructor. - * - * @return The pattern passed in through the constructor. - */ - protected String getPattern() { - return pattern.pattern(); - } - - /** - * Instances can override this method to handle when a regular expression pattern matches - * on the output. - * <p> - * This method is called once for every pattern match that occurs in the response text. - * - * @param rc The {@link RestCall} that this pattern finder is being used on. - * @param m The regular expression {@link Matcher}. Can be used to retrieve group matches in the pattern. - * @throws RestCallException Instances can throw an exception if a failure condition is detected. - */ - public void onMatch(RestCall rc, Matcher m) throws RestCallException {} - - /** - * Instances can override this method to handle when a regular expression pattern doesn't match on the output. - * - * @param rc The {@link RestCall} that this pattern finder is being used on. - * @throws RestCallException Instances can throw an exception if a failure condition is detected. - */ - public void onNoMatch(RestCall rc) throws RestCallException {} -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCall.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCall.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCall.java deleted file mode 100755 index b743965..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCall.java +++ /dev/null @@ -1,944 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2014, 2016. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import java.io.*; -import java.net.*; -import java.util.*; -import java.util.logging.*; -import java.util.regex.*; - -import org.apache.http.*; -import org.apache.http.client.*; -import org.apache.http.client.config.*; -import org.apache.http.client.methods.*; -import org.apache.http.impl.client.*; -import org.apache.http.util.*; - -import com.ibm.juno.core.*; -import com.ibm.juno.core.encoders.*; -import com.ibm.juno.core.parser.*; -import com.ibm.juno.core.parser.ParseException; -import com.ibm.juno.core.serializer.*; -import com.ibm.juno.core.utils.*; - -/** - * Represents a connection to a remote REST resource. - * <p> - * Instances of this class are created by the various {@code doX()} methods on the {@link RestClient} class. - * <p> - * This class uses only Java standard APIs. Requests can be built up using a fluent interface with method chaining, like so... - * - * <p class='bcode'> - * RestClient client = <jk>new</jk> RestClient(); - * RestCall c = client.doPost(<jsf>URL</jsf>).setInput(o).setHeader(x,y); - * MyBean b = c.getResponse(MyBean.<jk>class</jk>); - * </p> - * <p> - * The actual connection and request/response transaction occurs when calling one of the <code>getResponseXXX()</code> methods. - * - * <h6 class='topic'>Additional Information</h6> - * <ul> - * <li><a class='doclink' href='package-summary.html#RestClient'>com.ibm.juno.client > REST client API</a> for more information and code examples. - * </ul> - * - * @author James Bognar ([email protected]) - */ -public final class RestCall { - - private final RestClient client; // The client that created this call. - private final HttpRequestBase request; // The request. - private HttpResponse response; // The response. - private List<RestCallInterceptor> interceptors = new ArrayList<RestCallInterceptor>(); // Used for intercepting and altering requests. - - private boolean isConnected = false; // connect() has been called. - private boolean allowRedirectsOnPosts; - private int retries = 1; - private int redirectOnPostsTries = 5; - private long retryInterval = -1; - private RetryOn retryOn = RetryOn.DEFAULT; - private boolean ignoreErrors; - private boolean byLines = false; - private TeeWriter writers = new TeeWriter(); - private StringWriter capturedResponseWriter; - private String capturedResponse; - private TeeOutputStream outputStreams = new TeeOutputStream(); - private boolean isClosed = false; - private boolean isFailed = false; - - /** - * Constructs a REST call with the specified method name. - * - * @param client The client that created this request. - * @param request The wrapped Apache HTTP client request object. - * @throws RestCallException If an exception or non-200 response code occurred during the connection attempt. - */ - protected RestCall(RestClient client, HttpRequestBase request) throws RestCallException { - this.client = client; - this.request = request; - for (RestCallInterceptor i : this.client.interceptors) - addInterceptor(i); - } - - /** - * Sets the input for this REST call. - * - * @param input The input to be sent to the REST resource (only valid for PUT and POST) requests. <br> - * Can be of the following types: - * <ul> - * <li>{@link Reader} - Raw contents of {@code Reader} will be serialized to remote resource. - * <li>{@link InputStream} - Raw contents of {@code InputStream} will be serialized to remote resource. - * <li>{@link Object} - POJO to be converted to text using the {@link Serializer} registered with the {@link RestClient}. - * <li>{@link HttpEntity} - Bypass Juno serialization and pass HttpEntity directly to HttpClient. - * </ul> - * @return This object (for method chaining). - * @throws RestCallException If a retry was attempted, but the entity was not repeatable. - */ - public RestCall setInput(final Object input) throws RestCallException { - if (! (request instanceof HttpEntityEnclosingRequestBase)) - throw new RestCallException(0, "Method does not support content entity.", request.getMethod(), request.getURI(), null); - HttpEntity entity = (input instanceof HttpEntity ? (HttpEntity)input : new RestRequestEntity(input, client.serializer)); - ((HttpEntityEnclosingRequestBase)request).setEntity(entity); - if (retries > 1 && ! entity.isRepeatable()) - throw new RestCallException("Rest call set to retryable, but entity is not repeatable."); - return this; - } - - /** - * Convenience method for setting a header value on the request. - * <p> - * Equivalent to calling <code>restCall.getRequest().setHeader(name, value.toString())</code>. - * - * @param name The header name. - * @param value The header value. - * @return This object (for method chaining). - */ - public RestCall setHeader(String name, Object value) { - request.setHeader(name, value.toString()); - return this; - } - - /** - * Make this call retryable if an error response (>=400) is received. - * - * @param retries The number of retries to attempt. - * @param interval The time in milliseconds between attempts. - * @param retryOn Optional object used for determining whether a retry should be attempted. - * If <jk>null</jk>, uses {@link RetryOn#DEFAULT}. - * @return This object (for method chaining). - * @throws RestCallException If current entity is not repeatable. - */ - public RestCall setRetryable(int retries, long interval, RetryOn retryOn) throws RestCallException { - if (request instanceof HttpEntityEnclosingRequestBase) { - HttpEntity e = ((HttpEntityEnclosingRequestBase)request).getEntity(); - if (e != null && ! e.isRepeatable()) - throw new RestCallException("Attempt to make call retryable, but entity is not repeatable."); - } - this.retries = retries; - this.retryInterval = interval; - this.retryOn = (retryOn == null ? RetryOn.DEFAULT : retryOn); - return this; - - } - - /** - * For this call, allow automatic redirects when a 302 or 307 occurs when - * performing a POST. - * <p> - * Note that this can be inefficient since the POST body needs to be serialized - * twice. - * The preferred approach if possible is to use the {@link LaxRedirectStrategy} strategy - * on the underlying HTTP client. However, this method is provided if you don't - * have access to the underlying client. - * - * @param b Redirect flag. - * @return This object (for method chaining). - */ - public RestCall allowRedirectsOnPosts(boolean b) { - this.allowRedirectsOnPosts = b; - return this; - } - - /** - * Specify the number of redirects to follow before throwing an exception. - * - * @param maxAttempts Allow a redirect to occur this number of times. - * @return This object (for method chaining). - */ - public RestCall setRedirectMaxAttempts(int maxAttempts) { - this.redirectOnPostsTries = maxAttempts; - return this; - } - - /** - * Add an interceptor for this call only. - * - * @param interceptor The interceptor to add to this call. - * @return This object (for method chaining). - */ - public RestCall addInterceptor(RestCallInterceptor interceptor) { - interceptors.add(interceptor); - interceptor.onInit(this); - return this; - } - - /** - * Pipes the request output to the specified writer when {@link #run()} is called. - * <p> - * The writer is not closed. - * <p> - * This method can be called multiple times to pipe to multiple writers. - * - * @param w The writer to pipe the output to. - * @return This object (for method chaining). - */ - public RestCall pipeTo(Writer w) { - return pipeTo(w, false); - } - - /** - * Pipe output from response to the specified writer when {@link #run()} is called. - * <p> - * This method can be called multiple times to pipe to multiple writers. - * - * @param w The writer to write the output to. - * @param close Close the writer when {@link #close()} is called. - * @return This object (for method chaining). - */ - public RestCall pipeTo(Writer w, boolean close) { - return pipeTo(null, w, close); - } - - /** - * Pipe output from response to the specified writer when {@link #run()} is called and associate - * that writer with an ID so it can be retrieved through {@link #getWriter(String)}. - * <p> - * This method can be called multiple times to pipe to multiple writers. - * - * @param id A string identifier that can be used to retrieve the writer using {@link #getWriter(String)} - * @param w The writer to write the output to. - * @param close Close the writer when {@link #close()} is called. - * @return This object (for method chaining). - */ - public RestCall pipeTo(String id, Writer w, boolean close) { - writers.add(id, w, close); - return this; - } - - /** - * Retrieves a writer associated with an ID via {@link #pipeTo(String, Writer, boolean)} - * - * @param id A string identifier that can be used to retrieve the writer using {@link #getWriter(String)} - * @return The writer, or <jk>null</jk> if no writer is associated with that ID. - */ - public Writer getWriter(String id) { - return writers.getWriter(id); - } - - /** - * When output is piped to writers, flush the writers after every line of output. - * - * @return This object (for method chaining). - */ - public RestCall byLines() { - this.byLines = true; - return this; - } - - /** - * Pipes the request output to the specified output stream when {@link #run()} is called. - * <p> - * The output stream is not closed. - * <p> - * This method can be called multiple times to pipe to multiple output streams. - * - * @param os The output stream to pipe the output to. - * @return This object (for method chaining). - */ - public RestCall pipeTo(OutputStream os) { - return pipeTo(os, false); - } - - /** - * Pipe output from response to the specified output stream when {@link #run()} is called. - * <p> - * This method can be called multiple times to pipe to multiple output stream. - * - * @param os The output stream to write the output to. - * @param close Close the output stream when {@link #close()} is called. - * @return This object (for method chaining). - */ - public RestCall pipeTo(OutputStream os, boolean close) { - return pipeTo(null, os, close); - } - - /** - * Pipe output from response to the specified output stream when {@link #run()} is called and associate - * that output stream with an ID so it can be retrieved through {@link #getOutputStream(String)}. - * <p> - * This method can be called multiple times to pipe to multiple output stream. - * - * @param id A string identifier that can be used to retrieve the output stream using {@link #getOutputStream(String)} - * @param os The output stream to write the output to. - * @param close Close the output stream when {@link #close()} is called. - * @return This object (for method chaining). - */ - public RestCall pipeTo(String id, OutputStream os, boolean close) { - outputStreams.add(id, os, close); - return this; - } - - /** - * Retrieves an output stream associated with an ID via {@link #pipeTo(String, OutputStream, boolean)} - * - * @param id A string identifier that can be used to retrieve the writer using {@link #getWriter(String)} - * @return The writer, or <jk>null</jk> if no writer is associated with that ID. - */ - public OutputStream getOutputStream(String id) { - return outputStreams.getOutputStream(id); - } - - /** - * Prevent {@link RestCallException RestCallExceptions} from being thrown when HTTP status 400+ is encountered. - * @return This object (for method chaining). - */ - public RestCall ignoreErrors() { - this.ignoreErrors = true; - return this; - } - - /** - * Stores the response text so that it can later be captured using {@link #getCapturedResponse()}. - * <p> - * This method should only be called once. Multiple calls to this method are ignored. - * - * @return This object (for method chaining). - */ - public RestCall captureResponse() { - if (capturedResponseWriter == null) { - capturedResponseWriter = new StringWriter(); - writers.add(capturedResponseWriter, false); - } - return this; - } - - - /** - * Look for the specified regular expression pattern in the response output. - * <p> - * Causes a {@link RestCallException} to be thrown if the specified pattern is found in the output. - * <p> - * This method uses {@link #getCapturedResponse()} to read the response text and so does not affect the other output - * methods such as {@link #getResponseAsString()}. - * - * <dl> - * <dt>Example:</dt> - * <dd> - * <p class='bcode'> - * <jc>// Throw a RestCallException if FAILURE or ERROR is found in the output.</jc> - * restClient.doGet(<jsf>URL</jsf>) - * .failurePattern(<js>"FAILURE|ERROR"</js>) - * .run(); - * </p> - * </dd> - * </dl> - * - * @param errorPattern A regular expression to look for in the response output. - * @return This object (for method chaining). - */ - public RestCall failurePattern(final String errorPattern) { - addResponsePattern( - new ResponsePattern(errorPattern) { - @Override - public void onMatch(RestCall rc, Matcher m) throws RestCallException { - throw new RestCallException("Failure pattern detected."); - } - } - ); - return this; - } - - /** - * Look for the specified regular expression pattern in the response output. - * <p> - * Causes a {@link RestCallException} to be thrown if the specified pattern is not found in the output. - * <p> - * This method uses {@link #getCapturedResponse()} to read the response text and so does not affect the other output - * methods such as {@link #getResponseAsString()}. - * - * <dl> - * <dt>Example:</dt> - * <dd> - * <p class='bcode'> - * <jc>// Throw a RestCallException if SUCCESS is not found in the output.</jc> - * restClient.doGet(<jsf>URL</jsf>) - * .successPattern(<js>"SUCCESS"</js>) - * .run(); - * </p> - * </dd> - * </dl> - * - * @param successPattern A regular expression to look for in the response output. - * @return This object (for method chaining). - */ - public RestCall successPattern(String successPattern) { - addResponsePattern( - new ResponsePattern(successPattern) { - @Override - public void onNoMatch(RestCall rc) throws RestCallException { - throw new RestCallException("Success pattern not detected."); - } - } - ); - return this; - } - - /** - * Adds a response pattern finder to look for regular expression matches in the response output. - * <p> - * This method can be called multiple times to add multiple response pattern finders. - * <p> - * {@link ResponsePattern ResponsePatterns} use the {@link #getCapturedResponse()} to read the response text and so does not affect the other output - * methods such as {@link #getResponseAsString()}. - * - * @param responsePattern The response pattern finder. - * @return This object (for method chaining). - */ - public RestCall addResponsePattern(final ResponsePattern responsePattern) { - captureResponse(); - addInterceptor( - new RestCallInterceptor() { - @Override - public void onClose(RestCall restCall) throws RestCallException { - responsePattern.match(RestCall.this); - } - } - ); - return this; - } - - /** - * Set configuration settings on this request. - * <p> - * Use {@link RequestConfig#custom()} to create configuration parameters for the request. - * - * @param config The new configuration settings for this request. - * @return This object (for method chaining). - */ - public RestCall setConfig(RequestConfig config) { - this.request.setConfig(config); - return this; - } - - /** - * @return The HTTP response code. - * @throws RestCallException - * @deprecated Use {@link #run()}. - */ - @Deprecated - public int execute() throws RestCallException { - return run(); - } - - /** - * Method used to execute an HTTP response where you're only interested in the HTTP response code. - * <p> - * The response entity is discarded unless one of the pipe methods have been specified to pipe the - * output to an output stream or writer. - * - * <dl> - * <dt>Example:</dt> - * <dd> - * <p class='bcode'> - * <jk>try</jk> { - * RestClient client = <jk>new</jk> RestClient(); - * <jk>int</jk> rc = client.doGet(url).execute(); - * <jc>// Succeeded!</jc> - * } <jk>catch</jk> (RestCallException e) { - * <jc>// Failed!</jc> - * } - * </p> - * </dd> - * </dl> - * - * @return This object (for method chaining). - * @throws RestCallException If an exception or non-200 response code occurred during the connection attempt. - */ - public int run() throws RestCallException { - connect(); - try { - StatusLine status = response.getStatusLine(); - int sc = status.getStatusCode(); - if (sc >= 400 && ! ignoreErrors) - throw new RestCallException(sc, status.getReasonPhrase(), request.getMethod(), request.getURI(), getResponseAsString()).setHttpResponse(response); - if (outputStreams.size() > 0 || writers.size() > 0) - getReader(); - return sc; - } catch (RestCallException e) { - isFailed = true; - throw e; - } catch (IOException e) { - isFailed = true; - throw new RestCallException(e).setHttpResponse(response); - } finally { - close(); - } - } - - /** - * Connects to the REST resource. - * <p> - * If this is a <code>PUT</code> or <code>POST</code>, also sends the input to the remote resource.<br> - * <p> - * Typically, you would only call this method if you're not interested in retrieving the body of the HTTP response. - * Otherwise, you're better off just calling one of the {@link #getReader()}/{@link #getResponse(Class)}/{@link #pipeTo(Writer)} - * methods directly which automatically call this method already. - * - * @return This object (for method chaining). - * @throws RestCallException If an exception or <code>400+</code> HTTP status code occurred during the connection attempt. - */ - public RestCall connect() throws RestCallException { - - if (isConnected) - return this; - isConnected = true; - - try { - int sc = 0; - while (retries > 0) { - retries--; - Exception ex = null; - try { - response = client.execute(request); - sc = (response == null || response.getStatusLine() == null) ? -1 : response.getStatusLine().getStatusCode(); - } catch (Exception e) { - ex = e; - sc = -1; - if (response != null) - EntityUtils.consumeQuietly(response.getEntity()); - } - if (! retryOn.onCode(sc)) - retries = 0; - if (retries > 0) { - for (RestCallInterceptor rci : interceptors) - rci.onRetry(this, sc, request, response, ex); - request.reset(); - long w = retryInterval; - synchronized(this) { - wait(w); - } - } else if (ex != null) { - throw ex; - } - } - for (RestCallInterceptor rci : interceptors) - rci.onConnect(this, sc, request, response); - if (response == null) - throw new RestCallException("HttpClient returned a null response"); - StatusLine sl = response.getStatusLine(); - String method = request.getMethod(); - sc = sl.getStatusCode(); // Read it again in case it was changed by one of the interceptors. - if (sc >= 400 && ! ignoreErrors) - throw new RestCallException(sc, sl.getReasonPhrase(), method, request.getURI(), getResponseAsString()).setHttpResponse(response); - if ((sc == 307 || sc == 302) && allowRedirectsOnPosts && method.equalsIgnoreCase("POST")) { - if (redirectOnPostsTries-- < 1) - throw new RestCallException(sc, "Maximum number of redirects occurred. Location header: " + response.getFirstHeader("Location"), method, request.getURI(), getResponseAsString()); - Header h = response.getFirstHeader("Location"); - if (h != null) { - reset(); - request.setURI(URI.create(h.getValue())); - retries++; // Redirects should affect retries. - connect(); - } - } - - } catch (RestCallException e) { - isFailed = true; - try { - close(); - } catch (RestCallException e2) { /* Ignore */ } - throw e; - } catch (Exception e) { - isFailed = true; - close(); - throw new RestCallException(e).setHttpResponse(response); - } - - return this; - } - - private void reset() { - if (response != null) - EntityUtils.consumeQuietly(response.getEntity()); - request.reset(); - isConnected = false; - isClosed = false; - isFailed = false; - if (capturedResponseWriter != null) - capturedResponseWriter.getBuffer().setLength(0); - } - - /** - * Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as a reader. - * <p> - * If an {@link Encoder} has been registered with the {@link RestClient}, then the underlying input stream - * will be wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>). - * <p> - * If present, automatically handles the <code>charset</code> value in the <code>Content-Type</code> response header. - * <p> - * <b>IMPORTANT:</b> It is your responsibility to close this reader once you have finished with it. - * - * @return The HTTP response message body reader. <jk>null</jk> if response was successful but didn't contain a body (e.g. HTTP 204). - * @throws IOException If an exception occurred while streaming was already occurring. - */ - public Reader getReader() throws IOException { - InputStream is = getInputStream(); - if (is == null) - return null; - - // Figure out what the charset of the response is. - String cs = null; - Header contentType = response.getLastHeader("Content-Type"); - String ct = contentType == null ? null : contentType.getValue(); - - // First look for "charset=" in Content-Type header of response. - if (ct != null && ct.contains("charset=")) - cs = ct.substring(ct.indexOf("charset=")+8).trim(); - - if (cs == null) - cs = "UTF-8"; - - Reader isr = new InputStreamReader(is, cs); - - if (writers.size() > 0) { - StringWriter sw = new StringWriter(); - writers.add(sw, true); - IOPipe.create(isr, writers).byLines(byLines).run(); - return new StringReader(sw.toString()); - } - - return new InputStreamReader(is, cs); - } - - /** - * Returns the response text as a string if {@link #captureResponse()} was called on this object. - * <p> - * Note that while similar to {@link #getResponseAsString()}, this method can be called multiple times - * to retrieve the response text multiple times. - * <p> - * Note that this method returns <jk>null</jk> if you have not called one of the methods that cause - * the response to be processed. (e.g. {@link #run()}, {@link #getResponse()}, {@link #getResponseAsString()}. - * - * @return The captured response, or <jk>null</jk> if {@link #captureResponse()} has not been called. - * @throws IllegalStateException If trying to call this method before the response is consumed. - */ - public String getCapturedResponse() { - if (! isClosed) - throw new IllegalStateException("This method cannot be called until the response has been consumed."); - if (capturedResponse == null && capturedResponseWriter != null && capturedResponseWriter.getBuffer().length() > 0) - capturedResponse = capturedResponseWriter.toString(); - return capturedResponse; - } - - /** - * Returns the parser specified on the client to use for parsing HTTP response bodies. - * - * @return The parser. - * @throws RestCallException If no parser was defined on the client. - */ - protected Parser<?> getParser() throws RestCallException { - if (client.parser == null) - throw new RestCallException(0, "No parser defined on client", request.getMethod(), request.getURI(), null); - return client.parser; - } - - /** - * Returns the serializer specified on the client to use for serializing HTTP request bodies. - * - * @return The serializer. - * @throws RestCallException If no serializer was defined on the client. - */ - protected Serializer<?> getSerializer() throws RestCallException { - if (client.serializer == null) - throw new RestCallException(0, "No serializer defined on client", request.getMethod(), request.getURI(), null); - return client.serializer; - } - - /** - * Returns the value of the <code>Content-Length</code> header. - * - * @return The value of the <code>Content-Length</code> header, or <code>-1</code> if header is not present. - * @throws IOException - */ - public int getContentLength() throws IOException { - connect(); - Header h = response.getLastHeader("Content-Length"); - if (h == null) - return -1; - long l = Long.parseLong(h.getValue()); - if (l > Integer.MAX_VALUE) - return Integer.MAX_VALUE; - return (int)l; - } - - /** - * Connects to the remote resource (if <code>connect()</code> hasn't already been called) and returns the HTTP response message body as an input stream. - * <p> - * If an {@link Encoder} has been registered with the {@link RestClient}, then the underlying input stream - * will be wrapped in the encoded stream (e.g. a <code>GZIPInputStream</code>). - * <p> - * <b>IMPORTANT:</b> It is your responsibility to close this reader once you have finished with it. - * - * @return The HTTP response message body input stream. <jk>null</jk> if response was successful but didn't contain a body (e.g. HTTP 204). - * @throws IOException If an exception occurred while streaming was already occurring. - * @throws IllegalStateException If an attempt is made to read the response more than once. - */ - public InputStream getInputStream() throws IOException { - if (isClosed) - throw new IllegalStateException("Method cannot be called. Response has already been consumed."); - connect(); - if (response == null) - throw new RestCallException("Response was null"); - if (response.getEntity() == null) // HTTP 204 results in no content. - return null; - InputStream is = response.getEntity().getContent(); - - if (outputStreams.size() > 0) { - ByteArrayInOutStream baios = new ByteArrayInOutStream(); - outputStreams.add(baios, true); - IOPipe.create(is, baios).run(); - return baios.getInputStream(); - } - return is; - } - - /** - * Connects to the remote resource (if {@code connect()} hasn't already been called) and returns the HTTP response message body as plain text. - * - * @return The response as a string. - * @throws RestCallException If an exception or non-200 response code occurred during the connection attempt. - * @throws IOException If an exception occurred while streaming was already occurring. - */ - public String getResponseAsString() throws IOException { - try { - Reader r = getReader(); - String s = IOUtils.read(r).toString(); - return s; - } catch (IOException e) { - isFailed = true; - throw e; - } finally { - close(); - } - } - - /** - * Converts the output from the connection into an object of the specified class using the registered {@link Parser}. - * - * @param type The class to convert the input to. - * @param <T> The class to convert the input to. - * @return The parsed output. - * @throws IOException If a connection error occurred. - * @throws ParseException If the input contains a syntax error or is malformed for the <code>Content-Type</code> header. - */ - public <T> T getResponse(Class<T> type) throws IOException, ParseException { - BeanContext bc = getParser().getBeanContext(); - if (bc == null) - bc = BeanContext.DEFAULT; - return getResponse(bc.getClassMeta(type)); - } - - /** - * Parses the output from the connection into the specified type and then wraps that in a {@link PojoRest}. - * <p> - * Useful if you want to quickly retrieve a single value from inside of a larger JSON document. - * - * @param innerType The class type of the POJO being wrapped. - * @return The parsed output wapped in a {@link PojoRest}. - * @throws IOException If a connection error occurred. - * @throws ParseException If the input contains a syntax error or is malformed for the <code>Content-Type</code> header. - */ - public PojoRest getResponsePojoRest(Class<?> innerType) throws IOException, ParseException { - return new PojoRest(getResponse(innerType)); - } - - /** - * Converts the output from the connection into an {@link ObjectMap} and then wraps that in a {@link PojoRest}. - * <p> - * Useful if you want to quickly retrieve a single value from inside of a larger JSON document. - * - * @return The parsed output wapped in a {@link PojoRest}. - * @throws IOException If a connection error occurred. - * @throws ParseException If the input contains a syntax error or is malformed for the <code>Content-Type</code> header. - */ - public PojoRest getResponsePojoRest() throws IOException, ParseException { - return getResponsePojoRest(ObjectMap.class); - } - - /** - * Convenience method when you want to parse into a Map<K,V> object. - * - * <dl> - * <dt>Example:</dt> - * <dd> - * <p class='bcode'> - * Map<String,MyBean> m = client.doGet(url).getResponseMap(LinkedHashMap.<jk>class</jk>, String.<jk>class</jk>, MyBean.<jk>class</jk>); - * </p> - * <p> - * A simpler approach is often to just extend the map class you want and just use the normal {@link #getResponse(Class)} method: - * </p> - * <p class='bcode'> - * <jk>public static class</jk> MyMap <jk>extends</jk> LinkedHashMap<String,MyBean> {} - * - * Map<String,MyBean> m = client.doGet(url).getResponse(MyMap.<jk>class</jk>); - * </p> - * </dd> - * </dl> - * - * @param mapClass The map class to use (e.g. <code>TreeMap</code>) - * @param keyClass The class type of the keys (e.g. <code>String</code>) - * @param valueClass The class type of the values (e.g. <code>MyBean</code>) - * @return The response parsed as a map. - * @throws ParseException - * @throws IOException - */ - public final <K,V,T extends Map<K,V>> T getResponseMap(Class<T> mapClass, Class<K> keyClass, Class<V> valueClass) throws ParseException, IOException { - ClassMeta<T> cm = getBeanContext().getMapClassMeta(mapClass, keyClass, valueClass); - return getResponse(cm); - } - - /** - * Convenience method when you want to parse into a Collection<E> object. - * - * <dl> - * <dt>Example:</dt> - * <dd> - * <p class='bcode'> - * List<MyBean> l = client.doGet(url).getResponseCollection(LinkedList.<jk>class</jk>, MyBean.<jk>class</jk>); - * </p> - * <p> - * A simpler approach is often to just extend the collection class you want and just use the normal {@link #getResponse(Class)} method: - * </p> - * <p class='bcode'> - * <jk>public static class</jk> MyList <jk>extends</jk> LinkedList<MyBean> {} - * - * List<MyBean> l = client.doGet(url).getResponse(MyList.<jk>class</jk>); - * </p> - * </dd> - * </dl> - * - * @param collectionClass The collection class to use (e.g. <code>LinkedList</code>) - * @param entryClass The class type of the values (e.g. <code>MyBean</code>) - * @return The response parsed as a collection. - * @throws ParseException - * @throws IOException - */ - public final <E,T extends Collection<E>> T getResponseCollection(Class<T> collectionClass, Class<E> entryClass) throws ParseException, IOException { - ClassMeta<T> cm = getBeanContext().getCollectionClassMeta(collectionClass, entryClass); - return getResponse(cm); - } - - <T> T getResponse(ClassMeta<T> type) throws IOException, ParseException { - try { - Parser<?> p = getParser(); - T o = null; - int contentLength = getContentLength(); - if (! p.isReaderParser()) { - InputStream is = getInputStream(); - o = ((InputStreamParser)p).parse(is, contentLength, type); - } else { - Reader r = getReader(); - o = ((ReaderParser)p).parse(r, contentLength, type); - } - return o; - } catch (ParseException e) { - isFailed = true; - throw e; - } catch (IOException e) { - isFailed = true; - throw e; - } finally { - close(); - } - } - - BeanContext getBeanContext() throws RestCallException { - BeanContext bc = getParser().getBeanContext(); - if (bc == null) - bc = BeanContext.DEFAULT; - return bc; - } - - /** - * Returns access to the {@link HttpUriRequest} passed to {@link HttpClient#execute(HttpUriRequest)}. - * - * @return The {@link HttpUriRequest} object. - */ - public HttpUriRequest getRequest() { - return request; - } - - /** - * Returns access to the {@link HttpResponse} returned by {@link HttpClient#execute(HttpUriRequest)}. - * Returns <jk>null</jk> if {@link #connect()} has not yet been called. - * - * @return The HTTP response object. - * @throws IOException - */ - public HttpResponse getResponse() throws IOException { - connect(); - return response; - } - - /** - * Shortcut for calling <code>getRequest().setHeader(header)</code> - * - * @param header The header to set on the request. - * @return This object (for method chaining). - */ - public RestCall setHeader(Header header) { - request.setHeader(header); - return this; - } - - /** Use close() */ - @Deprecated - public void consumeResponse() { - if (response != null) - EntityUtils.consumeQuietly(response.getEntity()); - } - - /** - * Cleans up this HTTP call. - * - * @return This object (for method chaining). - * @throws RestCallException Can be thrown by one of the {@link RestCallInterceptor#onClose(RestCall)} calls. - */ - public RestCall close() throws RestCallException { - if (response != null) - EntityUtils.consumeQuietly(response.getEntity()); - isClosed = true; - if (! isFailed) - for (RestCallInterceptor r : interceptors) - r.onClose(this); - return this; - } - - /** - * Adds a {@link RestCallLogger} to the list of interceptors on this class. - * - * @param level The log level to log events at. - * @param log The logger. - * @return This object (for method chaining). - */ - public RestCall logTo(Level level, Logger log) { - addInterceptor(new RestCallLogger(level, log)); - return this; - } -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallException.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallException.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallException.java deleted file mode 100755 index b0129f4..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallException.java +++ /dev/null @@ -1,150 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2014, 2015. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import static java.lang.String.*; - -import java.io.*; -import java.net.*; -import java.util.regex.*; - -import org.apache.http.*; -import org.apache.http.client.*; -import org.apache.http.util.*; - -import com.ibm.juno.core.utils.*; - -/** - * Exception representing a <code>400+</code> HTTP response code against a remote resource. - * - * @author James Bognar ([email protected]) - */ -public final class RestCallException extends IOException { - - private static final long serialVersionUID = 1L; - - private int responseCode; - private String response, responseStatusMessage; - HttpResponseException e; - private HttpResponse httpResponse; - - - /** - * Constructor. - * - * @param msg The exception message. - */ - public RestCallException(String msg) { - super(msg); - } - - /** - * Constructor. - * - * @param e The inner cause of the exception. - */ - public RestCallException(Exception e) { - super(e.getLocalizedMessage(), e); - if (e instanceof FileNotFoundException) { - responseCode = 404; - } else if (e.getMessage() != null) { - Pattern p = Pattern.compile("[^\\d](\\d{3})[^\\d]"); - Matcher m = p.matcher(e.getMessage()); - if (m.find()) - responseCode = Integer.parseInt(m.group(1)); - } - setStackTrace(e.getStackTrace()); - } - - /** - * Create an exception with a simple message and the status code and body of the specified response. - * - * @param msg The exception message. - * @param response The HTTP response object. - * @throws ParseException - * @throws IOException - */ - public RestCallException(String msg, HttpResponse response) throws ParseException, IOException { - super(format("%s%nstatus='%s'%nResponse: %n%s%n", msg, response.getStatusLine().getStatusCode(), EntityUtils.toString(response.getEntity(), IOUtils.UTF8))); - } - - /** - * Constructor. - * - * @param responseCode The response code. - * @param responseMsg The response message. - * @param method The HTTP method (for message purposes). - * @param url The HTTP URL (for message purposes). - * @param response The reponse from the server. - */ - public RestCallException(int responseCode, String responseMsg, String method, URI url, String response) { - super(format("HTTP method '%s' call to '%s' caused response code '%s,%s'.%nResponse: %n%s%n", method, url, responseCode, responseMsg, response)); - this.responseCode = responseCode; - this.responseStatusMessage = responseMsg; - this.response = response; - } - - /** - * Sets the HTTP response object that caused this exception. - * - * @param httpResponse The HTTP respose object. - * @return This object (for method chaining). - */ - protected RestCallException setHttpResponse(HttpResponse httpResponse) { - this.httpResponse = httpResponse; - return this; - } - - /** - * Returns the HTTP response object that caused this exception. - * - * @return The HTTP response object that caused this exception, or <jk>null</jk> if no response was created yet when the exception was thrown. - */ - public HttpResponse getHttpResponse() { - return this.httpResponse; - } - - /** - * Returns the HTTP response status code. - * - * @return The response status code. If a connection could not be made at all, returns <code>0<code>. - */ - public int getResponseCode() { - return responseCode; - } - - /** - * Returns the HTTP response message body text. - * - * @return The response message body text. - */ - public String getResponseMessage() { - return response; - } - - /** - * Returns the response status message as a plain string. - * - * @return The response status message. - */ - public String getResponseStatusMessage() { - return responseStatusMessage; - } - - /** - * Sets the inner cause for this exception. - * @param cause The inner cause. - * @return This object (for method chaining). - */ - @Override /* Throwable */ - public synchronized RestCallException initCause(Throwable cause) { - super.initCause(cause); - return this; - } -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallInterceptor.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallInterceptor.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallInterceptor.java deleted file mode 100755 index 52c278b..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallInterceptor.java +++ /dev/null @@ -1,56 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2015. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import org.apache.http.*; - -/** - * Used to intercept http connection responses to allow modification of that response before processing - * and for listening for call lifecycle events. - * <p> - * Useful if you want to prevent {@link RestCallException RestCallExceptions} from being thrown on error conditions. - */ -public abstract class RestCallInterceptor { - - /** - * Called when {@link RestCall} object is created. - * - * @param restCall The restCall object invoking this method. - */ - public void onInit(RestCall restCall) {} - - /** - * Called immediately after an HTTP response has been received. - * - * @param statusCode The HTTP status code received. - * @param restCall The restCall object invoking this method. - * @param req The HTTP request object. - * @param res The HTTP response object. - */ - public void onConnect(RestCall restCall, int statusCode, HttpRequest req, HttpResponse res) {} - - /** - * Called if retry is going to be attempted. - * - * @param statusCode The HTTP status code received. - * @param restCall The restCall object invoking this method. - * @param req The HTTP request object. - * @param res The HTTP response object. - * @param ex The exception thrown from the client. - */ - public void onRetry(RestCall restCall, int statusCode, HttpRequest req, HttpResponse res, Exception ex) {} - - /** - * Called when {@link RestCall#close()} is called. - * - * @param restCall The restCall object invoking this method. - * @throws RestCallException - */ - public void onClose(RestCall restCall) throws RestCallException {} -} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/30947fd7/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallLogger.java ---------------------------------------------------------------------- diff --git a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallLogger.java b/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallLogger.java deleted file mode 100755 index a0dc722..0000000 --- a/com.ibm.team.juno.client/src/com/ibm/juno/client/RestCallLogger.java +++ /dev/null @@ -1,116 +0,0 @@ -/******************************************************************************* - * Licensed Materials - Property of IBM - * (c) Copyright IBM Corporation 2015. All Rights Reserved. - * - * The source code for this program is not published or otherwise - * divested of its trade secrets, irrespective of what has been - * deposited with the U.S. Copyright Office. - *******************************************************************************/ -package com.ibm.juno.client; - -import java.io.*; -import java.text.*; -import java.util.logging.*; - -import org.apache.http.*; -import org.apache.http.client.methods.*; -import org.apache.http.util.*; - -/** - * Specialized interceptor for logging calls to a log file. - * <p> - * Causes a log entry to be created that shows all the request and response headers and content - * at the end of the request. - * <p> - * Use the {@link RestClient#logTo(Level, Logger)} and {@link RestCall#logTo(Level, Logger)} - * <p> - * methods to create instances of this class. - */ -public class RestCallLogger extends RestCallInterceptor { - - private Level level; - private Logger log; - - /** - * Constructor. - * - * @param level The log level to log messages at. - * @param log The logger to log to. - */ - protected RestCallLogger(Level level, Logger log) { - this.level = level; - this.log = log; - } - - @Override /* RestCallInterceptor */ - public void onInit(RestCall restCall) { - if (log.isLoggable(level)) - restCall.captureResponse(); - } - - @Override /* RestCallInterceptor */ - public void onConnect(RestCall restCall, int statusCode, HttpRequest req, HttpResponse res) { - // Do nothing. - } - - @Override /* RestCallInterceptor */ - public void onRetry(RestCall restCall, int statusCode, HttpRequest req, HttpResponse res, Exception ex) { - if (log.isLoggable(level)) { - if (ex == null) - log.log(level, MessageFormat.format("Call to {0} returned {1}. Will retry.", req.getRequestLine().getUri(), statusCode)); //$NON-NLS-1$ - else - log.log(level, MessageFormat.format("Call to {0} caused exception {1}. Will retry.", req.getRequestLine().getUri(), ex.getLocalizedMessage()), ex); //$NON-NLS-1$ - } - } - - @Override /* RestCallInterceptor */ - public void onClose(RestCall restCall) throws RestCallException { - try { - if (log.isLoggable(level)) { - String output = restCall.getCapturedResponse(); - StringBuilder sb = new StringBuilder(); - HttpUriRequest req = restCall.getRequest(); - HttpResponse res = restCall.getResponse(); - if (req != null) { - sb.append("\n=== HTTP Call =================================================================="); - - sb.append("\n=== REQUEST ===\n").append(req); - sb.append("\n---request headers---"); - for (Header h : req.getAllHeaders()) - sb.append("\n").append(h); - if (req instanceof HttpEntityEnclosingRequestBase) { - sb.append("\n---request entity---"); - HttpEntityEnclosingRequestBase req2 = (HttpEntityEnclosingRequestBase)req; - HttpEntity e = req2.getEntity(); - if (e == null) - sb.append("\nEntity is null"); - else { - if (e.getContentType() != null) - sb.append("\n").append(e.getContentType()); - if (e.getContentEncoding() != null) - sb.append("\n").append(e.getContentEncoding()); - if (e.isRepeatable()) { - try { - sb.append("\n---request content---\n").append(EntityUtils.toString(e)); - } catch (Exception ex) { - throw new RuntimeException(ex); - } - } - } - } - } - if (res != null) { - sb.append("\n=== RESPONSE ===\n").append(res.getStatusLine()); - sb.append("\n---response headers---"); - for (Header h : res.getAllHeaders()) - sb.append("\n").append(h); - sb.append("\n---response content---\n").append(output); - sb.append("\n=== END ========================================================================"); - } - log.log(level, sb.toString()); - } - } catch (IOException e) { - log.log(Level.SEVERE, e.getLocalizedMessage(), e); - } - } -}
