org.mule.runtime.api.config.custom.CustomizationService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-api Show documentation
API for Mule Runtime
There is a newer version: 1.1.1
/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.runtime.api.config.custom;

import org.mule.runtime.api.lifecycle.Lifecycle;

/**
 * Interface that allows to customize the set of services provided by the {@code MuleContext}.
 *
 * It's possible to add new services or replace default implementation for services specifying a service implementation or a
 * services class.
 *
 * For replacing an existent service, the service identifier must be used. Make sure to use the same constants
 * as the runtime.
 *
 * @since 1.0
 */
public interface CustomizationService {

  /**
   * Allows to override a service provided by default on a mule context. The provided implementation will be used instead of the
   * default one if it's replacing an existent service.
   * 
   * The service implementation can be annotated with @Inject and implement methods from
   * {@link Lifecycle}.
   * 

   * The service identifier can be used to locate the service in the mule registry.
   *
   * @param serviceId identifier of the services implementation to customize.
   * @param serviceImpl the service implementation instance
   * @param  the service type
   */
   void overrideDefaultServiceImpl(String serviceId, T serviceImpl);

  /**
   * Allows to override a service provided by default on a mule context. The provided class will be used to instantiate the
   * service that replaces the default one if it's replacing an existent service.
   * 

   * The service class can be annotated with {@code javax.inject.Inject} and implement methods from
   * {@link Lifecycle}.
   *
   * @param serviceId identifier of the services implementation to customize.
   * @param serviceClass the service class
   * @param  the service type
   */
   void overrideDefaultServiceClass(String serviceId, Class serviceClass);

  /**
   * Allows to define a custom service on a mule context.
   * 

   * The service implementation can be annotated with @Inject and implement methods from
   * {@link Lifecycle}.
   * 

   * The service identifier can be used to locate the service in the mule registry.
   *
   * @param serviceId identifier of the services implementation to register. Non empty.
   * @param serviceImpl the service implementation instance. Non null.
   * @param  the service type
   */
   void registerCustomServiceImpl(String serviceId, T serviceImpl);


  /**
   * Allows to define a custom service on a mule context. The provided class will be used to instantiate the service that replaces
   * the default one if it's replacing an existent service.
   * 
   * The service class can be annotated with {@code javax.inject.Inject} and implement methods from
   * {@link Lifecycle}.
   *
   * @param serviceId identifier of the services implementation to register. Non empty.
   * @param serviceClass the service class. Non null.
   * @param  the service type
   */
   void registerCustomServiceClass(String serviceId, Class serviceClass);
}