org.jboss.as.ee.component.InjectionSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-ee Show documentation
There is a newer version: 35.0.0.Beta1
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.as.ee.component;

import org.jboss.as.naming.ManagedReferenceFactory;
import org.jboss.as.server.deployment.DeploymentPhaseContext;
import org.jboss.as.server.deployment.DeploymentUnitProcessingException;
import org.jboss.msc.inject.Injector;
import org.jboss.msc.service.ServiceBuilder;

/**
 * A configuration for an injection source.
 *
 * @author David M. Lloyd
 */
public abstract class InjectionSource {
    /**
     * Get the value to use as the injection source.  The value will be yield an injectable which is dereferenced once
     * for every time the reference source is injected.  The given binder service builder may be used to apply any
     * dependencies for this binding (i.e. the source for the binding's value).
     *
     * @param resolutionContext the resolution context to use
     * @param serviceBuilder the builder for the binder service
     * @param phaseContext the deployment phase context
     * @param injector the injector into which the value should be placed
     * @throws DeploymentUnitProcessingException if an error occurs
     */
    public abstract void getResourceValue(ResolutionContext resolutionContext, ServiceBuilder serviceBuilder, DeploymentPhaseContext phaseContext, Injector injector) throws DeploymentUnitProcessingException;

    /**
     * A resolution context for the injection source.
     */
    public static class ResolutionContext {
        private final boolean compUsesModule;
        private final String componentName;
        private final String moduleName;
        private final String applicationName;

        public ResolutionContext(final boolean compUsesModule, final String componentName, final String moduleName, final String applicationName) {
            this.compUsesModule = compUsesModule;
            this.componentName = componentName;
            this.moduleName = moduleName;
            this.applicationName = applicationName;
        }

        /**
         * Determine whether the resolution context has a combined "comp" and "module" namespace.
         *
         * @return {@code true} if "comp" is an alias for "module", {@code false} otherwise
         */
        public boolean isCompUsesModule() {
            return compUsesModule;
        }

        /**
         * Get the current component name, or {@code null} if there is none.
         *
         * @return the current component name
         */
        public String getComponentName() {
            return componentName;
        }

        /**
         * Get the current module name, or {@code null} if there is none.
         *
         * @return the current module name
         */
        public String getModuleName() {
            return moduleName;
        }

        /**
         * Get the current application name, or {@code null} if there is none.
         *
         * @return the current application name
         */
        public String getApplicationName() {
            return applicationName;
        }
    }
}