blob: 952ec8716ced5ff868860fadbd72a438cd89c031 [file] [log] [blame]
<!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"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">004</span><a id="line.4"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">005</span><a id="line.5"> * distributed with this work for additional information</a>
<span class="sourceLineNo">006</span><a id="line.6"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">007</span><a id="line.7"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">008</span><a id="line.8"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">009</span><a id="line.9"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">010</span><a id="line.10"> *</a>
<span class="sourceLineNo">011</span><a id="line.11"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">012</span><a id="line.12"> *</a>
<span class="sourceLineNo">013</span><a id="line.13"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">014</span><a id="line.14"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">015</span><a id="line.15"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">016</span><a id="line.16"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">017</span><a id="line.17"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">018</span><a id="line.18"> * under the License.</a>
<span class="sourceLineNo">019</span><a id="line.19"> */</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.archiva.redback.authorization.RedbackAuthorization;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.rest.api.model.User;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.ws.rs.GET;</a>
<span class="sourceLineNo">025</span><a id="line.25">import javax.ws.rs.Path;</a>
<span class="sourceLineNo">026</span><a id="line.26">import javax.ws.rs.Produces;</a>
<span class="sourceLineNo">027</span><a id="line.27">import javax.ws.rs.QueryParam;</a>
<span class="sourceLineNo">028</span><a id="line.28">import javax.ws.rs.core.MediaType;</a>
<span class="sourceLineNo">029</span><a id="line.29"></a>
<span class="sourceLineNo">030</span><a id="line.30">/**</a>
<span class="sourceLineNo">031</span><a id="line.31"> * @deprecated Use the new V2 password service {@link org.apache.archiva.redback.rest.api.services.v2.PasswordService}</a>
<span class="sourceLineNo">032</span><a id="line.32"> * @author Olivier Lamy</a>
<span class="sourceLineNo">033</span><a id="line.33"> * @since 1.4</a>
<span class="sourceLineNo">034</span><a id="line.34"> */</a>
<span class="sourceLineNo">035</span><a id="line.35">@Deprecated</a>
<span class="sourceLineNo">036</span><a id="line.36">@Path( "/passwordService/" )</a>
<span class="sourceLineNo">037</span><a id="line.37">public interface PasswordService</a>
<span class="sourceLineNo">038</span><a id="line.38">{</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> /**</a>
<span class="sourceLineNo">041</span><a id="line.41"> * used to change the password on first user connection after registration use.</a>
<span class="sourceLineNo">042</span><a id="line.42"> * the key is mandatory and a control will be done on the username provided.</a>
<span class="sourceLineNo">043</span><a id="line.43"> * &lt;b&gt;need to be logged by {@link UserService#validateUserFromKey(String)}&lt;/b&gt;</a>
<span class="sourceLineNo">044</span><a id="line.44"> * @return username</a>
<span class="sourceLineNo">045</span><a id="line.45"> */</a>
<span class="sourceLineNo">046</span><a id="line.46"> @GET</a>
<span class="sourceLineNo">047</span><a id="line.47"> @Path( "changePasswordWithKey" )</a>
<span class="sourceLineNo">048</span><a id="line.48"> @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_PLAIN } )</a>
<span class="sourceLineNo">049</span><a id="line.49"> @RedbackAuthorization( noRestriction = true, noPermission = true )</a>
<span class="sourceLineNo">050</span><a id="line.50"> User changePasswordWithKey( @QueryParam( "password" ) String password,</a>
<span class="sourceLineNo">051</span><a id="line.51"> @QueryParam( "passwordConfirmation" ) String passwordConfirmation,</a>
<span class="sourceLineNo">052</span><a id="line.52"> @QueryParam( "key" ) String key )</a>
<span class="sourceLineNo">053</span><a id="line.53"> throws RedbackServiceException;</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> /**</a>
<span class="sourceLineNo">056</span><a id="line.56"> * used to change the password on passwordChangeRequired state.</a>
<span class="sourceLineNo">057</span><a id="line.57"> */</a>
<span class="sourceLineNo">058</span><a id="line.58"> @GET</a>
<span class="sourceLineNo">059</span><a id="line.59"> @Path( "changePassword" )</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, noPermission = true )</a>
<span class="sourceLineNo">062</span><a id="line.62"> User changePassword( @QueryParam( "userName" ) String userName,</a>
<span class="sourceLineNo">063</span><a id="line.63"> @QueryParam( "previousPassword" ) String previousPassword,</a>
<span class="sourceLineNo">064</span><a id="line.64"> @QueryParam( "password" ) String password,</a>
<span class="sourceLineNo">065</span><a id="line.65"> @QueryParam( "passwordConfirmation" ) String passwordConfirmation )</a>
<span class="sourceLineNo">066</span><a id="line.66"> throws RedbackServiceException;</a>
<span class="sourceLineNo">067</span><a id="line.67">}</a>
</pre>
</div>
</main>
</body>
</html>