org.osgi.service.jaxrs.whiteboard/src/main/java/org/osgi/service/jaxrs/runtime/dto/RuntimeDTO.java

/*
 * Copyright (c) OSGi Alliance (2012, 2015). 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.jaxrs.runtime.dto;

import org.osgi.dto.DTO;
import org.osgi.framework.dto.ServiceReferenceDTO;
import org.osgi.resource.dto.ResourceDTO;
import org.osgi.service.jaxrs.runtime.JaxRSServiceRuntime;

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

	/**
	 * The DTO for the corresponding {@code JaxRSServiceRuntime}. This value is
	 * never {@code null}.
	 */
	public ServiceReferenceDTO		serviceDTO;

	/**
	 * The root context path. This path may be "/", or it may be a sub path if
	 * this {@link JaxRSServiceRuntime} is running within an external Http
	 * container.
	 */
	public String					contextPath;

	/**
	 * Returns the representations of the JAX-RS resource services associated
	 * with this Runtime.
	 * 
	 * The returned array may be empty if this context is currently not
	 * associated with any JAX-RS Resource services.
	 */
	public ResourceDTO[]			resourceDTOs;

	/**
	 * Returns the representations of the JAX-RS Filter services associated with
	 * this Runtime.
	 * 
	 * The returned array may be empty if this context is currently not
	 * associated with any JAX-RS Filter services.
	 */
	public FilterDTO[]				filterDTOs;

	/**
	 * Returns the representations of the JAX-RS Interceptor services associated
	 * with this Runtime.
	 * 
	 * The returned array may be empty if this context is currently not
	 * associated with any JAX-RS Filter services.
	 */
	public InterceptorDTO[]			interceptorDTOs;

	/**
	 * Returns the representations of the JAX-RS resource services associated
	 * with this runtime but currently not used due to some problem. The
	 * returned array may be empty.
	 */
	public FailedResourceDTO[]		failedServletDTOs;

	/**
	 * Returns the representations of the JAX-RS 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 JAX-RS Interceptor services associated
	 * with this runtime but currently not used due to some problem. The
	 * returned array may be empty.
	 */
	public FailedInterceptorDTO[]	failedErrorPageDTOs;
}