org.osgi.service.http.runtime.dto.FailedErrorPageDTO Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*******************************************************************************
* Copyright (c) Contributors to the Eclipse Foundation
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
*******************************************************************************/
package org.osgi.service.http.runtime.dto;
/**
* Represents a {@code javax.servlet.Servlet} service registered as an error
* page but currently not being used by a servlet context due to a problem.
*
* As the servlet represented by this DTO is not used due to a failure, the
* field {@link FailedErrorPageDTO#servletContextId} always returns {@code 0}
* and does not point to an existing {@code ServletContextHelper}.
*
* @NotThreadSafe
* @author $Id: 825431b9b203fc72787b0f59e94a69c09d3669dc $
*/
public class FailedErrorPageDTO extends ErrorPageDTO {
/**
* The reason why the servlet represented by this DTO is not used.
*
* @see DTOConstants#FAILURE_REASON_UNKNOWN
* @see DTOConstants#FAILURE_REASON_EXCEPTION_ON_INIT
* @see DTOConstants#FAILURE_REASON_NO_SERVLET_CONTEXT_MATCHING
* @see DTOConstants#FAILURE_REASON_SERVICE_NOT_GETTABLE
* @see DTOConstants#FAILURE_REASON_SERVLET_CONTEXT_FAILURE
* @see DTOConstants#FAILURE_REASON_SHADOWED_BY_OTHER_SERVICE
*/
public int failureReason;
}