1 files changed, 77 insertions, 0 deletions
diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/HttpServletServer.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/HttpServletServer.java
new file mode 100644
index 00000000..d62eb028
--- /dev/null
+++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/HttpServletServer.java
@@ -0,0 +1,77 @@
+/*
+ * ============LICENSE_START=======================================================
+ * policy-endpoints
+ * ================================================================================
+ * Copyright (C) 2017-2018 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.onap.policy.common.endpoints.http.server;
+
+import org.onap.policy.common.capabilities.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 servlet path
+     * @param restClass JAX-RS API Class
+     * 
+     * @throws IllegalArgumentException unable to process because of invalid input
+     * @throws IllegalStateException unable to process because of invalid state
+     */
+    public void addServletClass(String servletPath, String restClass);
+
+    /**
+     * adds a package containing JAX-RS classes to serve REST requests
+     * 
+     * @param servletPath servlet path
+     * @param restPackage JAX-RS package to scan
+     * 
+     * @throws IllegalArgumentException unable to process because of invalid input
+     * @throws IllegalStateException unable to process because of invalid state
+     */
+    public void addServletPackage(String servletPath, String restPackage);
+
+    /**
+     * 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
+     * @throws InterruptedException if the blocking operation is interrupted
+     */
+    public boolean waitedStart(long maxWaitTime) throws InterruptedException;
+}