blob: b9666f8ee09298f880b2d6e4941c1d34ca77abcf [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.system;</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 org.apache.archiva.redback.authentication.TokenManager;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.archiva.redback.policy.AccountLockedException;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.archiva.redback.policy.MustChangePasswordException;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.archiva.redback.policy.UserSecurityPolicy;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.archiva.redback.users.User;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.archiva.redback.users.UserManagerException;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.archiva.redback.users.UserNotFoundException;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.archiva.redback.authentication.AuthenticationDataSource;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.archiva.redback.authentication.AuthenticationException;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.apache.archiva.redback.authorization.AuthorizationException;</a>
<span class="sourceLineNo">032</span><a id="line.32">import org.apache.archiva.redback.authorization.AuthorizationResult;</a>
<span class="sourceLineNo">033</span><a id="line.33">import org.apache.archiva.redback.keys.KeyManager;</a>
<span class="sourceLineNo">034</span><a id="line.34">import org.apache.archiva.redback.users.UserManager;</a>
<span class="sourceLineNo">035</span><a id="line.35"></a>
<span class="sourceLineNo">036</span><a id="line.36">/**</a>
<span class="sourceLineNo">037</span><a id="line.37"> * SecuritySystem:</a>
<span class="sourceLineNo">038</span><a id="line.38"> *</a>
<span class="sourceLineNo">039</span><a id="line.39"> * @author: Jesse McConnell</a>
<span class="sourceLineNo">040</span><a id="line.40"> */</a>
<span class="sourceLineNo">041</span><a id="line.41">public interface SecuritySystem</a>
<span class="sourceLineNo">042</span><a id="line.42">{</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">045</span><a id="line.45"> // Authentication</a>
<span class="sourceLineNo">046</span><a id="line.46"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> SecuritySession authenticate( AuthenticationDataSource source )</a>
<span class="sourceLineNo">049</span><a id="line.49"> throws AuthenticationException, UserNotFoundException, AccountLockedException, MustChangePasswordException,</a>
<span class="sourceLineNo">050</span><a id="line.50"> UserManagerException;</a>
<span class="sourceLineNo">051</span><a id="line.51"></a>
<span class="sourceLineNo">052</span><a id="line.52"> boolean isAuthenticated( AuthenticationDataSource source )</a>
<span class="sourceLineNo">053</span><a id="line.53"> throws AuthenticationException, UserNotFoundException, AccountLockedException, MustChangePasswordException,</a>
<span class="sourceLineNo">054</span><a id="line.54"> UserManagerException;</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"> // Authorization</a>
<span class="sourceLineNo">058</span><a id="line.58"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> AuthorizationResult authorize( SecuritySession session, String permission )</a>
<span class="sourceLineNo">061</span><a id="line.61"> throws AuthorizationException;</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> boolean isAuthorized( SecuritySession session, String permission )</a>
<span class="sourceLineNo">064</span><a id="line.64"> throws AuthorizationException;</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> /**</a>
<span class="sourceLineNo">067</span><a id="line.67"> * return AuthorizationResult without changing authorization</a>
<span class="sourceLineNo">068</span><a id="line.68"> *</a>
<span class="sourceLineNo">069</span><a id="line.69"> * @param session</a>
<span class="sourceLineNo">070</span><a id="line.70"> * @param permission</a>
<span class="sourceLineNo">071</span><a id="line.71"> * @param resource</a>
<span class="sourceLineNo">072</span><a id="line.72"> * @return</a>
<span class="sourceLineNo">073</span><a id="line.73"> * @throws AuthorizationException</a>
<span class="sourceLineNo">074</span><a id="line.74"> */</a>
<span class="sourceLineNo">075</span><a id="line.75"> AuthorizationResult authorize( SecuritySession session, String permission, String resource )</a>
<span class="sourceLineNo">076</span><a id="line.76"> throws AuthorizationException;</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> /**</a>
<span class="sourceLineNo">079</span><a id="line.79"> * @since 2.3</a>
<span class="sourceLineNo">080</span><a id="line.80"> * @param user</a>
<span class="sourceLineNo">081</span><a id="line.81"> * @param permission</a>
<span class="sourceLineNo">082</span><a id="line.82"> * @param resource</a>
<span class="sourceLineNo">083</span><a id="line.83"> * @return</a>
<span class="sourceLineNo">084</span><a id="line.84"> * @throws AuthorizationException</a>
<span class="sourceLineNo">085</span><a id="line.85"> */</a>
<span class="sourceLineNo">086</span><a id="line.86"> AuthorizationResult authorize( User user, String permission, String resource )</a>
<span class="sourceLineNo">087</span><a id="line.87"> throws AuthorizationException;</a>
<span class="sourceLineNo">088</span><a id="line.88"></a>
<span class="sourceLineNo">089</span><a id="line.89"> boolean isAuthorized( SecuritySession session, String permission, String resource )</a>
<span class="sourceLineNo">090</span><a id="line.90"> throws AuthorizationException;</a>
<span class="sourceLineNo">091</span><a id="line.91"></a>
<span class="sourceLineNo">092</span><a id="line.92"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">093</span><a id="line.93"> // User Management</a>
<span class="sourceLineNo">094</span><a id="line.94"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">095</span><a id="line.95"></a>
<span class="sourceLineNo">096</span><a id="line.96"> UserManager getUserManager();</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"> // Key Management</a>
<span class="sourceLineNo">100</span><a id="line.100"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">101</span><a id="line.101"></a>
<span class="sourceLineNo">102</span><a id="line.102"> KeyManager getKeyManager();</a>
<span class="sourceLineNo">103</span><a id="line.103"></a>
<span class="sourceLineNo">104</span><a id="line.104"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">105</span><a id="line.105"> // Policy Management</a>
<span class="sourceLineNo">106</span><a id="line.106"> // ----------------------------------------------------------------------------</a>
<span class="sourceLineNo">107</span><a id="line.107"></a>
<span class="sourceLineNo">108</span><a id="line.108"> UserSecurityPolicy getPolicy();</a>
<span class="sourceLineNo">109</span><a id="line.109"></a>
<span class="sourceLineNo">110</span><a id="line.110"> /**</a>
<span class="sourceLineNo">111</span><a id="line.111"> * @return is it possible to modify user datas (some userManager cannot i.e ldap)</a>
<span class="sourceLineNo">112</span><a id="line.112"> * @since 2.1</a>
<span class="sourceLineNo">113</span><a id="line.113"> */</a>
<span class="sourceLineNo">114</span><a id="line.114"> boolean userManagerReadOnly();</a>
<span class="sourceLineNo">115</span><a id="line.115"></a>
<span class="sourceLineNo">116</span><a id="line.116"> /**</a>
<span class="sourceLineNo">117</span><a id="line.117"> * Returns the token manager implementation.</a>
<span class="sourceLineNo">118</span><a id="line.118"> *</a>
<span class="sourceLineNo">119</span><a id="line.119"> * @since 2.2</a>
<span class="sourceLineNo">120</span><a id="line.120"> */</a>
<span class="sourceLineNo">121</span><a id="line.121"> TokenManager getTokenManager();</a>
<span class="sourceLineNo">122</span><a id="line.122">}</a>
<span class="sourceLineNo">123</span><a id="line.123"></a>
</pre>
</div>
</main>
</body>
</html>