com.sun.jersey.spi.inject.InjectableProviderContext Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 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 com.sun.jersey.spi.inject;
import com.sun.jersey.core.spi.component.ComponentContext;
import com.sun.jersey.core.spi.component.ComponentScope;
import java.lang.annotation.Annotation;
import java.util.List;
/**
* The context to obtain {@link Injectable} instances.
*
* @author [email protected]
*/
public interface InjectableProviderContext {
/**
* Check if an annotation and context type is registered for injection.
*
* @param ac the annotation class.
* @param cc the context type.
* @return true if registered, otherwise false
*/
public boolean isAnnotationRegistered(Class ac,
Class cc);
/*
* Check if one or more injectable provider is registered to process an
* annotation and a context type for a given scope.
*
* @param ac the annotation class.
* @param cc the context type.
* @param s the scope.
* @return true if one or more injectable provider is registered,
* otherwise false.
*/
boolean isInjectableProviderRegistered(Class ac,
Class cc,
ComponentScope s);
/**
* Get an injectable.
*
* @param the type of the annotation.
* @param the context type. Types of the {@link java.lang.reflect.Type} and
* {@link com.sun.jersey.api.model.Parameter} are the only types that
* are supported.
* @param ac the annotation class.
* @param ic the injectable context.
* @param a the annotation instance.
* @param c the context type.
* @param s the scope.
* @return the injectable, otherwise null if an injectable could
* not be found.
*/
Injectable getInjectable(
Class ac,
ComponentContext ic,
A a,
C c,
ComponentScope s);
/**
* Get an injectable.
*
* @param the type of the annotation.
* @param the context type. Types of the {@link java.lang.reflect.Type} and
* {@link com.sun.jersey.api.model.Parameter} are the only types that
* are supported.
* @param ac the annotation class.
* @param ic the injectable context.
* @param a the annotation instance.
* @param c the context type.
* @param ls the list of scope, ordered by preference.
* @return the injectable, otherwise null if an injectable could
* not be found.
*/
Injectable getInjectable(
Class ac,
ComponentContext ic,
A a,
C c,
List ls);
public static final class InjectableScopePair {
public final Injectable i;
public final ComponentScope cs;
public InjectableScopePair(Injectable i, ComponentScope cs) {
this.i = i;
this.cs = cs;
}
}
/**
* Get an injectable.
*
* @param the type of the annotation.
* @param the context type. Types of the {@link java.lang.reflect.Type} and
* {@link com.sun.jersey.api.model.Parameter} are the only types that
* are supported.
* @param ac the annotation class.
* @param ic the injectable context.
* @param a the annotation instance.
* @param c the context type.
* @param ls the list of scope, ordered by preference.
* @return the injectable and scope, otherwise null if an injectable could
* not be found.
*/
InjectableScopePair getInjectableWithScope(
Class ac,
ComponentContext ic,
A a,
C c,
List ls);
}