leap.oauth2.rs.OAuth2ResServerConfigurator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of leap-oauth2-webapp 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.rs;

import leap.core.security.token.jwt.JwtVerifier;

/**
 * The configurator of oauth2 resource server.
 */
public interface OAuth2ResServerConfigurator {

	/**
	 * The mode of authorization server that the resource server will obtain token details from it.
	 */
	enum AuthzServerMode {
		NONE,
		LOCAL,
		REMOTE
	}

	/**
	 * Returns the configuration.
     */
	OAuth2ResServerConfig config();

	/**
	 * Enables oauth2 resource server in current webapp.
     */
	default OAuth2ResServerConfigurator enable() {
		return setEnabled(true);
	}

	/**
	 * Sets enable or disable oauth2 resource server in current webapp.
     */
	OAuth2ResServerConfigurator setEnabled(boolean enabled);

	/**
	 * Use local authz server.
	 *
	 * @see {@link OAuth2ResServerConfig#isUseLocalAuthorizationServer()}.
     */
	OAuth2ResServerConfigurator useLocalAuthorizationServer();

	/**
	 * Use remote authz server.
	 *
	 * 
	 * The {@link #setRemoteTokenInfoEndpointUrl(String)} must be invoked later.
     */
	OAuth2ResServerConfigurator useRemoteAuthorizationServer();

	/**
	 * Use remote authz server and sets the token info endpoint url.
	 *
	 * @see {@link OAuth2ResServerConfig#isUseRemoteAuthorizationServer()}.
	 *
	 * @param tokenInfoEndpointUrl the token info endpoint url or remote authorization server.
     */
	OAuth2ResServerConfigurator useRemoteAuthorizationServer(String tokenInfoEndpointUrl);

	/**
	 * 
	 * Sets the ras public key string for rsa jwt verifier
	 * 
	 * @param publicKey ths rsa public key string
	 */
	OAuth2ResServerConfigurator setRsaPublicKeyStr(String publicKey);
	/**
	 * Use rsa jwt verifier to verify jwt token.
	 */
	OAuth2ResServerConfigurator useRsaJwtVerifier();
	
	/**
	 * Use the specify jwt verifier to verify jwt token
	 */
	OAuth2ResServerConfigurator useJwtVerifier(JwtVerifier verifier);
	
	/**
	 * Sets the mode of authz server.
     */
	OAuth2ResServerConfigurator setAuthorizationServerMode(AuthzServerMode mode);

	/**
	 * Sets the url of token info endpoint in oauth2 authorization server.
	 *
	 * 

	 * Valid when use remote authz server.
     */
	OAuth2ResServerConfigurator setRemoteTokenInfoEndpointUrl(String url);

    /**
     * Sets the url of user info endpoint in oauth2 authorization server.
     *
     * 

     * Valid when use remote authz server.
     */
    OAuth2ResServerConfigurator setRemoteUserInfoEndpointUrl(String url);

    /**
     * todo : doc
     */
    OAuth2ResServerConfigurator setTokenEndpointUrl(String url);

    /**
     * todo : doc
     */
    OAuth2ResServerConfigurator setAuthorizationEndpointUrl(String url);

    /**
     * todo : doc
     */
    OAuth2ResServerConfigurator setUseRemoteUserInfo(Boolean used);

	/**
	 * Sets the resource server Id of this server in oauth2 authorization server.
	 *
	 * 

	 * use when use remote authz server to validate access token.
	 */
	OAuth2ResServerConfigurator setResourceServerId(String resourceServerId);

	/**
	 * Sets the resource server secret of this server in oauth2 authorization server.
	 *
	 * 
	 * use when use remote authz server to validate access token.
	 */
	OAuth2ResServerConfigurator setResourceServerSecret(String resourceServerSecret);

	
}