| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.archiva.redback.rest.api.services;</a> |
| <span class="sourceLineNo">002</span><a id="line.2"></a> |
| <span class="sourceLineNo">003</span><a id="line.3">/*</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> *</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a> |
| <span class="sourceLineNo">020</span><a id="line.20"> */</a> |
| <span class="sourceLineNo">021</span><a id="line.21"></a> |
| <span class="sourceLineNo">022</span><a id="line.22">import io.swagger.v3.oas.annotations.Operation;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import io.swagger.v3.oas.annotations.security.SecurityScheme;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import io.swagger.v3.oas.annotations.tags.Tag;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.authorization.RedbackAuthorization;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.rest.api.model.ActionStatus;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.rest.api.model.LoginRequest;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.rest.api.model.User;</a> |
| <span class="sourceLineNo">030</span><a id="line.30"></a> |
| <span class="sourceLineNo">031</span><a id="line.31">import javax.ws.rs.GET;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import javax.ws.rs.POST;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import javax.ws.rs.Path;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import javax.ws.rs.Produces;</a> |
| <span class="sourceLineNo">035</span><a id="line.35">import javax.ws.rs.QueryParam;</a> |
| <span class="sourceLineNo">036</span><a id="line.36">import javax.ws.rs.core.MediaType;</a> |
| <span class="sourceLineNo">037</span><a id="line.37"></a> |
| <span class="sourceLineNo">038</span><a id="line.38">@Deprecated</a> |
| <span class="sourceLineNo">039</span><a id="line.39">@Path( "/loginService/" )</a> |
| <span class="sourceLineNo">040</span><a id="line.40">@Tag(name = "v1")</a> |
| <span class="sourceLineNo">041</span><a id="line.41">@Tag(name = "v1/Login")</a> |
| <span class="sourceLineNo">042</span><a id="line.42">@SecurityScheme( scheme = "BasicAuth", type = SecuritySchemeType.HTTP )</a> |
| <span class="sourceLineNo">043</span><a id="line.43">public interface LoginService</a> |
| <span class="sourceLineNo">044</span><a id="line.44">{</a> |
| <span class="sourceLineNo">045</span><a id="line.45"></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> @Operation( deprecated = true )</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> @Path( "addAuthenticationKey" )</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> @GET</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> @RedbackAuthorization( noRestriction = true )</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> String addAuthenticationKey( @QueryParam( "providerKey" ) String providedKey,</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> @QueryParam( "principal" ) String principal, @QueryParam( "purpose" ) String purpose,</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> @QueryParam( "expirationMinutes" ) int expirationMinutes )</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">055</span><a id="line.55"></a> |
| <span class="sourceLineNo">056</span><a id="line.56"></a> |
| <span class="sourceLineNo">057</span><a id="line.57"> @Operation( deprecated = true )</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> @Path( "ping" )</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> @GET</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> @RedbackAuthorization( noRestriction = true )</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> Boolean ping()</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">064</span><a id="line.64"></a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> @Operation( deprecated = true )</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> @Path( "pingWithAutz" )</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> @GET</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> @RedbackAuthorization( noRestriction = false, noPermission = true )</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> Boolean pingWithAutz()</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">073</span><a id="line.73"></a> |
| <span class="sourceLineNo">074</span><a id="line.74"> /**</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * check username/password and create a http session.</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> * So no more need of reuse username/password for all ajaxRequest</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> */</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> @Operation( deprecated = true )</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> @Path( "logIn" )</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> @POST</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> @RedbackAuthorization( noRestriction = true, noPermission = true )</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> User logIn( LoginRequest loginRequest )</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">085</span><a id="line.85"></a> |
| <span class="sourceLineNo">086</span><a id="line.86"> /**</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * simply check if current user has an http session opened with authz passed and return user data</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> * @since 1.4</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> */</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> @Operation( deprecated = true )</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> @Path( "isLogged" )</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> @GET</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML } )</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> @RedbackAuthorization( noRestriction = true )</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> User isLogged()</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> /**</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * clear user http session</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> * @since 1.4</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> */</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> @Operation( deprecated = true )</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> @Path( "logout" )</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> @GET</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> @RedbackAuthorization( noRestriction = true, noPermission = true )</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> ActionStatus logout()</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> throws RedbackServiceException;</a> |
| <span class="sourceLineNo">109</span><a id="line.109">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
