io.micronaut.security.oauth2.endpoint.authorization.request.Display Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-security-oauth2 Show documentation

Official Security Solution for Micronaut

There is a newer version: 4.11.1

Show newest version

/*
 * Copyright 2017-2023 original 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
 *
 * https://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 io.micronaut.security.oauth2.endpoint.authorization.request;

/**
 * OpenID connect Display parameter.
 *
 * @see OpenID connect / Authentication Request
 *
 * @author Sergio del Amo
 * @since 1.2.0
 */
public enum Display {

    /**
     * The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.
     */
    PAGE("page"),

    /**
     * The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.
     */
    POPUP("popup"),

    /**
     * The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.
     */
    TOUCH("touch"),

    /**
     * The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display.
     */
    WAP("wap");

    private String displayName;

    /**
     * Instantiates the OpenID connect Display parameter.
     * @param displayName Display parameter.
     */
    Display(String displayName) {
        this.displayName = displayName;
    }

    /**
     *
     * @return OpenID connect Display parameter
     */
    public String getDisplay() {
        return displayName;
    }

    @Override
    public String toString() {
        return displayName;
    }
}