/*-
 * ============LICENSE_START=======================================================
 * policy-endpoints
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. 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.
 * ============LICENSE_END=========================================================
 */
package org.openecomp.policy.drools.http.server;

import org.openecomp.policy.drools.properties.Startable;

/**
 * A Jetty Server to server REST Requests
 */
public interface HttpServletServer extends Startable {

	/**
	 * 
	 * @return port
	 */
	public int getPort();
	
	/**
	 * enables basic authentication with user and password on the the relative path relativeUriPath
	 * 
	 * @param user
	 * @param password
	 * @param relativeUriPath
	 */
	public void setBasicAuthentication(String user, String password, String relativeUriPath);

	/**
	 * adds a JAX-RS servlet class to serve REST requests
	 * 
	 * @param servletPath
	 * @param restClass
	 * @throws IllegalArgumentException
	 * @throws IllegalStateException
	 */
	public void addServletClass(String servletPath, String restClass) 
			throws IllegalArgumentException, IllegalStateException;

	/**
	 * adds a package containing JAX-RS classes to serve REST requests
	 * 
	 * @param servletPath
	 * @param restPackage
	 * @throws IllegalArgumentException
	 * @throws IllegalStateException
	 */
	public void addServletPackage(String servletPath, String restPackage) 
			throws IllegalArgumentException, IllegalStateException;
	
	/**
	 * blocking start of the http server
	 * 
	 * @param maxWaitTime max time to wait for the start to take place
	 * @return true if start was successful
	 * 
	 * @throws IllegalArgumentException if arguments are invalid
	 */
	public boolean waitedStart(long maxWaitTime) throws IllegalArgumentException;
	
	
	/**
	 * factory for managing and tracking DMAAP sources
	 */
	public static HttpServletServerFactory factory = new IndexedHttpServletServerFactory();
}