google-nomulus/java/google/registry/request/Action.java
mcilwain e2db3f914e Clean up some code quality issues
This removes some qualifiers that aren't necessary (e.g. public/abstract on interfaces, private on enum constructors, final on private methods, static on nested interfaces/enums), uses Java 8 lambdas and features where that's an improvement

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=177182945
2017-12-01 22:14:06 -05:00

51 lines
1.8 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.request;
import google.registry.request.auth.Auth;
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. */
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;
/** Authentication settings. */
Auth auth();
}