/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
*/
package quarks.topology.services;

import com.google.gson.JsonObject;

import quarks.execution.Submitter;
import quarks.function.BiConsumer;
import quarks.topology.Topology;
import quarks.topology.mbeans.ApplicationServiceMXBean;

/**
 * Application registration service.
 *
 * @see ApplicationServiceMXBean
 */
public interface ApplicationService {
    
    String ALIAS = "quarksApplicationService";
    
    /**
     * Add a topology that can be started though a control mbean.
     * <BR>
     * When a {@link ApplicationServiceMXBean#submit(String, String) submit}
     * is invoked {@code builder.accept(topology, config)} is called passing:
     * <UL>
     * <LI>
     * {@code topology} - An empty topology with the name {@code applicationName}.
     * </LI>
     * <LI>
     * {@code config} - JSON submission configuration from
     * {@link ApplicationServiceMXBean#submit(String, String) submit}.
     * </LI>
     * </UL>
     * Once {@code builder.accept(topology, config)} returns it is submitted
     * to the {@link Submitter} associated with the implementation of this service.
     * 
     * @param applicationName Application name to register.
     * @param builder How to build the topology for this application.
     * 
     * @see ApplicationServiceMXBean
     */
    void registerTopology(String applicationName, BiConsumer<Topology, JsonObject> builder);
}

/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
*/
package quarks.topology.services;

import com.google.gson.JsonObject;

import quarks.execution.Submitter;
import quarks.function.BiConsumer;
import quarks.topology.Topology;
import quarks.topology.mbeans.ApplicationServiceMXBean;

/**
 * Application registration service.
 * A service that allows registration of applications and
 * the ability to submit them through a control MBean.
 *
 * @see ApplicationServiceMXBean
 */
public interface ApplicationService {
    
	/**
	 * Default alias a service registers its control MBean as.
	 * Value is {@value}.
	 */
    String ALIAS = "quarksApplicationService";
    
    /**
     * Add a topology that can be started though a control mbean.
     * <BR>
     * When a {@link ApplicationServiceMXBean#submit(String, String) submit}
     * is invoked {@code builder.accept(topology, config)} is called passing:
     * <UL>
     * <LI>
     * {@code topology} - An empty topology with the name {@code applicationName}.
     * </LI>
     * <LI>
     * {@code config} - JSON submission configuration from
     * {@link ApplicationServiceMXBean#submit(String, String) submit}.
     * </LI>
     * </UL>
     * Once {@code builder.accept(topology, config)} returns it is submitted
     * to the {@link Submitter} associated with the implementation of this service.
     * 
     * @param applicationName Application name to register.
     * @param builder How to build the topology for this application.
     * 
     * @see ApplicationServiceMXBean
     */
    void registerTopology(String applicationName, BiConsumer<Topology, JsonObject> builder);
}

Add javadoc for ALIAS