com.openshift.restclient.authorization.IAuthorizationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openshift-restclient-java
OpenShift Java Client
The newest version!
/*******************************************************************************
 * Copyright (c) 2015 Red Hat, Inc. Distributed under license by Red Hat, Inc.
 * All rights reserved. This program is made available under the terms of the
 * Eclipse Public License v1.0 which accompanies this distribution, and is
 * available at http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: Red Hat, Inc.
 ******************************************************************************/

package com.openshift.restclient.authorization;

import com.openshift.restclient.model.user.IUser;

public interface IAuthorizationContext {

    public static final String AUTHSCHEME_BASIC = "Basic";
    public static final String AUTHSCHEME_OAUTH = "OAuth";

    /**
     * The authorized user if it can be found for this token
     * 
     * @return return the user for the token or null if not authorized
     */
    IUser getUser();

    /**
     * This can trigger a remote call if a user has not attempted to authorize
     * previously
     * 
     * @return true if authorized; false otherwise
     */
    boolean isAuthorized();

    /**
     * The authorization scope if it can be determined.
     * 
     * @return the scope or null if unknown
     */
    String getAuthScheme();

    /**
     * Token to use for authentication. Will return non-null value if authorized
     * 
     */
    String getToken();

    /**
     * The token to try and use for communication to the apiserver
     * 
     */
    void setToken(String token);

    /**
     * A username to use for authenticating
     * 
     */
    void setUserName(String userName);

    /**
     * A username to use for authenticating
     * 
     * @return userName
     */
    String getUserName();

    /**
     * Password to use to authenticate to retrieve a token
     * 
     */
    void setPassword(String password);

    /**
     * Password to use to authenticate to retrieve a token
     * 
     * @return password
     */
    String getPassword();

    /**
     * Time in ?? when the token expires. Will return non-null value if authorized
     * 
     */
    String getExpiresIn();

    /**
     * Retrieve the authorization details for a server
     * 
     */
    IAuthorizationDetails getAuthorizationDetails();
    
    /**
     * Invalidates this context which forces re-authentication. The context gets unauthenticated,
     * User and token are cleared.
     */
    void invalidate();
}