com.github.tomakehurst.wiremock.http.AdminRequestHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wiremock-standalone Show documentation
Show all versions of wiremock-standalone Show documentation
A web service test double for all occasions
/*
* Copyright (C) 2011 Thomas Akehurst
*
* 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 com.github.tomakehurst.wiremock.http;
import com.github.tomakehurst.wiremock.admin.AdminRoutes;
import com.github.tomakehurst.wiremock.admin.AdminTask;
import com.github.tomakehurst.wiremock.admin.AdminUriTemplate;
import com.github.tomakehurst.wiremock.admin.NotFoundException;
import com.github.tomakehurst.wiremock.admin.model.PathParams;
import com.github.tomakehurst.wiremock.core.Admin;
import com.github.tomakehurst.wiremock.security.Authenticator;
import com.github.tomakehurst.wiremock.stubbing.ServeEvent;
import com.github.tomakehurst.wiremock.verification.LoggedRequest;
import java.net.URI;
import static com.github.tomakehurst.wiremock.common.LocalNotifier.notifier;
import static com.github.tomakehurst.wiremock.core.WireMockApp.ADMIN_CONTEXT_ROOT;
public class AdminRequestHandler extends AbstractRequestHandler {
private final AdminRoutes adminRoutes;
private final Admin admin;
private final Authenticator authenticator;
private final boolean requireHttps;
public AdminRequestHandler(AdminRoutes adminRoutes, Admin admin, ResponseRenderer responseRenderer, Authenticator authenticator, boolean requireHttps) {
super(responseRenderer);
this.adminRoutes = adminRoutes;
this.admin = admin;
this.authenticator = authenticator;
this.requireHttps = requireHttps;
}
@Override
public ServeEvent handleRequest(Request request) {
if (requireHttps && !URI.create(request.getAbsoluteUrl()).getScheme().equals("https")) {
notifier().info("HTTPS is required for admin requests, sending upgrade redirect");
return ServeEvent.of(
LoggedRequest.createFrom(request),
ResponseDefinition.notPermitted("HTTPS is required for accessing the admin API")
);
}
if (!authenticator.authenticate(request)) {
notifier().info("Authentication failed for " + request.getMethod() + " " + request.getUrl());
return ServeEvent.of(
LoggedRequest.createFrom(request),
ResponseDefinition.notAuthorised()
);
}
notifier().info("Received request to " + request.getUrl() + " with body " + request.getBodyAsString());
String path = URI.create(withoutAdminRoot(request.getUrl())).getPath();
try {
AdminTask adminTask = adminRoutes.taskFor(request.getMethod(), path);
AdminUriTemplate uriTemplate = adminRoutes.requestSpecForTask(adminTask.getClass()).getUriTemplate();
PathParams pathParams = uriTemplate.parse(path);
return ServeEvent.of(
LoggedRequest.createFrom(request),
adminTask.execute(admin, request, pathParams)
);
} catch (NotFoundException e) {
return ServeEvent.forUnmatchedRequest(LoggedRequest.createFrom(request));
}
}
private static String withoutAdminRoot(String url) {
return url.replace(ADMIN_CONTEXT_ROOT, "");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy