org.springframework.boot.builder

Class SpringApplicationBuilder


  • public class SpringApplicationBuilder
extends Object
    Builder for SpringApplication and ApplicationContext instances with convenient fluent API and context hierarchy support. Simple example of a context hierarchy: 
     new SpringApplicationBuilder(ParentConfig.class).child(ChildConfig.class).run(args);
    Another common use case is setting default arguments, e.g. active Spring profiles, to set up the environment for an application: 
     new SpringApplicationBuilder(Application.class).profiles("server")
                .defaultArgs("--transport=local").run(args);

    If your needs are simpler, consider using the static convenience methods in SpringApplication instead.

    Author:
    Dave Syer

    • Constructor Detail

      • SpringApplicationBuilder

        public SpringApplicationBuilder(Object... sources)

    • Method Detail

      • context

        public org.springframework.context.ConfigurableApplicationContext context()
        Accessor for the current application context.
        Returns:
        the current application context (or null if not yet running)

      • application

        public SpringApplication application()
        Accessor for the current application.
        Returns:
        the current application (never null)

      • run

        public org.springframework.context.ConfigurableApplicationContext run(String... args)
        Create an application context (and its parent if specified) with the command line args provided. The parent is run first with the same arguments if has not yet been started.
        Parameters:
        args - the command line arguments
        Returns:
        an application context created from the current state

      • child

        public SpringApplicationBuilder child(Object... sources)
        Create a child application with the provided sources. Default args and environment are copied down into the child, but everything else is a clean sheet.
        Parameters:
        sources - the sources for the application (Spring configuration)
        Returns:
        the child application builder

      • parent

        public SpringApplicationBuilder parent(Object... sources)
        Add a parent application with the provided sources. Default args and environment are copied up into the parent, but everything else is a clean sheet.
        Parameters:
        sources - the sources for the application (Spring configuration)
        Returns:
        the parent builder

      • parent

        public SpringApplicationBuilder parent(org.springframework.context.ConfigurableApplicationContext parent)
        Add an already running parent context to an existing application.
        Parameters:
        parent - the parent context
        Returns:
        the current builder (not the parent)

      • sibling

        public SpringApplicationBuilder sibling(Object... sources)
        Create a sibling application (one with the same parent). A side effect of calling this method is that the current application (and its parent) are started.
        Parameters:
        sources - the sources for the application (Spring configuration)
        Returns:
        the new sibling builder

      • sibling

        public SpringApplicationBuilder sibling(Object[] sources,
                               String... args)
        Create a sibling application (one with the same parent). A side effect of calling this method is that the current application (and its parent) are started if they are not already running.
        Parameters:
        sources - the sources for the application (Spring configuration)
        args - the command line arguments to use when starting the current app and its parent
        Returns:
        the new sibling builder

      • contextClass

        public SpringApplicationBuilder contextClass(Class<? extends org.springframework.context.ConfigurableApplicationContext> cls)
        Explicitly set the context class to be used.
        Parameters:
        cls - the context class to use
        Returns:
        the current builder

      • sources

        public SpringApplicationBuilder sources(Object... sources)
        Add more sources to use in this application.
        Parameters:
        sources - the sources to add
        Returns:
        the current builder

      • sources

        public SpringApplicationBuilder sources(Class<?>... sources)
        Add more sources (configuration classes and components) to this application
        Parameters:
        sources - the sources to add
        Returns:
        the current builder

      • web

        public SpringApplicationBuilder web(boolean webEnvironment)
        Flag to explicitly request a web or non-web environment (auto detected based on classpath if not set).
        Parameters:
        webEnvironment - the flag to set
        Returns:
        the current builder

      • logStartupInfo

        public SpringApplicationBuilder logStartupInfo(boolean logStartupInfo)
        Flag to indicate the startup information should be logged.
        Parameters:
        logStartupInfo - the flag to set. Default true.
        Returns:
        the current builder

      • showBanner

        public SpringApplicationBuilder showBanner(boolean showBanner)
        Flag to indicate the startup banner should be printed.
        Parameters:
        showBanner - the flag to set. Default true.
        Returns:
        the current builder

      • headless

        public SpringApplicationBuilder headless(boolean headless)
        Sets if the application is headless and should not instantiate AWT. Defaults to true to prevent java icons appearing.
        Parameters:
        headless - if the application is headless
        Returns:
        the current builder

      • registerShutdownHook

        public SpringApplicationBuilder registerShutdownHook(boolean registerShutdownHook)
        Sets if the created ApplicationContext should have a shutdown hook registered.

      • main

        public SpringApplicationBuilder main(Class<?> mainApplicationClass)
        Fixes the main application class that is used to anchor the startup messages.
        Parameters:
        mainApplicationClass - the class to use.
        Returns:
        the current builder

      • addCommandLineProperties

        public SpringApplicationBuilder addCommandLineProperties(boolean addCommandLineProperties)
        Flag to indicate that command line arguments should be added to the environment.
        Parameters:
        addCommandLineProperties - the flag to set. Default true.
        Returns:
        the current builder

      • properties

        public SpringApplicationBuilder properties(String... defaultProperties)
        Default properties for the environment in the form key=value or key:value.
        Parameters:
        defaultProperties - the properties to set.
        Returns:
        the current builder

      • properties

        public SpringApplicationBuilder properties(Properties defaultProperties)
        Default properties for the environment in the form key=value or key:value.
        Parameters:
        defaultProperties - the properties to set.
        Returns:
        the current builder

      • profiles

        public SpringApplicationBuilder profiles(String... profiles)
        Add to the active Spring profiles for this app (and its parent and children).
        Parameters:
        profiles - the profiles to add.
        Returns:
        the current builder

      • beanNameGenerator

        public SpringApplicationBuilder beanNameGenerator(org.springframework.beans.factory.support.BeanNameGenerator beanNameGenerator)
        Bean name generator for automatically generated bean names in the application context.
        Parameters:
        beanNameGenerator - the generator to set.
        Returns:
        the current builder

      • environment

        public SpringApplicationBuilder environment(org.springframework.core.env.ConfigurableEnvironment environment)
        Environment for the application context.
        Parameters:
        environment - the environment to set.
        Returns:
        the current builder

      • resourceLoader

        public SpringApplicationBuilder resourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
        ResourceLoader for the application context. If a custom class loader is needed, this is where it would be added.
        Parameters:
        resourceLoader - the resource loader to set.
        Returns:
        the current builder

      • initializers

        public SpringApplicationBuilder initializers(org.springframework.context.ApplicationContextInitializer<?>... initializers)
        Add some initializers to the application (applied to the ApplicationContext before any bean definitions are loaded).
        Parameters:
        initializers - some initializers to add
        Returns:
        the current builder

      • listeners

        public SpringApplicationBuilder listeners(org.springframework.context.ApplicationListener<?>... listeners)
        Add some listeners to the application (listening for SpringApplication events as well as regular Spring events once the context is running). Any listeners that are also ApplicationContextInitializer will be added to the initializers automatically.
        Parameters:
        listeners - some listeners to add
        Returns:
        the current builder

Copyright © 2015 Pivotal Software, Inc.. All rights reserved.