org.apache.cxf.rs.security.oauth2.grants.code.AuthorizationCodeRegistration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cxf-bundle Show documentation
Apache CXF Bundle Jar
There is a newer version: 3.0.0-milestone2
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.apache.cxf.rs.security.oauth2.grants.code;

import java.util.Collections;
import java.util.List;

import org.apache.cxf.rs.security.oauth2.common.Client;
import org.apache.cxf.rs.security.oauth2.common.UserSubject;

/**
 * Captures the information associated with the code grant registration request.
 * @see ServerAuthorizationCodeGrant  
 */
public class AuthorizationCodeRegistration {
    private Client client; 
    private List requestedScope = Collections.emptyList();
    private List approvedScope = Collections.emptyList();
    private String redirectUri;
    private UserSubject subject;
    
    /**
     * Sets the {@link Client} reference
     * @param client the client
     */
    public void setClient(Client client) {
        this.client = client;
    }
    /**
     * Gets {@link Client} reference
     * @return the client
     */
    public Client getClient() {
        return client;
    }
    /**
     * Sets the redirect URI
     * @param redirectUri the redirect URI
     */
    public void setRedirectUri(String redirectUri) {
        this.redirectUri = redirectUri;
    }
    /**
     * Gets the redirect URI
     * @return the redirect URI
     */
    public String getRedirectUri() {
        return redirectUri;
    }
    
    /**
     * Sets the scopes request by the client
     * @param requestedScope the requested scopes
     */
    public void setRequestedScope(List requestedScope) {
        this.requestedScope = requestedScope;
    }
    
    /**
     * Gets the scopes request by the client
     * @return the requested scopes
     */
    public List getRequestedScope() {
        return requestedScope;
    }
    
    /**
     * Sets the scopes explicitly approved by the end user.
     * If this list is empty then the end user had no way to down-scope. 
     * @param approvedScope the approved scopes
     */
    public void setApprovedScope(List approvedScope) {
        this.approvedScope = approvedScope;
    }
    
    /**
     * Gets the scopes explicitly approved by the end user
     * @return the approved scopes
     */
    public List getApprovedScope() {
        return approvedScope;
    }
    
    /**
     * Sets the user subject representing the end user
     * @param subject the subject
     */
    public void setSubject(UserSubject subject) {
        this.subject = subject;
    }
    
    /**
     * Gets the user subject representing the end user
     * @return the subject
     */
    public UserSubject getSubject() {
        return subject;
    }
}