001package org.apache.archiva.redback.keys;
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.io.Serializable;
023import java.util.Date;
024
025/**
026 * AuthenticationKey is an object representing a key established to
027 * automatically authenticate a user without the user providing typical
028 * login credentials.
029 *
030 * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>
031 *
032 */
033public interface AuthenticationKey extends Serializable
034{
035    Date getDateCreated();
036
037    Date getDateExpires();
038
039    String getForPrincipal();
040
041    String getKey();
042
043    /**
044     * A String representation of what the purpose of existence is for this key.
045     *
046     * Examples: "selfservice password reset", "inter system communications", "remember me"
047     *
048     * @return
049     */
050    String getPurpose();
051
052    void setDateCreated( Date dateCreated );
053
054    void setDateExpires( Date dateExpires );
055
056    void setForPrincipal( String forPrincipal );
057
058    void setKey( String key );
059
060    void setPurpose( String requestedFrom );
061}