Google Git
Sign in
apache / archiva-web-content / 1b7e811f9aa411dd1b001fe82a147012e4cce823 / . / redback / core / 3.0.0-SNAPSHOT / apidocs / src-html / org / apache / archiva / redback / authentication / SimpleTokenData.html
blob: 4309882fae4f0752349b21bd6426f1f1a5b887cf [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.authentication;</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.io.Serializable;</a>
<span class="sourceLineNo">023</span><a id="line.23">import java.time.Duration;</a>
<span class="sourceLineNo">024</span><a id="line.24">import java.time.Instant;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.util.Date;</a>
<span class="sourceLineNo">026</span><a id="line.26"></a>
<span class="sourceLineNo">027</span><a id="line.27">/**</a>
<span class="sourceLineNo">028</span><a id="line.28"> *</a>
<span class="sourceLineNo">029</span><a id="line.29"> * Simple Token information class that contains a username and a lifetime.</a>
<span class="sourceLineNo">030</span><a id="line.30"> *</a>
<span class="sourceLineNo">031</span><a id="line.31"> * The class is not able to detect time manipulations. It is assumed that the</a>
<span class="sourceLineNo">032</span><a id="line.32"> * current time of the system is correct.</a>
<span class="sourceLineNo">033</span><a id="line.33"> *</a>
<span class="sourceLineNo">034</span><a id="line.34"> * This class is immutable.</a>
<span class="sourceLineNo">035</span><a id="line.35"> *</a>
<span class="sourceLineNo">036</span><a id="line.36"> * Created by Martin Stockhammer on 03.02.17.</a>
<span class="sourceLineNo">037</span><a id="line.37"> */</a>
<span class="sourceLineNo">038</span><a id="line.38">public final class SimpleTokenData implements Serializable, TokenData {</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"> private static final long serialVersionUID = 5907745449771921813L;</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> private final String user;</a>
<span class="sourceLineNo">044</span><a id="line.44"> private final Instant created;</a>
<span class="sourceLineNo">045</span><a id="line.45"> private final Instant validBefore;</a>
<span class="sourceLineNo">046</span><a id="line.46"> private final long nonce;</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"> * Creates a new token info instance for the given user.</a>
<span class="sourceLineNo">050</span><a id="line.50"> * The lifetime in milliseconds defines the invalidation date by</a>
<span class="sourceLineNo">051</span><a id="line.51"> * adding the lifetime to the current time of instantiation.</a>
<span class="sourceLineNo">052</span><a id="line.52"> *</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @param user The user name</a>
<span class="sourceLineNo">054</span><a id="line.54"> * @param lifetime The number of milliseconds after that the token is invalid</a>
<span class="sourceLineNo">055</span><a id="line.55"> * @param nonce Should be a random number and different for each instance.</a>
<span class="sourceLineNo">056</span><a id="line.56"> */</a>
<span class="sourceLineNo">057</span><a id="line.57"> public SimpleTokenData(final String user, final long lifetime, final long nonce) {</a>
<span class="sourceLineNo">058</span><a id="line.58"> this.user=user;</a>
<span class="sourceLineNo">059</span><a id="line.59"> this.created = Instant.now( );</a>
<span class="sourceLineNo">060</span><a id="line.60"> this.validBefore = created.plus( Duration.ofMillis( lifetime ) );</a>
<span class="sourceLineNo">061</span><a id="line.61"> this.nonce = nonce;</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"> /**</a>
<span class="sourceLineNo">065</span><a id="line.65"> * Creates a new token info instance for the given user.</a>
<span class="sourceLineNo">066</span><a id="line.66"> * The lifetime in milliseconds defines the invalidation date by</a>
<span class="sourceLineNo">067</span><a id="line.67"> * adding the lifetime to the current time of instantiation.</a>
<span class="sourceLineNo">068</span><a id="line.68"> *</a>
<span class="sourceLineNo">069</span><a id="line.69"> * @param user The user name</a>
<span class="sourceLineNo">070</span><a id="line.70"> * @param lifetime The number of milliseconds after that the token is invalid</a>
<span class="sourceLineNo">071</span><a id="line.71"> * @param nonce Should be a random number and different for each instance.</a>
<span class="sourceLineNo">072</span><a id="line.72"> */</a>
<span class="sourceLineNo">073</span><a id="line.73"> public SimpleTokenData(final String user, final Duration lifetime, final long nonce) {</a>
<span class="sourceLineNo">074</span><a id="line.74"> this.user=user;</a>
<span class="sourceLineNo">075</span><a id="line.75"> this.created = Instant.now( );</a>
<span class="sourceLineNo">076</span><a id="line.76"> this.validBefore = created.plus( lifetime );</a>
<span class="sourceLineNo">077</span><a id="line.77"> this.nonce = nonce;</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"></a>
<span class="sourceLineNo">080</span><a id="line.80"> @Override</a>
<span class="sourceLineNo">081</span><a id="line.81"> public final String getUser() {</a>
<span class="sourceLineNo">082</span><a id="line.82"> return user;</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</a>
<span class="sourceLineNo">084</span><a id="line.84"></a>
<span class="sourceLineNo">085</span><a id="line.85"> @Override</a>
<span class="sourceLineNo">086</span><a id="line.86"> public final Instant created() {</a>
<span class="sourceLineNo">087</span><a id="line.87"> return created;</a>
<span class="sourceLineNo">088</span><a id="line.88"> }</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> @Override</a>
<span class="sourceLineNo">091</span><a id="line.91"> public final Instant validBefore() {</a>
<span class="sourceLineNo">092</span><a id="line.92"> return validBefore;</a>
<span class="sourceLineNo">093</span><a id="line.93"> }</a>
<span class="sourceLineNo">094</span><a id="line.94"></a>
<span class="sourceLineNo">095</span><a id="line.95"> @Override</a>
<span class="sourceLineNo">096</span><a id="line.96"> public final long getNonce() {</a>
<span class="sourceLineNo">097</span><a id="line.97"> return nonce;</a>
<span class="sourceLineNo">098</span><a id="line.98"> }</a>
<span class="sourceLineNo">099</span><a id="line.99"></a>
<span class="sourceLineNo">100</span><a id="line.100"> @Override</a>
<span class="sourceLineNo">101</span><a id="line.101"> public boolean isValid() {</a>
<span class="sourceLineNo">102</span><a id="line.102"> return Instant.now( ).isBefore( validBefore );</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">}</a>
</pre>
</div>
</main>
</body>
</html>