001package org.apache.archiva.redback.authentication;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.time.Instant;
023
024/**
025 *
026 * This contains the token payload that is used for verification of tokens.
027 *
028 * Created by Martin Stockhammer on 11.02.17.
029 */
030public interface TokenData {
031
032    /**
033     * Returns the user name.
034     *
035     * @return The username property.
036     */
037    String getUser();
038
039    /**
040     * The date the token was created.
041     *
042     * @return The creation date.
043     */
044    Instant created();
045
046    /**
047     * The date after that the token is invalid.
048     *
049     * @return The invalidation date.
050     */
051    Instant validBefore();
052
053    /**
054     * The nonce that is stored in the token.
055     *
056     * @return The nonce.
057     */
058    long getNonce();
059
060    /**
061     * Returns true, if the token is valid.
062     *
063     * @return True, if valid, otherwise false.
064     */
065    boolean isValid();
066}