| <!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.users;</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 java.util.List;</a> |
| <span class="sourceLineNo">023</span><a id="line.23"></a> |
| <span class="sourceLineNo">024</span><a id="line.24">/**</a> |
| <span class="sourceLineNo">025</span><a id="line.25"> * User Manager Interface</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> *</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * @TODO: Add Streaming Methods</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * @TODO: Improve query to allow multiple sort values</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * @TODO: Improve query to avoid UnsupportedOperationExceptions (e.g. in LDAP or combined user manager)</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> * @TODO: Improve query to allow upper/lowercase and substring queries for all user managers</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @TODO: Add method for total count of users</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> *</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> * @author Jason van Zyl</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> */</a> |
| <span class="sourceLineNo">036</span><a id="line.36">public interface UserManager</a> |
| <span class="sourceLineNo">037</span><a id="line.37">{</a> |
| <span class="sourceLineNo">038</span><a id="line.38"></a> |
| <span class="sourceLineNo">039</span><a id="line.39"> static final String GUEST_USERNAME = "guest";</a> |
| <span class="sourceLineNo">040</span><a id="line.40"></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> /**</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * Is the UserManager read only? if so then create and modify actions are to be disabled</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> *</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * @return boolean true if user manager is disabled</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> */</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> boolean isReadOnly();</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> /**</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * An Identifier for the UserManager.</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> *</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * @return the user manager identifier.</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> */</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> String getId();</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"> * Add a {@link UserManagerListener} to track major events in the</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * UserManager.</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> *</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * @param listener the listener to add.</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> */</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> void addUserManagerListener( UserManagerListener listener );</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> /**</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * Remove a {@link UserManagerListener} from the collection of listeners.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> *</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * @param listener the listener to remove.</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> */</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> void removeUserManagerListener( UserManagerListener listener );</a> |
| <span class="sourceLineNo">069</span><a id="line.69"></a> |
| <span class="sourceLineNo">070</span><a id="line.70"> /**</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * Factory method to create new User Objects based on provider specific</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> * implementation.</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> *</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> * User objects created this way do not exist in the provider's underlying</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> * data store until a call to {@link #addUser(User)} is made.</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> *</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> * @param username the username for this user.</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * @param fullName the full name for this user.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * @param emailAddress the email address for this user.</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * @return the new user object ready to use.</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * @throws UserManagerException</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> */</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> User createUser( String username, String fullName, String emailAddress )</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> throws UserManagerException;</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"> * Factory method to create the guest user.</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> *</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @return The guest user</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @throws UserManagerException</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> */</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> User createGuestUser()</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> throws UserManagerException;</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"> * Factory method to create {@link UserQuery}s based on provider specific</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> * implementations.</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> *</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> * @return the provider implementation of UserQuery</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> */</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> UserQuery createUserQuery();</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> /**</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> * Get the List of {@link User} objects.</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> *</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> * @return the List of {@link User} Objects.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> * @throws UserManagerException</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> */</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> List<? extends User> getUsers()</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> throws UserManagerException;</a> |
| <span class="sourceLineNo">111</span><a id="line.111"></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> List<? extends User> getUsers( boolean orderAscending )</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> throws UserManagerException;</a> |
| <span class="sourceLineNo">114</span><a id="line.114"></a> |
| <span class="sourceLineNo">115</span><a id="line.115"> /**</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> * Add a User.</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> *</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * @param user the user to add.</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * @return the user that was just added.</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * @throws UserManagerException</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> */</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> User addUser( User user )</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> throws UserManagerException;</a> |
| <span class="sourceLineNo">124</span><a id="line.124"></a> |
| <span class="sourceLineNo">125</span><a id="line.125"> /**</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> * Update a User.</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> *</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * @param user the user to update.</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> * @return the user that was just updated.</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @throws UserNotFoundException if the user was not found to update.</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> */</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> User updateUser( User user )</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> throws UserNotFoundException, UserManagerException;</a> |
| <span class="sourceLineNo">134</span><a id="line.134"></a> |
| <span class="sourceLineNo">135</span><a id="line.135"> /**</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * Find a User using a User name.</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> *</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @param username the username to find.</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> * @return the user.</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> * @throws UserNotFoundException if the user was not found.</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> */</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> User findUser( String username )</a> |
| <span class="sourceLineNo">143</span><a id="line.143"> throws UserNotFoundException, UserManagerException;</a> |
| <span class="sourceLineNo">144</span><a id="line.144"></a> |
| <span class="sourceLineNo">145</span><a id="line.145"> /**</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> * Find a User using a User name.</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> *</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> * @param username the username to find.</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> * @param useCache to use or not caching</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * @return the user.</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> * @since 2.2</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * @throws UserNotFoundException if the user was not found.</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> */</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> User findUser( String username, boolean useCache )</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> throws UserNotFoundException, UserManagerException;</a> |
| <span class="sourceLineNo">156</span><a id="line.156"></a> |
| <span class="sourceLineNo">157</span><a id="line.157"> /**</a> |
| <span class="sourceLineNo">158</span><a id="line.158"> * Get the guest user.</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> *</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> * @return the guest user.</a> |
| <span class="sourceLineNo">161</span><a id="line.161"> */</a> |
| <span class="sourceLineNo">162</span><a id="line.162"> User getGuestUser()</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> throws UserNotFoundException, UserManagerException;</a> |
| <span class="sourceLineNo">164</span><a id="line.164"></a> |
| <span class="sourceLineNo">165</span><a id="line.165"> List<? extends User> findUsersByUsernameKey( String usernameKey, boolean orderAscending )</a> |
| <span class="sourceLineNo">166</span><a id="line.166"> throws UserManagerException;</a> |
| <span class="sourceLineNo">167</span><a id="line.167"></a> |
| <span class="sourceLineNo">168</span><a id="line.168"> List<? extends User> findUsersByFullNameKey( String fullNameKey, boolean orderAscending )</a> |
| <span class="sourceLineNo">169</span><a id="line.169"> throws UserManagerException;</a> |
| <span class="sourceLineNo">170</span><a id="line.170"></a> |
| <span class="sourceLineNo">171</span><a id="line.171"> List<? extends User> findUsersByEmailKey( String emailKey, boolean orderAscending )</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> throws UserManagerException;</a> |
| <span class="sourceLineNo">173</span><a id="line.173"></a> |
| <span class="sourceLineNo">174</span><a id="line.174"> /**</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * Find users matching properties, ordering and range as specified by the</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * {@link UserQuery}.</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> *</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> * @param query the query.</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> * @return a List of {@link User} objects.</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> */</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> List<? extends User> findUsersByQuery( UserQuery query )</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> throws UserManagerException;</a> |
| <span class="sourceLineNo">183</span><a id="line.183"></a> |
| <span class="sourceLineNo">184</span><a id="line.184"> /**</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> * true if the user exists, false if it doesn't</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> *</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> * @param principal</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> * @return true, if user exists</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> */</a> |
| <span class="sourceLineNo">190</span><a id="line.190"> boolean userExists( String principal )</a> |
| <span class="sourceLineNo">191</span><a id="line.191"> throws UserManagerException;</a> |
| <span class="sourceLineNo">192</span><a id="line.192"></a> |
| <span class="sourceLineNo">193</span><a id="line.193"> /**</a> |
| <span class="sourceLineNo">194</span><a id="line.194"> * Delete a user using the username.</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> *</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> * @param username the username to look for.</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> * @throws UserNotFoundException the user was not found.</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> */</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> void deleteUser( String username )</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> throws UserNotFoundException, UserManagerException;</a> |
| <span class="sourceLineNo">201</span><a id="line.201"></a> |
| <span class="sourceLineNo">202</span><a id="line.202"> /**</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> * Add a user to the database without checking for consistency or adjusting the password. Should only be used for</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> * re-importing known-good data.</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> *</a> |
| <span class="sourceLineNo">206</span><a id="line.206"> * @param user the user to add</a> |
| <span class="sourceLineNo">207</span><a id="line.207"> */</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> void addUserUnchecked( User user )</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> throws UserManagerException;</a> |
| <span class="sourceLineNo">210</span><a id="line.210"></a> |
| <span class="sourceLineNo">211</span><a id="line.211"> void eraseDatabase();</a> |
| <span class="sourceLineNo">212</span><a id="line.212"></a> |
| <span class="sourceLineNo">213</span><a id="line.213"> User updateUser( User user, boolean passwordChangeRequired )</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> throws UserNotFoundException, UserManagerException;</a> |
| <span class="sourceLineNo">215</span><a id="line.215"></a> |
| <span class="sourceLineNo">216</span><a id="line.216"></a> |
| <span class="sourceLineNo">217</span><a id="line.217"> /**</a> |
| <span class="sourceLineNo">218</span><a id="line.218"> * consumer of user manager can use it to reload various configuration</a> |
| <span class="sourceLineNo">219</span><a id="line.219"> * with the configurable implementation is possible to change dynamically the real implementation used.</a> |
| <span class="sourceLineNo">220</span><a id="line.220"> *</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> * @since 2.1</a> |
| <span class="sourceLineNo">222</span><a id="line.222"> */</a> |
| <span class="sourceLineNo">223</span><a id="line.223"> void initialize();</a> |
| <span class="sourceLineNo">224</span><a id="line.224"></a> |
| <span class="sourceLineNo">225</span><a id="line.225"> /**</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> * @return true if this implementation is a final one and not a wrapper (configurable, cached)</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> * @since 2.1</a> |
| <span class="sourceLineNo">228</span><a id="line.228"> */</a> |
| <span class="sourceLineNo">229</span><a id="line.229"> boolean isFinalImplementation();</a> |
| <span class="sourceLineNo">230</span><a id="line.230"></a> |
| <span class="sourceLineNo">231</span><a id="line.231"> /**</a> |
| <span class="sourceLineNo">232</span><a id="line.232"> * @return a key to be able to customize label in UI</a> |
| <span class="sourceLineNo">233</span><a id="line.233"> * @since 2.1</a> |
| <span class="sourceLineNo">234</span><a id="line.234"> */</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> String getDescriptionKey();</a> |
| <span class="sourceLineNo">236</span><a id="line.236"></a> |
| <span class="sourceLineNo">237</span><a id="line.237">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
