mirror of
https://github.com/google/nomulus.git
synced 2025-04-30 03:57:51 +02:00
c458c05801
The dark lord Gosling designed the Java package naming system so that ownership flows from the DNS system. Since we own the domain name registry.google, it seems only appropriate that we should use google.registry as our package name.
64 lines
2.4 KiB
Java
64 lines
2.4 KiB
Java
// Copyright 2016 The Domain Registry 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.request;
|
|
|
|
import java.lang.annotation.ElementType;
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.RetentionPolicy;
|
|
import java.lang.annotation.Target;
|
|
|
|
/** Annotation for {@link Runnable} actions accepting HTTP requests from {@link RequestHandler}. */
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.TYPE)
|
|
public @interface Action {
|
|
|
|
/** HTTP methods recognized by the request processor. */
|
|
public enum Method { GET, HEAD, POST }
|
|
|
|
/** HTTP path to serve the action from. The path components must be percent-escaped. */
|
|
String path();
|
|
|
|
/** Indicates all paths starting with this path should be accepted. */
|
|
boolean isPrefix() default false;
|
|
|
|
/** HTTP methods that request processor should allow. */
|
|
Method[] method() default Method.GET;
|
|
|
|
/**
|
|
* Indicates request processor should print "OK" to the HTTP client on success.
|
|
*
|
|
* <p>This is important because it's confusing to manually invoke a backend task and have a blank
|
|
* page show up. And it's not worth injecting a {@link Response} object just to do something so
|
|
* trivial.
|
|
*/
|
|
boolean automaticallyPrintOk() default false;
|
|
|
|
// TODO(b/26304887): Flip default to true.
|
|
/** Enables XSRF protection on all HTTP methods except GET and HEAD. */
|
|
boolean xsrfProtection() default false;
|
|
|
|
/** Arbitrary value included in the XSRF token hash. */
|
|
String xsrfScope() default "app";
|
|
|
|
/**
|
|
* Require user be logged-in or 302 redirect to the Google auth login page.
|
|
*
|
|
* <p><b>Warning:</b> DO NOT use this for cron and task queue endpoints.
|
|
*
|
|
* <p><b>Note:</b> Logged-in actions should also be guarded by a {@code <security-constraint>} in
|
|
* {@code web.xml} with {@code <role-name>*</role-name>}.
|
|
*/
|
|
boolean requireLogin() default false;
|
|
}
|