org.keycloak.services.resource.RealmResourceSPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keycloak-server-spi Show documentation

There is a newer version: 26.1.4

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2016 Red Hat, Inc., and individual 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.services.resource;

import org.keycloak.provider.Provider;
import org.keycloak.provider.ProviderFactory;
import org.keycloak.provider.Spi;

/**
 * A {@link Spi} to plug additional sub-resources to Realms' RESTful API.
 *
 * Implementors can use this {@link Spi} to provide additional services to the mentioned API and extend Keycloak capabilities by
 * creating JAX-RS sub-resources for paths not known by the server.
 *
 * @author Pedro Igor
 */
public class RealmResourceSPI implements Spi {

    @Override
    public boolean isInternal() {
        return true;
    }

    @Override
    public String getName() {
        return "realm-restapi-extension";
    }

    @Override
    public Class getProviderClass() {
        return RealmResourceProvider.class;
    }

    @Override
    public Class getProviderFactoryClass() {
        return RealmResourceProviderFactory.class;
    }
}