com.buschmais.xo.api.bootstrap.XOBootstrapService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xo.api Show documentation

There is a newer version: 2.5.0

package com.buschmais.xo.api.bootstrap;

import com.buschmais.xo.api.XOManagerFactory;

/**
 * Defines the service interface for bootstrapping the XO implementation.
 * It is not intended to be used directly by an application.
 */
public interface XOBootstrapService {

    /**
     * The resource name for XO descriptor files.
     */
    public static final String XO_DESCRIPTOR_RESOURCE = "META-INF/xo.xml";

    /**
     * Create a {@link com.buschmais.xo.api.XOManagerFactory} using the name of a XO unit.
     * XO units are defined in XML descriptors located as classpath resources with the name "/META-INF/xo.xml".
     *
     * @param unit The name of the XO unit.
     * @return The {@link com.buschmais.xo.api.XOManagerFactory}.
     */
    XOManagerFactory createXOManagerFactory(String unit);

    /**
     * Create a {@link com.buschmais.xo.api.XOManagerFactory} using the name of a XO unit.
     *
     * @param xoUnit The XO unit.
     * @return The {@link com.buschmais.xo.api.XOManagerFactory}.
     */
    XOManagerFactory createXOManagerFactory(XOUnit xoUnit);
}