/*
 * Copyright 2019 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.models;

import org.keycloak.provider.Provider;


/**
 * @author <a href="mailto:h2-wada@nri.co.jp">Hiroyuki Wada</a>
 */
public interface OAuth2DeviceUserCodeProvider extends Provider {

    /**
     * Generate a new user code for OAuth 2.0 Device Authorization Grant.
     *
     * @return Return a generated user code
     */
    String generate();

    /**
     * Get human-readability user code from original user code.
     *
     * @param userCode Original user code
     * @return Return a human-readability user code
     */
    String display(String userCode);

    /**
     * Format inputted user code.
     *
     * @param userCode Inputted user code.
     * @return
     */
    String format(String userCode);
}