FSClassLoaderMBean.java

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2017 - Adobe
 * %%
 * 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.
 * #L%
 */
package org.apache.sling.commons.fsclassloader;

import java.io.IOException;
import java.util.List;

import org.osgi.annotation.versioning.ProviderType;

/**
 * MBean interface for interacting with the FSClassLoader
 */
@ProviderType
public interface FSClassLoaderMBean {

	/**
	 * Clears the cache of compiled scripts from the FSClassLoader
	 */
	void clearCache();

	/**
	 * Gets the root directory at which the FSClassloader is creating it's
	 * cached files
	 *
	 * @return the file system classloader root
	 */
	String getFSClassLoaderRoot();

	/**
	 * Get the total count of scripts in the FSClassLoader cache
	 *
	 * @return the total number of scripts
	 * @throws IOException
	 */
	int getCachedScriptCount() throws IOException;

	/**
	 * Gets the scripts in the FSClassLoaderCache
	 *
	 * @return the scripts from the FSClassLoaderCache
	 * @throws IOException
	 */
	List<String> getCachedScripts() throws IOException;

}