blob: e9965f5c1f47efe4d6fb4fe9655eb1718c1abb1f [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.model.v2;</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"> * 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 io.swagger.v3.oas.annotations.media.Schema;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.archiva.redback.keys.AuthenticationKey;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.xml.bind.annotation.XmlRootElement;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.time.Instant;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.time.OffsetDateTime;</a>
<span class="sourceLineNo">027</span><a id="line.27">import java.time.ZoneId;</a>
<span class="sourceLineNo">028</span><a id="line.28">import java.util.Date;</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"> * Represents a authentication token.</a>
<span class="sourceLineNo">032</span><a id="line.32"> * @author Martin Stockhammer &lt;martin_s@apache.org&gt;</a>
<span class="sourceLineNo">033</span><a id="line.33"> * @since 3.0</a>
<span class="sourceLineNo">034</span><a id="line.34"> */</a>
<span class="sourceLineNo">035</span><a id="line.35">@XmlRootElement( name = "token" )</a>
<span class="sourceLineNo">036</span><a id="line.36">public class Token</a>
<span class="sourceLineNo">037</span><a id="line.37">{</a>
<span class="sourceLineNo">038</span><a id="line.38"> String key;</a>
<span class="sourceLineNo">039</span><a id="line.39"> OffsetDateTime created;</a>
<span class="sourceLineNo">040</span><a id="line.40"> OffsetDateTime expires;</a>
<span class="sourceLineNo">041</span><a id="line.41"> String principal;</a>
<span class="sourceLineNo">042</span><a id="line.42"> String purpose;</a>
<span class="sourceLineNo">043</span><a id="line.43"></a>
<span class="sourceLineNo">044</span><a id="line.44"> public Token( )</a>
<span class="sourceLineNo">045</span><a id="line.45"> {</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"> public static Token of( AuthenticationKey key ) {</a>
<span class="sourceLineNo">049</span><a id="line.49"> Token token = new Token( );</a>
<span class="sourceLineNo">050</span><a id="line.50"> token.setKey( key.getKey() );</a>
<span class="sourceLineNo">051</span><a id="line.51"> token.setCreatedFromInstant( key.getDateCreated().toInstant() );</a>
<span class="sourceLineNo">052</span><a id="line.52"> token.setExpiresFromInstant( key.getDateExpires().toInstant() );</a>
<span class="sourceLineNo">053</span><a id="line.53"> token.setPrincipal( key.getForPrincipal() );</a>
<span class="sourceLineNo">054</span><a id="line.54"> token.setPurpose( key.getPurpose() );</a>
<span class="sourceLineNo">055</span><a id="line.55"> return token;</a>
<span class="sourceLineNo">056</span><a id="line.56"> }</a>
<span class="sourceLineNo">057</span><a id="line.57"></a>
<span class="sourceLineNo">058</span><a id="line.58"> public static Token of( String key, Date created, Date expires, String principal, String purpose)</a>
<span class="sourceLineNo">059</span><a id="line.59"> {</a>
<span class="sourceLineNo">060</span><a id="line.60"> Token token = new Token( );</a>
<span class="sourceLineNo">061</span><a id="line.61"> token.setKey( key );</a>
<span class="sourceLineNo">062</span><a id="line.62"> token.setCreatedFromInstant( created.toInstant( ) );</a>
<span class="sourceLineNo">063</span><a id="line.63"> token.setExpiresFromInstant( expires.toInstant( ) );</a>
<span class="sourceLineNo">064</span><a id="line.64"> token.setPrincipal( principal );</a>
<span class="sourceLineNo">065</span><a id="line.65"> token.setPrincipal( purpose );</a>
<span class="sourceLineNo">066</span><a id="line.66"> return token;</a>
<span class="sourceLineNo">067</span><a id="line.67"> }</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> public static Token of( String key, Instant created, Instant expires, String principal, String purpose )</a>
<span class="sourceLineNo">070</span><a id="line.70"> {</a>
<span class="sourceLineNo">071</span><a id="line.71"> Token token = new Token( );</a>
<span class="sourceLineNo">072</span><a id="line.72"> token.setKey( key );</a>
<span class="sourceLineNo">073</span><a id="line.73"> token.setCreatedFromInstant( created );</a>
<span class="sourceLineNo">074</span><a id="line.74"> token.setExpiresFromInstant( expires );</a>
<span class="sourceLineNo">075</span><a id="line.75"> token.setPrincipal( principal );</a>
<span class="sourceLineNo">076</span><a id="line.76"> token.setPrincipal( purpose );</a>
<span class="sourceLineNo">077</span><a id="line.77"> return token;</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"> @Schema(description = "The key stored in this token.")</a>
<span class="sourceLineNo">081</span><a id="line.81"> public String getKey( )</a>
<span class="sourceLineNo">082</span><a id="line.82"> {</a>
<span class="sourceLineNo">083</span><a id="line.83"> return key;</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> public void setKey( String key )</a>
<span class="sourceLineNo">087</span><a id="line.87"> {</a>
<span class="sourceLineNo">088</span><a id="line.88"> this.key = key;</a>
<span class="sourceLineNo">089</span><a id="line.89"> }</a>
<span class="sourceLineNo">090</span><a id="line.90"></a>
<span class="sourceLineNo">091</span><a id="line.91"> @Schema(description = "Time, when the token was created")</a>
<span class="sourceLineNo">092</span><a id="line.92"> public OffsetDateTime getCreated( )</a>
<span class="sourceLineNo">093</span><a id="line.93"> {</a>
<span class="sourceLineNo">094</span><a id="line.94"> return created;</a>
<span class="sourceLineNo">095</span><a id="line.95"> }</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> public void setCreatedFromInstant( Instant created )</a>
<span class="sourceLineNo">098</span><a id="line.98"> {</a>
<span class="sourceLineNo">099</span><a id="line.99"> this.created = OffsetDateTime.ofInstant( created, ZoneId.of( "UTC" ) );</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"> public void setCreated( OffsetDateTime created )</a>
<span class="sourceLineNo">103</span><a id="line.103"> {</a>
<span class="sourceLineNo">104</span><a id="line.104"> this.created = created;</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</a>
<span class="sourceLineNo">106</span><a id="line.106"></a>
<span class="sourceLineNo">107</span><a id="line.107"> @Schema(description = "Time, when the token expires.")</a>
<span class="sourceLineNo">108</span><a id="line.108"> public OffsetDateTime getExpires( )</a>
<span class="sourceLineNo">109</span><a id="line.109"> {</a>
<span class="sourceLineNo">110</span><a id="line.110"> return expires;</a>
<span class="sourceLineNo">111</span><a id="line.111"> }</a>
<span class="sourceLineNo">112</span><a id="line.112"></a>
<span class="sourceLineNo">113</span><a id="line.113"> public void setExpiresFromInstant( Instant expires )</a>
<span class="sourceLineNo">114</span><a id="line.114"> {</a>
<span class="sourceLineNo">115</span><a id="line.115"> this.expires = OffsetDateTime.ofInstant( expires, ZoneId.of( "UTC" ) );</a>
<span class="sourceLineNo">116</span><a id="line.116"> }</a>
<span class="sourceLineNo">117</span><a id="line.117"></a>
<span class="sourceLineNo">118</span><a id="line.118"> public void setExpires( OffsetDateTime expires )</a>
<span class="sourceLineNo">119</span><a id="line.119"> {</a>
<span class="sourceLineNo">120</span><a id="line.120"> this.expires = expires;</a>
<span class="sourceLineNo">121</span><a id="line.121"> }</a>
<span class="sourceLineNo">122</span><a id="line.122"></a>
<span class="sourceLineNo">123</span><a id="line.123"> @Schema(description = "The principal, this token identifies")</a>
<span class="sourceLineNo">124</span><a id="line.124"> public String getPrincipal( )</a>
<span class="sourceLineNo">125</span><a id="line.125"> {</a>
<span class="sourceLineNo">126</span><a id="line.126"> return principal;</a>
<span class="sourceLineNo">127</span><a id="line.127"> }</a>
<span class="sourceLineNo">128</span><a id="line.128"></a>
<span class="sourceLineNo">129</span><a id="line.129"> public void setPrincipal( String principal )</a>
<span class="sourceLineNo">130</span><a id="line.130"> {</a>
<span class="sourceLineNo">131</span><a id="line.131"> this.principal = principal;</a>
<span class="sourceLineNo">132</span><a id="line.132"> }</a>
<span class="sourceLineNo">133</span><a id="line.133"></a>
<span class="sourceLineNo">134</span><a id="line.134"> @Schema(description = "The purpose of this token")</a>
<span class="sourceLineNo">135</span><a id="line.135"> public String getPurpose( )</a>
<span class="sourceLineNo">136</span><a id="line.136"> {</a>
<span class="sourceLineNo">137</span><a id="line.137"> return purpose;</a>
<span class="sourceLineNo">138</span><a id="line.138"> }</a>
<span class="sourceLineNo">139</span><a id="line.139"></a>
<span class="sourceLineNo">140</span><a id="line.140"> public void setPurpose( String purpose )</a>
<span class="sourceLineNo">141</span><a id="line.141"> {</a>
<span class="sourceLineNo">142</span><a id="line.142"> this.purpose = purpose;</a>
<span class="sourceLineNo">143</span><a id="line.143"> }</a>
<span class="sourceLineNo">144</span><a id="line.144">}</a>
</pre>
</div>
</main>
</body>
</html>