org.glassfish.jersey.server.model.MethodHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-server Show documentation
Show all versions of jersey-server Show documentation
Jersey core server implementation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2015 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
* http://glassfish.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 org.glassfish.jersey.server.model;
import java.lang.reflect.Constructor;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import javax.ws.rs.Encoded;
import org.glassfish.jersey.internal.inject.Injections;
import org.glassfish.hk2.api.ServiceLocator;
/**
* Resource method handler model.
*
* @author Marek Potociar (marek.potociar at oracle.com)
*/
public abstract class MethodHandler implements ResourceModelComponent {
private final Collection handlerParameters;
/**
* Create new instance of a resource method handler model.
*/
protected MethodHandler() {
this.handlerParameters = Collections.emptyList();
}
/**
* Create new instance of a resource method handler model.
*
* @param parameters handler parameters associated directly with the resource method handler
* (e.g. class-level property setters and fields). May be {@code null}.
* @since 2.20
*/
protected MethodHandler(final Collection parameters) {
if (parameters != null) {
this.handlerParameters = Collections.unmodifiableCollection(new ArrayList<>(parameters));
} else {
this.handlerParameters = Collections.emptyList();
}
}
/**
* Create a class-based method handler from a class.
*
* @param handlerClass method handler class.
* @return new class-based method handler.
*/
public static MethodHandler create(final Class handlerClass) {
return new ClassBasedMethodHandler(handlerClass, null);
}
/**
* Create a class-based method handler from a class.
*
* @param handlerClass method handler class.
* @param keepConstructorParamsEncoded if set to {@code true}, any injected constructor
* parameters must be kept encoded and must not be automatically decoded.
* @return new class-based method handler.
*/
public static MethodHandler create(final Class handlerClass, final boolean keepConstructorParamsEncoded) {
return new ClassBasedMethodHandler(handlerClass, keepConstructorParamsEncoded, null);
}
/**
* Create a instance-based (singleton) method handler from a class.
*
* @param handlerInstance method handler instance (singleton).
* @return new instance-based method handler.
*/
public static MethodHandler create(final Object handlerInstance) {
return new InstanceBasedMethodHandler(handlerInstance, null);
}
/**
* Create a instance-based (singleton) method handler from a class.
*
* @param handlerInstance method handler instance (singleton).
* @param handlerClass declared handler class.
* @return new instance-based method handler.
*/
public static MethodHandler create(final Object handlerInstance, Class handlerClass) {
return new InstanceBasedMethodHandler(handlerInstance, handlerClass, null);
}
/**
* Create a class-based method handler from a class.
*
* @param handlerClass method handler class.
* @param handlerParameters method handler parameters (e.g. class-level property setters and fields).
* @return new class-based method handler.
*/
public static MethodHandler create(final Class handlerClass, final Collection handlerParameters) {
return new ClassBasedMethodHandler(handlerClass, handlerParameters);
}
/**
* Create a class-based method handler from a class.
*
* @param handlerClass method handler class.
* @param keepConstructorParamsEncoded if set to {@code true}, any injected constructor
* parameters must be kept encoded and must not be automatically decoded.
* @param handlerParameters method handler parameters (e.g. class-level property setters and fields).
* @return new class-based method handler.
* @since 2.20
*/
public static MethodHandler create(final Class handlerClass,
final boolean keepConstructorParamsEncoded,
final Collection handlerParameters) {
return new ClassBasedMethodHandler(handlerClass, keepConstructorParamsEncoded, handlerParameters);
}
/**
* Create a instance-based (singleton) method handler from a class.
*
* @param handlerInstance method handler instance (singleton).
* @param handlerParameters method handler parameters (e.g. class-level property setters and fields).
* @return new instance-based method handler.
* @since 2.20
*/
public static MethodHandler create(final Object handlerInstance, final Collection handlerParameters) {
return new InstanceBasedMethodHandler(handlerInstance, handlerParameters);
}
/**
* Create a instance-based (singleton) method handler from a class.
*
* @param handlerInstance method handler instance (singleton).
* @param handlerClass declared handler class.
* @param handlerParameters method handler parameters (e.g. class-level property setters and fields).
* @return new instance-based method handler.
* @since 2.20
*/
public static MethodHandler create(final Object handlerInstance,
Class handlerClass,
final Collection handlerParameters) {
return new InstanceBasedMethodHandler(handlerInstance, handlerClass, handlerParameters);
}
/**
* Get the resource method handler class.
*
* @return resource method handler class.
*/
public abstract Class getHandlerClass();
/**
* Get the resource method handler constructors.
*
* The returned is empty by default. Concrete implementations may override
* the method to return the actual list of constructors that will be used
* for the handler initialization.
*
* @return resource method handler constructors.
*/
public List getConstructors() {
return Collections.emptyList();
}
/**
* Get the injected resource method handler instance.
*
* @param locator service locator that can be used to inject get the instance.
* @return injected resource method handler instance.
*/
public abstract Object getInstance(final ServiceLocator locator);
/**
* Return whether the method handler {@link ServiceLocator creates instances}
* based on {@link Class classes}.
*
* @return True is instances returned bu this method handler are created from {@link Class classes} given to HK2, false\
* otherwise (for example when method handler was initialized from instance)
*/
public abstract boolean isClassBased();
/**
* Get the parameters associated directly with the resource method handler, if any
* (e.g. class-level property setters and fields).
*
* Note that this method does not return any parameters associated with
* {@link #getConstructors() method handler constructors}.
*
*
* @return parameters associated with the resource method handler. May return an empty collection
* but does not return {@code null}.
* @since 2.20
*/
public Collection getParameters() {
return handlerParameters;
}
@Override
public List getComponents() {
return null;
}
@Override
public void accept(final ResourceModelVisitor visitor) {
visitor.visitMethodHandler(this);
}
private static class ClassBasedMethodHandler extends MethodHandler {
private final Class handlerClass;
private final List handlerConstructors;
public ClassBasedMethodHandler(final Class handlerClass, final Collection handlerParameters) {
this(handlerClass, handlerClass.isAnnotationPresent(Encoded.class), handlerParameters);
}
public ClassBasedMethodHandler(final Class handlerClass,
final boolean disableParamDecoding,
final Collection handlerParameters) {
super(handlerParameters);
this.handlerClass = handlerClass;
List constructors = new LinkedList();
for (Constructor constructor : handlerClass.getConstructors()) {
constructors.add(new HandlerConstructor(
constructor, Parameter.create(handlerClass, handlerClass, constructor, disableParamDecoding)));
}
this.handlerConstructors = Collections.unmodifiableList(constructors);
}
@Override
public Class getHandlerClass() {
return handlerClass;
}
@Override
public List getConstructors() {
return handlerConstructors;
}
@Override
public Object getInstance(final ServiceLocator locator) {
return Injections.getOrCreate(locator, handlerClass);
}
@Override
public boolean isClassBased() {
return true;
}
@Override
protected Object getHandlerInstance() {
return null;
}
@Override
public List getComponents() {
return handlerConstructors;
}
@Override
public String toString() {
return "ClassBasedMethodHandler{"
+ "handlerClass=" + handlerClass
+ ", handlerConstructors=" + handlerConstructors + '}';
}
}
private static class InstanceBasedMethodHandler extends MethodHandler {
private final Object handler;
private final Class handlerClass;
public InstanceBasedMethodHandler(final Object handler, final Collection handlerParameters) {
super(handlerParameters);
this.handler = handler;
this.handlerClass = handler.getClass();
}
public InstanceBasedMethodHandler(final Object handler,
final Class handlerClass,
final Collection handlerParameters) {
super(handlerParameters);
this.handler = handler;
this.handlerClass = handlerClass;
}
@Override
public Class getHandlerClass() {
return handlerClass;
}
@Override
protected Object getHandlerInstance() {
return handler;
}
@Override
public Object getInstance(final ServiceLocator locator) {
return handler;
}
@Override
public boolean isClassBased() {
return false;
}
@Override
public String toString() {
return "InstanceBasedMethodHandler{"
+ "handler=" + handler
+ ", handlerClass=" + handlerClass
+ '}';
}
}
/**
* Get the raw handler instance that is backing this method handler.
*
* @return raw handler instance. May return {@code null} if the handler is
* {@link #isClassBased() class-based}.
*/
protected abstract Object getHandlerInstance();
}