org.mule.runtime.api.metadata.MetadataContext 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.metadata;

import org.mule.metadata.api.ClassTypeLoader;
import org.mule.metadata.api.builder.BaseTypeBuilder;
import org.mule.runtime.api.connection.ConnectionException;
import org.mule.runtime.api.lifecycle.Disposable;

import java.util.Optional;

/**
 * Metadata resolving context, provides access to the Config and Connection used during
 * metadata fetch invocation.
 *
 * @since 1.0
 */
public interface MetadataContext extends Disposable {

  /**
   * @param  Configuration type
   * @return Optional instance of the configuration related to the component
   */
   Optional getConfig();

  /**
   * Retrieves the connection for the related a component and configuration
   *
   * @param  Connection type
   * @return Optional connection instance of {@param } type for the component.
   * @throws ConnectionException when not valid connection is found for the related component and configuration
   */
   Optional getConnection() throws ConnectionException;

  /**
   * @returns the {@link MetadataCache} associated with the {@link MetadataContext}.
   */
  MetadataCache getCache();

  /**
   * @return the {@link ClassTypeLoader} for the current {@link MetadataContext}.
   */
  ClassTypeLoader getTypeLoader();

  /**
   *
   * @return the {@link BaseTypeBuilder} for the current {@link MetadataContext}.
   */
  BaseTypeBuilder getTypeBuilder();
}