blob: 90ceb09ce504c894ad972a7d02bb57959a1a54c8 [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;</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.authentication.Token;</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.XmlElement;</a>
<span class="sourceLineNo">025</span><a id="line.25">import javax.xml.bind.annotation.XmlRootElement;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.io.Serializable;</a>
<span class="sourceLineNo">027</span><a id="line.27">import java.time.Duration;</a>
<span class="sourceLineNo">028</span><a id="line.28">import java.time.Instant;</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"> * @author Martin Stockhammer &lt;martin_s@apache.org&gt;</a>
<span class="sourceLineNo">032</span><a id="line.32"> */</a>
<span class="sourceLineNo">033</span><a id="line.33">@XmlRootElement(name="token")</a>
<span class="sourceLineNo">034</span><a id="line.34">@Schema(name="TokenData", description = "The token response data")</a>
<span class="sourceLineNo">035</span><a id="line.35">public class TokenResponse implements Serializable</a>
<span class="sourceLineNo">036</span><a id="line.36">{</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> private static final long serialVersionUID = 2063260311211245209L;</a>
<span class="sourceLineNo">039</span><a id="line.39"> String accessToken;</a>
<span class="sourceLineNo">040</span><a id="line.40"> String tokenType = "Bearer";</a>
<span class="sourceLineNo">041</span><a id="line.41"> long expiresIn;</a>
<span class="sourceLineNo">042</span><a id="line.42"> String refreshToken;</a>
<span class="sourceLineNo">043</span><a id="line.43"> String scope;</a>
<span class="sourceLineNo">044</span><a id="line.44"> String state;</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> public TokenResponse( )</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"></a>
<span class="sourceLineNo">050</span><a id="line.50"> public TokenResponse( String accessToken, String tokenType, long expiresIn, String refreshToken, String scope )</a>
<span class="sourceLineNo">051</span><a id="line.51"> {</a>
<span class="sourceLineNo">052</span><a id="line.52"> this.accessToken = accessToken;</a>
<span class="sourceLineNo">053</span><a id="line.53"> this.tokenType = tokenType;</a>
<span class="sourceLineNo">054</span><a id="line.54"> this.expiresIn = expiresIn;</a>
<span class="sourceLineNo">055</span><a id="line.55"> this.refreshToken = refreshToken;</a>
<span class="sourceLineNo">056</span><a id="line.56"> this.scope = scope;</a>
<span class="sourceLineNo">057</span><a id="line.57"> }</a>
<span class="sourceLineNo">058</span><a id="line.58"></a>
<span class="sourceLineNo">059</span><a id="line.59"> public TokenResponse( String accessToken, long expiresIn, String refreshToken, String scope )</a>
<span class="sourceLineNo">060</span><a id="line.60"> {</a>
<span class="sourceLineNo">061</span><a id="line.61"> this.accessToken = accessToken;</a>
<span class="sourceLineNo">062</span><a id="line.62"> this.expiresIn = expiresIn;</a>
<span class="sourceLineNo">063</span><a id="line.63"> this.refreshToken = refreshToken;</a>
<span class="sourceLineNo">064</span><a id="line.64"> this.scope = scope;</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"> public TokenResponse( Token accessToken, Token refreshToken )</a>
<span class="sourceLineNo">068</span><a id="line.68"> {</a>
<span class="sourceLineNo">069</span><a id="line.69"> this.expiresIn = Duration.between( Instant.now( ), accessToken.getMetadata( ).validBefore( ) ).getSeconds();</a>
<span class="sourceLineNo">070</span><a id="line.70"> this.accessToken = accessToken.getData( );</a>
<span class="sourceLineNo">071</span><a id="line.71"> this.refreshToken = refreshToken.getData( );</a>
<span class="sourceLineNo">072</span><a id="line.72"> this.scope = "";</a>
<span class="sourceLineNo">073</span><a id="line.73"> }</a>
<span class="sourceLineNo">074</span><a id="line.74"></a>
<span class="sourceLineNo">075</span><a id="line.75"> public TokenResponse( Token accessToken, Token refreshToken , String scope, String state)</a>
<span class="sourceLineNo">076</span><a id="line.76"> {</a>
<span class="sourceLineNo">077</span><a id="line.77"> this.expiresIn = Duration.between( Instant.now( ), accessToken.getMetadata( ).validBefore( ) ).getSeconds();</a>
<span class="sourceLineNo">078</span><a id="line.78"> this.accessToken = accessToken.getData( );</a>
<span class="sourceLineNo">079</span><a id="line.79"> this.refreshToken = refreshToken.getData( );</a>
<span class="sourceLineNo">080</span><a id="line.80"> this.scope = scope;</a>
<span class="sourceLineNo">081</span><a id="line.81"> this.state = state;</a>
<span class="sourceLineNo">082</span><a id="line.82"> }</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> @XmlElement(name="access_token")</a>
<span class="sourceLineNo">085</span><a id="line.85"> @Schema(description = "The access token that may be used as Bearer token in the Authorization header")</a>
<span class="sourceLineNo">086</span><a id="line.86"> public String getAccessToken( )</a>
<span class="sourceLineNo">087</span><a id="line.87"> {</a>
<span class="sourceLineNo">088</span><a id="line.88"> return accessToken;</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"> public void setAccessToken( String accessToken )</a>
<span class="sourceLineNo">092</span><a id="line.92"> {</a>
<span class="sourceLineNo">093</span><a id="line.93"> this.accessToken = accessToken;</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"> @XmlElement(name="token_type")</a>
<span class="sourceLineNo">097</span><a id="line.97"> @Schema(description = "The type of the token. Currently only Bearer Tokens are supported.")</a>
<span class="sourceLineNo">098</span><a id="line.98"> public String getTokenType( )</a>
<span class="sourceLineNo">099</span><a id="line.99"> {</a>
<span class="sourceLineNo">100</span><a id="line.100"> return tokenType;</a>
<span class="sourceLineNo">101</span><a id="line.101"> }</a>
<span class="sourceLineNo">102</span><a id="line.102"></a>
<span class="sourceLineNo">103</span><a id="line.103"> public void setTokenType( String tokenType )</a>
<span class="sourceLineNo">104</span><a id="line.104"> {</a>
<span class="sourceLineNo">105</span><a id="line.105"> this.tokenType = tokenType;</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"> @XmlElement(name="expires_in")</a>
<span class="sourceLineNo">109</span><a id="line.109"> @Schema(description = "The time in seconds. After this time the token will expire and is not valid for authentication.")</a>
<span class="sourceLineNo">110</span><a id="line.110"> public long getExpiresIn( )</a>
<span class="sourceLineNo">111</span><a id="line.111"> {</a>
<span class="sourceLineNo">112</span><a id="line.112"> return expiresIn;</a>
<span class="sourceLineNo">113</span><a id="line.113"> }</a>
<span class="sourceLineNo">114</span><a id="line.114"></a>
<span class="sourceLineNo">115</span><a id="line.115"> public void setExpiresIn( long expiresIn )</a>
<span class="sourceLineNo">116</span><a id="line.116"> {</a>
<span class="sourceLineNo">117</span><a id="line.117"> this.expiresIn = expiresIn;</a>
<span class="sourceLineNo">118</span><a id="line.118"> }</a>
<span class="sourceLineNo">119</span><a id="line.119"></a>
<span class="sourceLineNo">120</span><a id="line.120"> @XmlElement(name="refresh_token")</a>
<span class="sourceLineNo">121</span><a id="line.121"> @Schema(description = "The refresh token, that can be used for getting a new access token.")</a>
<span class="sourceLineNo">122</span><a id="line.122"> public String getRefreshToken( )</a>
<span class="sourceLineNo">123</span><a id="line.123"> {</a>
<span class="sourceLineNo">124</span><a id="line.124"> return refreshToken;</a>
<span class="sourceLineNo">125</span><a id="line.125"> }</a>
<span class="sourceLineNo">126</span><a id="line.126"></a>
<span class="sourceLineNo">127</span><a id="line.127"> public void setRefreshToken( String refreshToken )</a>
<span class="sourceLineNo">128</span><a id="line.128"> {</a>
<span class="sourceLineNo">129</span><a id="line.129"> this.refreshToken = refreshToken;</a>
<span class="sourceLineNo">130</span><a id="line.130"> }</a>
<span class="sourceLineNo">131</span><a id="line.131"></a>
<span class="sourceLineNo">132</span><a id="line.132"> @Schema(description = "Scope of the token. Currently there are no scopes defined.")</a>
<span class="sourceLineNo">133</span><a id="line.133"> public String getScope( )</a>
<span class="sourceLineNo">134</span><a id="line.134"> {</a>
<span class="sourceLineNo">135</span><a id="line.135"> return scope;</a>
<span class="sourceLineNo">136</span><a id="line.136"> }</a>
<span class="sourceLineNo">137</span><a id="line.137"></a>
<span class="sourceLineNo">138</span><a id="line.138"> public void setScope( String scope )</a>
<span class="sourceLineNo">139</span><a id="line.139"> {</a>
<span class="sourceLineNo">140</span><a id="line.140"> this.scope = scope;</a>
<span class="sourceLineNo">141</span><a id="line.141"> }</a>
<span class="sourceLineNo">142</span><a id="line.142"></a>
<span class="sourceLineNo">143</span><a id="line.143"> @Schema(description = "The state value will be returned, if a state is provided in the request.")</a>
<span class="sourceLineNo">144</span><a id="line.144"> public String getState( )</a>
<span class="sourceLineNo">145</span><a id="line.145"> {</a>
<span class="sourceLineNo">146</span><a id="line.146"> return state;</a>
<span class="sourceLineNo">147</span><a id="line.147"> }</a>
<span class="sourceLineNo">148</span><a id="line.148"></a>
<span class="sourceLineNo">149</span><a id="line.149"> public void setState( String state )</a>
<span class="sourceLineNo">150</span><a id="line.150"> {</a>
<span class="sourceLineNo">151</span><a id="line.151"> this.state = state;</a>
<span class="sourceLineNo">152</span><a id="line.152"> }</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> public boolean hasState() {</a>
<span class="sourceLineNo">155</span><a id="line.155"> return state != null &amp;&amp; state.length( ) &gt; 0;</a>
<span class="sourceLineNo">156</span><a id="line.156"> }</a>
<span class="sourceLineNo">157</span><a id="line.157">}</a>
</pre>
</div>
</main>
</body>
</html>