Skip to content

HttpSigner interface changes #4017

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.

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

Conversation

gosar
Copy link
Contributor

@gosar gosar commented May 16, 2023

Motivation and Context

Modifications

Option to add Identity to the interface:

  • Make Identity explicit parameter in HttpSigner

Compare with option in #4018

Also,

  • Remove wildcards from sign methods

Other fixes:

  • Remove for HttpAuthOption.Builder.schemeId
  • Fix generics related warning in Signer interfaces

Usage for this option would look like:

HttpSigner<TokenIdentity> signer = new HttpSigner<TokenIdentity>() {
    @Override
    public SignedHttpRequest<ContentStreamProvider> sign(TokenIdentity identity,
                                                         HttpSignRequest<ContentStreamProvider> request) {
        // Do stuff while using
        // property = request.property(SignerProperty.create(String.class, "key"));
        // identity;
        return null;
    }

    @Override
    public SignedHttpRequest<Publisher<ByteBuffer>> signAsync(TokenIdentity identity, HttpSignRequest<Publisher<ByteBuffer>> request) {
        return null;
    }
};

TokenIdentity identity = TokenIdentity.create("token");
HttpSignRequest<ContentStreamProvider> request = HttpSignRequest
    .builder(ContentStreamProvider.class)
    .putProperty(SignerProperty.create(String.class, "key"), "value")
    .build();
signer.sign(identity, request);

Testing

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

@gosar gosar requested a review from a team as a code owner May 16, 2023 18:23
@gosar gosar mentioned this pull request May 16, 2023
12 tasks
@sonarqubecloud
Copy link

SonarCloud Quality Gate failed.    Quality Gate failed

Bug C 3 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 75 Code Smells

46.6% 46.6% Coverage
3.0% 3.0% Duplication

@gosar
Copy link
Contributor Author

gosar commented May 17, 2023

Between this PR and #4018, we decided to go with approach in #4018 so closing this PR.

@gosar gosar closed this May 17, 2023
@gosar gosar deleted the gosar/sra-ia-signer-interface-updates-1 branch May 24, 2023 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant