com.spotify.apollo.module.ApolloModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apollo-core Show documentation

There is a newer version: 1.5.0

/*
 * -\-\-
 * Spotify Apollo Service Core (aka Leto)
 * --
 * Copyright (C) 2013 - 2015 Spotify AB
 * --
 * Licensed 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 com.spotify.apollo.module;

import com.google.inject.Key;
import com.google.inject.Module;

import java.util.Set;

/**
 * A module that can be loaded by Apollo to add more functionality to a service.  DO NOT
 * USE this interface directly.  It is not part of the public API.  Instead, extend {@link
 * AbstractApolloModule} which is part of the public API.
 */
public interface ApolloModule extends Module {

  /**
   * Returns the id for this module.
   *
   * @return the id for this module.
   */
  String getId();

  /**
   * Returns the priority of this module relative to other modules.  A higher priority means that
   * initialization will happen earlier for this module.  This only matters for independent
   * components of module dependencies; dependencies will always be initialized before the
   * dependees.  The default ("don't care") priority is {@code 0.0}.
   *
   * @return the priority of this module relative to other modules.
   */
  double getPriority();

  /**
   * Returns the immutable, idempotently determined and stable set of injection keys that should be
   * bound to the service lifecycle; i.e. created on service start-up and destroyed on shutdown. All
   * the instances for the keys returned by this method that implement {@link java.io.Closeable}
   * will be closed on shutdown.
   *
   * @return the set of injection keys that should be bound to the service lifecycle.
   */
  Set> getLifecycleManaged();
}