javax.xml.ws.spi.Invoker Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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 javax.xml.ws.spi;
import javax.xml.ws.WebServiceContext;
import javax.xml.ws.WebServiceFeature;
import java.lang.reflect.Method;
import java.lang.reflect.InvocationTargetException;
/**
* Invoker hides the detail of calling into application endpoint
* implementation. Container hands over an implementation of Invoker
* to JAX-WS runtime, and jax-ws runtime calls {@link #invoke}
* for a web service invocation. Finally, Invoker does the actual
* invocation of web service on endpoint instance.
*
* Container also injects the provided WebServiceContext and takes
* care of invoking javax.annotation.PostConstruct methods,
* if present, on the endpoint implementation.
*
* @see Provider#createEndpoint(String, Class, Invoker, WebServiceFeature...)
* @author Jitendra Kotamraju
* @since JAX-WS 2.2
*/
public abstract class Invoker {
/**
* JAX-WS runtimes calls this method to ask container to inject
* WebServiceContext on the endpoint instance. The
* WebServiceContext object uses thread-local information
* to return the correct information during the actual endpoint invocation
* regardless of how many threads are concurrently being used to serve
* requests.
*
* @param webServiceContext a holder for MessageContext
* @throws IllegalAccessException if the injection done
* by reflection API throws this exception
* @throws IllegalArgumentException if the injection done
* by reflection API throws this exception
* @throws InvocationTargetException if the injection done
* by reflection API throws this exception
*/
public abstract void inject(WebServiceContext webServiceContext)
throws IllegalAccessException, IllegalArgumentException, InvocationTargetException;
/**
* JAX-WS runtime calls this method to do the actual web service
* invocation on endpoint instance. The injected
* WebServiceContext.getMessageContext() gives the correct
* information for this invocation.
*
* @param m Method to be invoked on the service
* @param args Method arguments
* @return return value of the method
* @throws IllegalAccessException if the invocation done
* by reflection API throws this exception
* @throws IllegalArgumentException if the invocation done
* by reflection API throws this exception
* @throws InvocationTargetException if the invocation done
* by reflection API throws this exception
* @see Method#invoke
*/
public abstract Object invoke(Method m, Object... args)
throws IllegalAccessException, IllegalArgumentException, InvocationTargetException;
}