leap.oauth2.server.token.AuthzAccessToken Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of leap-oauth2-server Show documentation

There is a newer version: 0.7.13b

/*
 * Copyright 2015 the original author or authors.
 *
 * 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 leap.oauth2.server.token;

import java.io.Serializable;
import java.util.Map;
import java.util.function.BiConsumer;

import leap.lang.expirable.TimeExpirable;

/**
 * The token(s) issued by authorization server.
 */
public interface AuthzAccessToken extends TimeExpirable, Serializable {
	
	/**
	 * Required. Returns the token value of access token.
	 */
	String getToken();
	
	/**
	 * Returns the type of access token.
	 */
	default String getTokenType() {
	    return "Bearer";
	}
	
	/**
	 * Returns the client id.
	 */
	String getClientId();
	
	/**
	 * Returns the user id.
	 */
	String getUserId();

	/**
	 * Returns the user login name.
	 */
	String getUsername();
	
	/**
	 * Optional. 
	 */
	String getRefreshToken();
	
	/**
	 * Optional.
	 */
	String getScope();

	/**
	 * Optional.
     */
	void setScope(String scope);
	
	/**
	 * Optional.
	 */
	Map getExtendedParameters();

	/**
	 * Optional, add an extend parameter to this token.
	 */
	void addExtendedParameters(String key, Object value);

	/**
	 * Optional, ergodic all extend parameters of this token, if extended parameters is null, do nothing.
	 * @param consumer
	 */
	void forEachExtendParams(BiConsumer consumer);
	
	/**
	 * Returns true if the extended parameters is not empty.
	 */
	default boolean hasExtendedParameters() {
	    return null != getExtendedParameters() && !getExtendedParameters().isEmpty();
	}
	
	/**
	 * Returns true if the token has been issued to client only.
	 */
	default boolean isClientOnly() {
	    return null != getClientId() && null == getUserId();
	}

	/**
	 * Returns true if the client is authenticated.
	 * @return
	 */
	boolean isAuthenticated();
}