com.adobe.acs.commons.httpcache.engine.impl.HttpCacheEngineMBean Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation

Core ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.6.0

Show newest version

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2015 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 com.adobe.acs.commons.httpcache.engine.impl;

import com.adobe.acs.commons.httpcache.exception.HttpCacheKeyCreationException;
import com.adobe.acs.commons.httpcache.exception.HttpCachePersistenceException;
import com.adobe.granite.jmx.annotation.Description;
import com.adobe.granite.jmx.annotation.Name;

import javax.management.openmbean.OpenDataException;
import javax.management.openmbean.TabularData;

/**
 * JMX MBean for Http Cache Engine.
 */
@Description("ACS AEM Commons - Http Cache - Engine")
public interface HttpCacheEngineMBean {

    @Description("Registered Http Cache Rules")
    TabularData getRegisteredHttpCacheRules() throws OpenDataException;

    @Description("Registered Http Cache Configs")
    TabularData getRegisteredHttpCacheConfigs() throws OpenDataException;

    @Description("Registered Persistence Stores")
    TabularData getRegisteredPersistenceStores() throws OpenDataException;

    @Description("Invalidate")
    void invalidateCache(@Name(value="Path") String path) throws HttpCachePersistenceException, HttpCacheKeyCreationException;
}