com.sun.xml.ws.client.AsyncResponseImpl Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.client;
import com.sun.istack.Nullable;
import com.sun.xml.ws.api.Cancelable;
import com.sun.xml.ws.util.CompletedFuture;
import javax.xml.ws.AsyncHandler;
import javax.xml.ws.Response;
import javax.xml.ws.WebServiceException;
import java.util.Map;
import java.util.concurrent.FutureTask;
/**
* {@link Response} implementation. When Runnbale is executed, it just hands the
* request to Fiber and returns. When the Fiber finishes the execution, it sets
* response in the {@link FutureTask}
*
* @author Jitendra Kotamraju
*/
public final class AsyncResponseImpl extends FutureTask implements Response, ResponseContextReceiver {
/**
* Optional {@link AsyncHandler} that gets invoked
* at the completion of the task.
*/
private final AsyncHandler handler;
private ResponseContext responseContext;
private final Runnable callable;
private Cancelable cancelable;
/**
*
* @param runnable
* This {@link Runnable} is executed asynchronously.
* @param handler
* Optional {@link AsyncHandler} to invoke at the end
* of the processing. Can be null.
*/
public AsyncResponseImpl(Runnable runnable, @Nullable AsyncHandler handler) {
super(runnable, null);
this.callable = runnable;
this.handler = handler;
}
@Override
public void run() {
// override so that AsyncInvoker calls set()
// when Fiber calls the callback
try {
callable.run();
} catch (WebServiceException e) {
//it could be a WebServiceException or a ProtocolException or any RuntimeException
// resulting due to some internal bug.
set(null, e);
} catch (Throwable e) {
//its some other exception resulting from user error, wrap it in
// WebServiceException
set(null, new WebServiceException(e));
}
}
public ResponseContext getContext() {
return responseContext;
}
public void setResponseContext(ResponseContext rc) {
responseContext = rc;
}
public void set(final T v, final Throwable t) {
// call the handler before we mark the future as 'done'
if (handler!=null) {
try {
/**
* {@link Response} object passed into the callback.
* We need a separate {@link java.util.concurrent.Future} because we don't want {@link ResponseImpl}
* to be marked as 'done' before the callback finishes execution.
* (That would provide implicit synchronization between the application code
* in the main thread and the callback code, and is compatible with the JAX-RI 2.0 FCS.
*/
class CallbackFuture extends CompletedFuture implements Response {
public CallbackFuture(T v, Throwable t) {
super(v, t);
}
public Map getContext() {
return AsyncResponseImpl.this.getContext();
}
}
handler.handleResponse(new CallbackFuture(v, t));
} catch (Throwable e) {
super.setException(e);
return;
}
}
if (t != null) {
super.setException(t);
} else {
super.set(v);
}
}
public void setCancelable(Cancelable cancelable) {
this.cancelable = cancelable;
}
public boolean cancel(boolean mayInterruptIfRunning) {
if (cancelable != null)
cancelable.cancel(mayInterruptIfRunning);
return super.cancel(mayInterruptIfRunning);
}
}