| package org.apache.archiva.redback.rest.api.services.v2; |
| |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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. |
| */ |
| |
| import io.swagger.v3.oas.annotations.Operation; |
| import io.swagger.v3.oas.annotations.responses.ApiResponse; |
| import org.apache.archiva.redback.authorization.RedbackAuthorization; |
| import org.apache.archiva.redback.rest.api.model.ActionStatus; |
| import org.apache.archiva.redback.rest.api.model.LoginRequest; |
| import org.apache.archiva.redback.rest.api.model.PingResult; |
| import org.apache.archiva.redback.rest.api.model.RefreshTokenRequest; |
| import org.apache.archiva.redback.rest.api.model.RequestTokenRequest; |
| import org.apache.archiva.redback.rest.api.model.Token; |
| import org.apache.archiva.redback.rest.api.model.TokenResponse; |
| import org.apache.archiva.redback.rest.api.model.User; |
| import org.apache.archiva.redback.rest.api.services.RedbackServiceException; |
| |
| import javax.ws.rs.GET; |
| import javax.ws.rs.POST; |
| import javax.ws.rs.Path; |
| import javax.ws.rs.Produces; |
| import javax.ws.rs.QueryParam; |
| import javax.ws.rs.core.MediaType; |
| |
| /** |
| * Version 2 of authentication service |
| */ |
| @Path( "/auth" ) |
| public interface AuthenticationService |
| { |
| |
| @Path( "ping" ) |
| @GET |
| @Produces( { MediaType.APPLICATION_JSON } ) |
| @RedbackAuthorization( noRestriction = true ) |
| PingResult ping() |
| throws RedbackServiceException; |
| |
| |
| @Path( "ping/authenticated" ) |
| @GET |
| @Produces( { MediaType.APPLICATION_JSON } ) |
| @RedbackAuthorization( noRestriction = false, noPermission = true ) |
| PingResult pingWithAutz() |
| throws RedbackServiceException; |
| |
| /** |
| * Check username/password and return a bearer token. |
| * The bearer token can be added to the HTTP header on further requests to authenticate. |
| * |
| */ |
| @Path( "token" ) |
| @POST |
| @RedbackAuthorization( noRestriction = true, noPermission = true ) |
| @Produces( { MediaType.APPLICATION_JSON } ) |
| @Operation( summary = "Authenticate by user/password login and return a bearer token, usable for further requests", |
| responses = { |
| @ApiResponse( description = "The bearer token. The token data contains the token string that should be added to the Bearer header" ) |
| } |
| ) |
| TokenResponse logIn( RequestTokenRequest loginRequest ) |
| throws RedbackServiceException; |
| |
| /** |
| * Renew the bearer token. The request must send a bearer token in the HTTP header |
| * |
| */ |
| @Path( "refresh" ) |
| @POST |
| @RedbackAuthorization( noRestriction = false, noPermission = true ) |
| @Produces( { MediaType.APPLICATION_JSON } ) |
| @Operation( summary = "Creates a new bearer token. The requester must present a still valid bearer token in the HTTP header.", |
| responses = { |
| @ApiResponse( description = "The new bearer token," ) |
| } |
| ) |
| TokenResponse refreshToken( RefreshTokenRequest refreshTokenRequest ) |
| throws RedbackServiceException; |
| |
| |
| /** |
| * simply check if current user has an http session opened with authz passed and return user data |
| * @since 1.4 |
| */ |
| @Path( "authenticated" ) |
| @GET |
| @Produces( { MediaType.APPLICATION_JSON } ) |
| @RedbackAuthorization( noRestriction = true ) |
| User getAuthenticatedUser() |
| throws RedbackServiceException; |
| |
| } |