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