com.huawei.openstack4j.model.identity.v2.Token Maven / Gradle / Ivy

/*******************************************************************************
 * 	Copyright 2016 ContainX and OpenStack4j                                          
 * 	                                                                                 
 * 	Licensed under the Apache License, Version 2.0 (the "License"); you may not      
 * 	use this file except in compliance with the License. You may obtain a copy of    
 * 	the License at                                                                   
 * 	                                                                                 
 * 	    http://www.apache.org/licenses/LICENSE-2.0                                   
 * 	                                                                                 
 * 	Unless required by applicable law or agreed to in writing, software              
 * 	distributed under the License is distributed on an "AS IS" BASIS, WITHOUT        
 * 	WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the         
 * 	License for the specific language governing permissions and limitations under    
 * 	the License.                                                                     
 *******************************************************************************/
package com.huawei.openstack4j.model.identity.v2;

import java.util.Date;

import com.huawei.openstack4j.model.ModelEntity;
import com.huawei.openstack4j.model.identity.AuthVersion;

/**
 * A token which is used during authentication allowing follow up calls to only supply the assigned token within the header avoiding re-authentication
 * 
 * @author Jeremy Unruh
 * @see http://docs.openstack.org/api/openstack-identity-service/2.0/content/POST_admin-authenticate_v2.0_tokens_Token_Operations.html
 */
public interface Token extends ModelEntity {

	/**
	 * The generated token ID created by the Identity Restful service
	 *
	 * @return the token identifier
	 */
	String getId();
	
	/**
	 * The expiring date/time of this token
	 *
	 * @return the expire date/time
	 */
	Date getExpires();
	
	/**
	 * @return the authentication version of this token
	 */
	AuthVersion getVersion();
}