RuntimeDTO.java

/*
 * Copyright (c) OSGi Alliance (2012, 2017). All Rights Reserved.
 * 
 * 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 org.osgi.service.http.runtime.dto;

import org.osgi.dto.DTO;
import org.osgi.framework.dto.ServiceReferenceDTO;

/**
 * Represents the state of a Http Service Runtime.
 * 
 * @NotThreadSafe
 * @author $Id$
 */
public class RuntimeDTO extends DTO {

	/**
	 * The DTO for the corresponding
	 * {@code org.osgi.service.http.runtime.HttpServiceRuntime}. This value is
	 * never {@code null}.
	 */
	public ServiceReferenceDTO			serviceDTO;

	/**
	 * Returns the representations of the
	 * {@code org.osgi.service.http.whiteboard.Preprocessor} objects used by the
	 * Http Service Runtime. The returned array may be empty if the Http Service
	 * Runtime is currently not using any
	 * {@code  org.osgi.service.http.whiteboard.Preprocessor} objects.
	 * 
	 * @since 1.1.0
	 */
	public PreprocessorDTO[]			preprocessorDTOs;

	/**
	 * Returns the representations of the {@code javax.servlet.ServletContext}
	 * objects used by the Http Service Runtime. The returned array may be empty
	 * if the Http Service Runtime is currently not using any
	 * {@code javax.servlet.ServletContext} objects.
	 */
	public ServletContextDTO[]			servletContextDTOs;

	/**
	 * Returns the representations of the {@code javax.servlet.ServletContext}
	 * objects currently not used by the Http service runtime due to some
	 * problem. The returned array may be empty.
	 */
	public FailedServletContextDTO[] failedServletContextDTOs;

	/**
	 * Returns the representations of the {@code javax.servlet.Servlet} services
	 * associated with this runtime but currently not used due to some problem.
	 * The returned array may be empty.
	 */
	public FailedServletDTO[] failedServletDTOs;

	/**
	 * Returns the representations of the resources associated with this runtime
	 * but currently not used due to some problem. The returned array may be
	 * empty.
	 */
	public FailedResourceDTO[] failedResourceDTOs;

	/**
	 * Returns the representations of the servlet
	 * {@code org.osgi.service.http.whiteboard.Preprocessor} services associated
	 * with this runtime but currently not used due to some problem. The
	 * returned array may be empty.
	*
	 * since 1.1
	 */
	public FailedPreprocessorDTO[]		failedPreprocessorDTOs;

	/**
	 * Returns the representations of the {@code javax.servlet.Filter} services
	 * associated with this runtime but currently not used due to some problem.
	 * The returned array may be empty.
	 */
	public FailedFilterDTO[] failedFilterDTOs;

	/**
	 * Returns the representations of the error page
	 * {@code javax.servlet.Servlet} services associated with this runtime but
	 * currently not used due to some problem. The returned array may be empty.
	 */
	public FailedErrorPageDTO[] failedErrorPageDTOs;

	/**
	 * Returns the representations of the listeners associated with this runtime
	 * but currently not used due to some problem. The returned array may be
	 * empty.
	 */
	public FailedListenerDTO[] failedListenerDTOs;
}