org.keycloak.adapters.springsecurity.client.KeycloakRestTemplate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keycloak-spring-security-adapter Show documentation

There is a newer version: 25.0.3

Show newest version

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * 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 org.keycloak.adapters.springsecurity.client;

import org.springframework.web.client.RestOperations;
import org.springframework.web.client.RestTemplate;

/**
 * Extends Spring's central class for client-side HTTP access, {@link RestTemplate}, adding
 * automatic authentication for service to service calls using the currently authenticated Keycloak principal.
 * This class is designed to work with other services secured by Keycloak.
 *
 * 
 *     The main advantage to using this class over Spring's RestTemplate is that authentication
 *     is handled automatically when both the service making the API call and the service being called are
 *     protected by Keycloak authentication.
 * 
 *
 * @see RestOperations
 * @see RestTemplate
 *
 * @author Scott Rossillo
 * @version $Revision: 1 $
 */
public class KeycloakRestTemplate extends RestTemplate implements RestOperations {

    /**
     * Create a new instance based on the given {@link KeycloakClientRequestFactory}.
     *
     * @param factory the KeycloakClientRequestFactory to use when creating new requests
     */
    public KeycloakRestTemplate(KeycloakClientRequestFactory factory) {
        super(factory);
    }

}