mirror of
https://github.com/google/nomulus.git
synced 2025-05-01 12:37:52 +02:00
a4f85c33c0
Our goal is to be able to address every Action by looking at the class itself, and to make it clearer at a glance what you need to access the Action's endpoint Currently, we can know from the @Action annotation: - the endpoint path - the Method needed - the authentication level needed This CL adds the service where the Action is hosted, which also translates to the URL. NOTE - currently we don't have any Action hosted on multiple services. I don't think we will ever need it (since they do the same thing no matter which service they are on, so why host it twice?), but if we do we'll have to update the code to allow it. The next step after this is to make sure all the @Parameters are defined on the Action itself, and then we will be able to craft access to the endpoint programatically (or at least verify at run-time we crafted a correct URL) ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=229375735
70 lines
2.3 KiB
Java
70 lines
2.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 com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableMap;
|
|
import google.registry.rdap.RdapJsonFormatter.BoilerplateType;
|
|
import google.registry.rdap.RdapMetrics.EndpointType;
|
|
import google.registry.request.Action;
|
|
import google.registry.request.auth.Auth;
|
|
import javax.inject.Inject;
|
|
|
|
/** RDAP (new WHOIS) action for help requests. */
|
|
@Action(
|
|
service = Action.Service.PUBAPI,
|
|
path = RdapHelpAction.PATH,
|
|
method = {GET, HEAD},
|
|
isPrefix = true,
|
|
auth = Auth.AUTH_PUBLIC_ANONYMOUS)
|
|
public class RdapHelpAction extends RdapActionBase {
|
|
|
|
public static final String PATH = "/rdap/help";
|
|
|
|
@Inject public RdapHelpAction() {}
|
|
|
|
@Override
|
|
public String getHumanReadableObjectTypeName() {
|
|
return "help";
|
|
}
|
|
|
|
@Override
|
|
public EndpointType getEndpointType() {
|
|
return EndpointType.HELP;
|
|
}
|
|
|
|
@Override
|
|
public String getActionPath() {
|
|
return PATH;
|
|
}
|
|
|
|
@Override
|
|
public ImmutableMap<String, Object> getJsonObjectForResource(
|
|
String pathSearchString, boolean isHeadRequest) {
|
|
// We rely on addTopLevelEntries to notice if we are sending the TOS notice, and not add a
|
|
// duplicate boilerplate entry.
|
|
ImmutableMap.Builder<String, Object> builder = new ImmutableMap.Builder<>();
|
|
rdapJsonFormatter.addTopLevelEntries(
|
|
builder,
|
|
BoilerplateType.OTHER,
|
|
ImmutableList.of(rdapJsonFormatter.getJsonHelpNotice(pathSearchString, fullServletPath)),
|
|
ImmutableList.of(),
|
|
fullServletPath);
|
|
return builder.build();
|
|
}
|
|
}
|