diff options
author | lresende <lresende@13f79535-47bb-0310-9956-ffa450edef68> | 2009-11-11 23:07:37 +0000 |
---|---|---|
committer | lresende <lresende@13f79535-47bb-0310-9956-ffa450edef68> | 2009-11-11 23:07:37 +0000 |
commit | 9f395ebf3ec27f89c8dc63137bc99c8d6b0cff6d (patch) | |
tree | 34231d72966aa918e80eea15602b6870d8b21641 /sca-java-1.x/branches/sca-java-1.2/modules/host-http/src/main/java/org/apache/tuscany/sca/host/http/ServletHost.java | |
parent | 07b7dfd1a70ba222b899d9813f8c449dbf3b785f (diff) |
Moving 1.x branches
git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@835125 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'sca-java-1.x/branches/sca-java-1.2/modules/host-http/src/main/java/org/apache/tuscany/sca/host/http/ServletHost.java')
-rw-r--r-- | sca-java-1.x/branches/sca-java-1.2/modules/host-http/src/main/java/org/apache/tuscany/sca/host/http/ServletHost.java | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/sca-java-1.x/branches/sca-java-1.2/modules/host-http/src/main/java/org/apache/tuscany/sca/host/http/ServletHost.java b/sca-java-1.x/branches/sca-java-1.2/modules/host-http/src/main/java/org/apache/tuscany/sca/host/http/ServletHost.java new file mode 100644 index 0000000000..4f51198d27 --- /dev/null +++ b/sca-java-1.x/branches/sca-java-1.2/modules/host-http/src/main/java/org/apache/tuscany/sca/host/http/ServletHost.java @@ -0,0 +1,111 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.tuscany.sca.host.http; + +import java.net.URL; + +import javax.servlet.RequestDispatcher; +import javax.servlet.Servlet; + +/** + * Interface implemented by host environments that allow Servlets to be + * registered. + * <p/> + * This interface allows a system service to register a servlet + * to handle inbound requests. + * + * @version $Rev$ $Date$ + */ +public interface ServletHost { + + /** + * Sets the default port for the server. + * + * @param port the default port + */ + void setDefaultPort(int port); + + /** + * Returns the default port for the server. + * + * @return the default port + */ + int getDefaultPort(); + + /** + * Add a mapping for an instance of a Servlet. This requests that the + * servlet container direct all requests to the designated mapping to the + * supplied Servlet instance. + * + * @param uri the uri-mapping for the Servlet + * @param servlet the Servlet that should be invoked + * @throws ServletMappingException + */ + void addServletMapping(String uri, Servlet servlet) throws ServletMappingException; + + /** + * Remove a servlet mapping. This directs the servlet container not to direct + * any more requests to a previously registered Servlet. + * + * @param uri the uri-mapping for the Servlet + * @return the servlet that was registered to the mapping, null if nothing + * was registered to the mapping + * @throws ServletMappingException + */ + Servlet removeServletMapping(String uri) throws ServletMappingException; + + /** + * Returns the servlet mapped to the given uri. + * + * @param uri the uri-mapping for the Servlet + * @return the servlet registered with the mapping + * @throws ServletMappingException + */ + Servlet getServletMapping(String uri) throws ServletMappingException; + + /** + * Returns a servlet request dispatcher for the servlet mapped to the specified uri. + * + * @param uri the uri mapped to a Servlet + * @return a RequestDispatcher that can be used to dispatch requests to + * that servlet + * @throws ServletMappingException + */ + RequestDispatcher getRequestDispatcher(String uri) throws ServletMappingException; + + /** + * Returns the portion of the request URI that indicates the context of the request + * + * @return a String specifying the portion of the request URI that indicates the context of the request + */ + String getContextPath(); + + /** + * Sets the portion of the request URI that indicates the context of the request + * + * @param path the context path + */ + void setContextPath(String path); + + /** + * Returns the complete URL mapped to the specified URI. + * @return the URL mapped to the specified URI + */ + URL getURLMapping(String uri); +} |