Skip to content

Experiment: Add HTTP verb annotations to all web methods #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
daniel-beck wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Experiment: Add HTTP verb annotations to all web methods #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
897c9aa
Add HTTP verb annotations to all web methods
daniel-beck Jan 28, 2021
edf280f
Merge branch 'master' into verbs-everywhere
daniel-beck Mar 16, 2022
b880348
Merge branch 'jenkinsci:master' into verbs-everywhere
daniel-beck Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions ...main/java/com/cloudbees/hudson/plugins/folder/properties/AuthorizationMatrixProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.verb.GET;
import org.kohsuke.stapler.verb.POST;

import java.io.IOException;
import java.util.Collections;
Expand Down Expand Up @@ -99,7 +100,7 @@
protected AuthorizationMatrixProperty() {
}

// TODO(3.0) How is this used?

Check warning on line 103 in src/main/java/com/cloudbees/hudson/plugins/folder/properties/AuthorizationMatrixProperty.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
(3.0) How is this used?
@Deprecated
public AuthorizationMatrixProperty(Map<Permission,? extends Set<String>> grantedPermissions) {
for (Map.Entry<Permission,? extends Set<String>> e : grantedPermissions.entrySet()) {
Expand Down Expand Up @@ -166,6 +167,7 @@
}

@GET
@POST
Copy link
Member

@jglick jglick Feb 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete @GET and set checkMethod="post".

public FormValidation doCheckName(@AncestorInPath AbstractFolder<?> folder, @QueryParameter String value) {
return doCheckName_(value, folder, Item.CONFIGURE);
}
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/hudson/security/AuthorizationMatrixProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.verb.GET;
import org.kohsuke.stapler.verb.POST;

/**
* {@link JobProperty} to associate ACL for each project.
Expand All @@ -79,7 +80,7 @@
* <p>
* Once created (and initialized), this object becomes immutable.
*/
// TODO attempt to make this OptionalJobProperty

Check warning on line 83 in src/main/java/hudson/security/AuthorizationMatrixProperty.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
attempt to make this OptionalJobProperty
public class AuthorizationMatrixProperty extends JobProperty<Job<?, ?>> implements AuthorizationProperty {

private final transient SidACL acl = new AclImpl();
Expand Down Expand Up @@ -109,7 +110,7 @@
/**
* @since 3.0
*/
// TODO(3.0) is this even needed? Why is the no-arg constructor private?

Check warning on line 113 in src/main/java/hudson/security/AuthorizationMatrixProperty.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
(3.0) is this even needed? Why is the no-arg constructor private?
public AuthorizationMatrixProperty(Map<Permission, Set<PermissionEntry>> grantedPermissions, InheritanceStrategy inheritanceStrategy) {
this.inheritanceStrategy = inheritanceStrategy;
grantedPermissions.forEach((key, value) -> {
Expand Down Expand Up @@ -205,6 +206,7 @@
}

@GET
@POST
public FormValidation doCheckName(@AncestorInPath Job<?, ?> project, @QueryParameter String value) {
return doCheckName_(value, project, Item.CONFIGURE);
}
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/hudson/security/GlobalMatrixAuthorizationStrategy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.verb.GET;
import org.kohsuke.stapler.verb.POST;

import java.util.Arrays;
import java.util.Collections;
Expand All @@ -62,7 +64,7 @@
/**
* Role-based authorization via a matrix.
*/
// TODO: think about the concurrency commitment of this class

Check warning on line 67 in src/main/java/hudson/security/GlobalMatrixAuthorizationStrategy.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
think about the concurrency commitment of this class
public class GlobalMatrixAuthorizationStrategy extends AuthorizationStrategy implements AuthorizationContainer {
private final transient SidACL acl = new AclImpl();

Expand Down Expand Up @@ -164,7 +166,7 @@

@Override
public AuthorizationStrategy newInstance(StaplerRequest req, @NonNull JSONObject formData) throws FormException {
// TODO Is there a way to pull this up into AuthorizationContainerDescriptor and share code with AuthorizationPropertyDescriptor?

Check warning on line 169 in src/main/java/hudson/security/GlobalMatrixAuthorizationStrategy.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
Is there a way to pull this up into AuthorizationContainerDescriptor and share code with AuthorizationPropertyDescriptor?
GlobalMatrixAuthorizationStrategy globalMatrixAuthorizationStrategy = create();
Map<String,Object> data = formData.getJSONObject("data");

Expand Down Expand Up @@ -218,6 +220,8 @@
}

@Restricted(NoExternalUse.class)
@GET
@POST
public FormValidation doCheckName(@QueryParameter String value ) {
return doCheckName_(value, Jenkins.get(), Jenkins.ADMINISTER);
}
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainerDescriptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.verb.GET;
import org.kohsuke.stapler.verb.POST;

import edu.umd.cs.findbugs.annotations.NonNull;

Expand Down Expand Up @@ -140,6 +142,8 @@

// Not used directly by Stapler due to the trailing _ (this prevented method confusion around 1.415).
@Restricted(NoExternalUse.class)
@GET
@POST
default FormValidation doCheckName_(@NonNull String value, @NonNull AccessControlled subject, @NonNull Permission permission) {

final String unbracketedValue = value.substring(1, value.length() - 1); // remove leading [ and trailing ]
Expand Down Expand Up @@ -191,13 +195,13 @@
if (groupValidation != null) {
return groupValidation;
}
return FormValidation.errorWithMarkup(formatNonExistentUserGroupValidationResponse(escapedSid, "Group not found")); // TODO i18n (after 3.0)

Check warning on line 198 in src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainerDescriptor.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
i18n (after 3.0)
case USER:
userValidation = ValidationUtil.validateUser(sid, sr, false);
if (userValidation != null) {
return userValidation;
}
return FormValidation.errorWithMarkup(formatNonExistentUserGroupValidationResponse(escapedSid, "User not found")); // TODO i18n (after 3.0)

Check warning on line 204 in src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainerDescriptor.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
i18n (after 3.0)
case EITHER:
userValidation = ValidationUtil.validateUser(sid, sr, true);
if (userValidation != null) {
Expand All @@ -207,7 +211,7 @@
if (groupValidation != null) {
return groupValidation;
}
return FormValidation.errorWithMarkup(formatNonExistentUserGroupValidationResponse(escapedSid, "User or group not found")); // TODO i18n (after 3.0)

Check warning on line 214 in src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationContainerDescriptor.java

View check run for this annotation

ci.jenkins.io / Open Tasks Scanner

TODO 

NORMAL:
i18n (after 3.0)
default:
return FormValidation.error("Unexpected type: " + type);
}
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/org/jenkinsci/plugins/matrixauth/AuthorizationMatrixNodeProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
import org.kohsuke.stapler.AncestorInPath;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.verb.GET;
import org.kohsuke.stapler.verb.POST;

import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
Expand Down Expand Up @@ -179,6 +181,8 @@ public String getDisplayName() {
}

@Restricted(DoNotUse.class)
@GET
@POST
public FormValidation doCheckName(@AncestorInPath Computer computer, @QueryParameter String value) {
// Computer isn't a DescriptorByNameOwner before Jenkins 2.78, and then @AncestorInPath doesn't work
return doCheckName_(value,
Expand Down
Loading