com.adobe.acs.commons.wcm.ComponentErrorHandler Maven / Gradle / Ivy

Go to download

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

Main ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.9.4

Show newest version

/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 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.
 */

package com.adobe.acs.commons.wcm;

import org.apache.sling.api.SlingHttpServletRequest;

import org.osgi.annotation.versioning.ProviderType;

@ProviderType
@SuppressWarnings("squid:S1214")
public interface ComponentErrorHandler {
    /**
     * When attribute is set on the Request causes Component Error Handler implementation to be skipped.
     *
     * Ex: request.setAttribute(SUPPRESS_ATTR, true);
     */
    String SUPPRESS_ATTR = "com.adobe.acs.commons.wcm.component-error-handler.suppress";

    /**
     * Suppress component error handling for the Request.
     *
     * @param request Sling Request object
     */
    void suppressComponentErrorHandling(SlingHttpServletRequest request);

    /**
     * Allow component error handling for the Request.
     * Only useful after suppressComponentErrorHandling has been previously called.
     *
     * @param request Sling Request obj
     */
    void allowComponentErrorHandling(SlingHttpServletRequest request);

}