1 package org.apache.archiva.redback.keys; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import java.util.Date; 23 24 /** 25 * AuthenticationKey is an object representing a key established to 26 * automatically authenticate a user without the user providing typical 27 * login credentials. 28 * 29 * @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a> 30 * 31 */ 32 public interface AuthenticationKey 33 { 34 Date getDateCreated(); 35 36 Date getDateExpires(); 37 38 String getForPrincipal(); 39 40 String getKey(); 41 42 /** 43 * A String representation of what the purpose of existence is for this key. 44 * <p/> 45 * Examples: "selfservice password reset", "inter system communications", "remember me" 46 * 47 * @return 48 */ 49 String getPurpose(); 50 51 void setDateCreated( Date dateCreated ); 52 53 void setDateExpires( Date dateExpires ); 54 55 void setForPrincipal( String forPrincipal ); 56 57 void setKey( String key ); 58 59 void setPurpose( String requestedFrom ); 60 }