/*
* 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.tomcat.unittest;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Collections;
import java.util.Enumeration;
import java.util.EventListener;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import jakarta.servlet.Filter;
import jakarta.servlet.FilterRegistration;
import jakarta.servlet.RequestDispatcher;
import jakarta.servlet.Servlet;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRegistration;
import jakarta.servlet.ServletRegistration.Dynamic;
import jakarta.servlet.SessionCookieConfig;
import jakarta.servlet.SessionTrackingMode;
import jakarta.servlet.descriptor.JspConfigDescriptor;
import org.apache.catalina.core.ApplicationFilterRegistration;
import org.apache.tomcat.util.descriptor.web.FilterDef;
public class TesterServletContext implements ServletContext {
/**
* {@inheritDoc}
* <p>
* This test implementation is hard coded to return an empty String.
*/
@Override
public String getContextPath() {
return "";
}
/**
* {@inheritDoc}
* <p>
* This test implementation is hard coded to return an empty Set.
*/
@Override
public Set<String> getResourcePaths(String path) {
return Collections.emptySet();
}
/**
* {@inheritDoc}
* <p>
* This test implementation is hard coded to return the class loader that
* loaded this class.
*/
@Override
public ClassLoader getClassLoader() {
return getClass().getClassLoader();
}
@Override
public ServletContext getContext(String uripath) {
throw new RuntimeException("Not implemented");
}
@Override
public int getMajorVersion() {
throw new RuntimeException("Not implemented");
}
@Override
public int getMinorVersion() {
throw new RuntimeException("Not implemented");
}
@Override
public String getMimeType(String file) {
throw new RuntimeException("Not implemented");
}
@Override
public URL getResource(String path) throws MalformedURLException {
return null;
}
@Override
public InputStream getResourceAsStream(String path) {
throw new RuntimeException("Not implemented");
}
@Override
public RequestDispatcher getRequestDispatcher(String path) {
throw new RuntimeException("Not implemented");
}
@Override
public RequestDispatcher getNamedDispatcher(String name) {
throw new RuntimeException("Not implemented");
}
@Override
public void log(String msg) {
// NOOP
}
@Override
public void log(String message, Throwable throwable) {
// NOOP
}
@Override
public String getRealPath(String path) {
throw new RuntimeException("Not implemented");
}
@Override
public String getServerInfo() {
throw new RuntimeException("Not implemented");
}
@Override
public String getInitParameter(String name) {
return null;
}
@Override
public Enumeration<String> getInitParameterNames() {
throw new RuntimeException("Not implemented");
}
@Override
public Object getAttribute(String name) {
// Used by websockets
return null;
}
@Override
public Enumeration<String> getAttributeNames() {
throw new RuntimeException("Not implemented");
}
@Override
public void setAttribute(String name, Object object) {
throw new RuntimeException("Not implemented");
}
@Override
public void removeAttribute(String name) {
throw new RuntimeException("Not implemented");
}
@Override
public String getServletContextName() {
throw new RuntimeException("Not implemented");
}
@Override
public int getEffectiveMajorVersion() {
throw new RuntimeException("Not implemented");
}
@Override
public int getEffectiveMinorVersion() {
throw new RuntimeException("Not implemented");
}
@Override
public boolean setInitParameter(String name, String value) {
throw new RuntimeException("Not implemented");
}
@Override
public Dynamic addServlet(String servletName, String className) {
throw new RuntimeException("Not implemented");
}
@Override
public Dynamic addServlet(String servletName, Servlet servlet) {
throw new RuntimeException("Not implemented");
}
@Override
public Dynamic addServlet(String servletName,
Class<? extends Servlet> servletClass) {
throw new RuntimeException("Not implemented");
}
@Override
public Dynamic addJspFile(String jspName, String jspFile) {
throw new RuntimeException("Not implemented");
}
@Override
public <T extends Servlet> T createServlet(Class<T> c)
throws ServletException {
throw new RuntimeException("Not implemented");
}
@Override
public ServletRegistration getServletRegistration(String servletName) {
throw new RuntimeException("Not implemented");
}
@Override
public Map<String, ? extends ServletRegistration> getServletRegistrations() {
throw new RuntimeException("Not implemented");
}
@Override
public FilterRegistration.Dynamic addFilter(String filterName, String className) {
throw new RuntimeException("Not implemented");
}
@Override
public FilterRegistration.Dynamic addFilter(String filterName, Filter filter) {
return new ApplicationFilterRegistration(new FilterDef(), new TesterContext());
}
@Override
public FilterRegistration.Dynamic addFilter(String filterName, Class<? extends Filter> filterClass) {
return new ApplicationFilterRegistration(new FilterDef(), new TesterContext());
}
@Override
public <T extends Filter> T createFilter(Class<T> c)
throws ServletException {
throw new RuntimeException("Not implemented");
}
@Override
public FilterRegistration getFilterRegistration(String filterName) {
throw new RuntimeException("Not implemented");
}
@Override
public Map<String, ? extends FilterRegistration> getFilterRegistrations() {
throw new RuntimeException("Not implemented");
}
private SessionCookieConfig sessionCookieConfig = new TesterSessionCookieConfig();
@Override
public SessionCookieConfig getSessionCookieConfig() {
return sessionCookieConfig;
}
private final Set<SessionTrackingMode> sessionTrackingModes = new HashSet<>();
@Override
public void setSessionTrackingModes(
Set<SessionTrackingMode> sessionTrackingModes) {
this.sessionTrackingModes.clear();
this.sessionTrackingModes.addAll(sessionTrackingModes);
}
@Override
public Set<SessionTrackingMode> getDefaultSessionTrackingModes() {
throw new RuntimeException("Not implemented");
}
@Override
public Set<SessionTrackingMode> getEffectiveSessionTrackingModes() {
return sessionTrackingModes;
}
@Override
public void addListener(String className) {
throw new RuntimeException("Not implemented");
}
@Override
public <T extends EventListener> void addListener(T t) {
throw new RuntimeException("Not implemented");
}
@Override
public void addListener(Class<? extends EventListener> listenerClass) {
throw new RuntimeException("Not implemented");
}
@Override
public <T extends EventListener> T createListener(Class<T> c)
throws ServletException {
throw new RuntimeException("Not implemented");
}
@Override
public JspConfigDescriptor getJspConfigDescriptor() {
throw new RuntimeException("Not implemented");
}
@Override
public void declareRoles(String... roleNames) {
throw new RuntimeException("Not implemented");
}
/**
* {@inheritDoc}
* <p>
* This test implementation is hard coded to return <code>localhost</code>.
*/
@Override
public String getVirtualServerName() {
return "localhost";
}
@Override
public int getSessionTimeout() {
throw new RuntimeException("Not implemented");
}
@Override
public void setSessionTimeout(int sessionTimeout) {
throw new RuntimeException("Not implemented");
}
@Override
public String getRequestCharacterEncoding() {
throw new RuntimeException("Not implemented");
}
@Override
public void setRequestCharacterEncoding(String encoding) {
throw new RuntimeException("Not implemented");
}
@Override
public String getResponseCharacterEncoding() {
throw new RuntimeException("Not implemented");
}
@Override
public void setResponseCharacterEncoding(String encoding) {
throw new RuntimeException("Not implemented");
}
}