mirror of
https://github.com/google/nomulus.git
synced 2025-05-08 15:58:21 +02:00
bdc41edd34
Currently we try to reimplemnet the same behavior of the existing code as much as possible. We only fix issues that go against the RFC7483, but we don't yet update the code to follow the latest (15feb19) RDAP Response Profile. That will require a much bigger change especially for the test files, so it'll wait for a followup CL. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=246948018
88 lines
3 KiB
Java
88 lines
3 KiB
Java
// Copyright 2017 The Nomulus Authors. 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.
|
|
|
|
package google.registry.rdap;
|
|
|
|
import static google.registry.request.Action.Method.GET;
|
|
import static google.registry.request.Action.Method.HEAD;
|
|
|
|
import google.registry.rdap.RdapDataStructures.Link;
|
|
import google.registry.rdap.RdapDataStructures.Notice;
|
|
import google.registry.rdap.RdapMetrics.EndpointType;
|
|
import google.registry.rdap.RdapObjectClasses.HelpResponse;
|
|
import google.registry.request.Action;
|
|
import google.registry.request.HttpException.NotFoundException;
|
|
import google.registry.request.auth.Auth;
|
|
import java.util.Optional;
|
|
import javax.inject.Inject;
|
|
|
|
/** RDAP (new WHOIS) action for help requests. */
|
|
@Action(
|
|
service = Action.Service.PUBAPI,
|
|
path = "/rdap/help",
|
|
method = {GET, HEAD},
|
|
isPrefix = true,
|
|
auth = Auth.AUTH_PUBLIC_ANONYMOUS)
|
|
public class RdapHelpAction extends RdapActionBase {
|
|
|
|
/** The help path for the RDAP terms of service. */
|
|
public static final String TOS_PATH = "/tos";
|
|
|
|
private static final String RDAP_HELP_LINK =
|
|
"https://github.com/google/nomulus/blob/master/docs/rdap.md";
|
|
|
|
@Inject public RdapHelpAction() {
|
|
super("help", EndpointType.HELP);
|
|
}
|
|
|
|
private Notice createHelpNotice() {
|
|
String linkValue = rdapJsonFormatter.makeRdapServletRelativeUrl("help");
|
|
Link.Builder linkBuilder =
|
|
Link.builder()
|
|
.setValue(linkValue)
|
|
.setRel("alternate")
|
|
.setHref(RDAP_HELP_LINK)
|
|
.setType("text/html");
|
|
return Notice.builder()
|
|
.setTitle("RDAP Help")
|
|
.setDescription(
|
|
"domain/XXXX",
|
|
"nameserver/XXXX",
|
|
"entity/XXXX",
|
|
"domains?name=XXXX",
|
|
"domains?nsLdhName=XXXX",
|
|
"domains?nsIp=XXXX",
|
|
"nameservers?name=XXXX",
|
|
"nameservers?ip=XXXX",
|
|
"entities?fn=XXXX",
|
|
"entities?handle=XXXX",
|
|
"help/XXXX")
|
|
.addLink(linkBuilder.build())
|
|
.build();
|
|
}
|
|
|
|
@Override
|
|
public HelpResponse getJsonObjectForResource(
|
|
String pathSearchString, boolean isHeadRequest) {
|
|
if (pathSearchString.isEmpty() || pathSearchString.equals("/")) {
|
|
return HelpResponse.create(Optional.of(createHelpNotice()));
|
|
}
|
|
if (pathSearchString.equals(TOS_PATH)) {
|
|
// A TOS notice is added to every reply automatically, so we don't want to add another one
|
|
// here
|
|
return HelpResponse.create(Optional.empty());
|
|
}
|
|
throw new NotFoundException("no help found for " + pathSearchString);
|
|
}
|
|
}
|