org.wildfly.clustering.web.session.RouteLocatorBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-clustering-web-spi

There is a newer version: 33.0.2.Final

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014, 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.wildfly.clustering.web.session;

import org.jboss.msc.service.ServiceBuilder;
import org.jboss.msc.service.ServiceName;
import org.jboss.msc.service.ServiceTarget;
import org.jboss.msc.value.Value;

/**
 * Builds a {@link RouteLocator} service.
 * @author Paul Ferraro
 */
public interface RouteLocatorBuilder {
    /**
     * Builds a {@link RouteLocator} service.
     * @param target the service target
     * @param name the service name of the route locator service
     * @param deploymentServiceName the service name of the web deployment
     * @return a service builder
     */
    ServiceBuilder build(ServiceTarget target, ServiceName name, ServiceName deploymentServiceName);

    /**
     * Builds the server dependencies to be made available to every deployment.
     * @param target the service target
     * @param route the injected route source
     * @return a service builder
     */
    ServiceBuilder buildServerDependency(ServiceTarget target, Value> route);
}