com.aliyun.odps.account.Account Maven / Gradle / Ivy

Go to download
/*
 * 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 com.aliyun.odps.account;

/**
 * 用于认证的账号信息
 *
 * 
 * 使用ODPS服务需要提供认证信息, Account接口的实现提供了ODPS支持的认证账号类型。阿里云用户仅可以使用阿里云账号。 

 * ODPS支持的账号包括:

 * 阿里云账号: {@link AccountProvider}.ALIYUN
 * 淘宝帐号: {@link AccountProvider}.TAOBAO
 * 域帐号: {@link AccountProvider}.DOMAIN
 * 
 */
public interface Account {

  /**
   * 淘宝账号,有两种认证方式（1）使用token认证（2）使用AccessId/AccessKey认证
   * 阿里云账号,使用AccessId/AccessKey认证
   * 域帐号使用token认证
   */
  public enum AccountProvider {
    // 淘宝帐号
    TAOBAO,
    // 阿里云账号
    ALIYUN,
    //LDAP账号
    LDAP,
    // logview token
    BEARER_TOKEN,
  }

  /**
   * 获取当前账号的类型
   *
   * @return {@link AccountProvider}对象
   */
  public AccountProvider getType();

  /**
   * 获得用于对API请求进行签名的{@link RequestSigner}对象
   *
   * @return {@link RequestSigner}对象
   */
  public RequestSigner getRequestSigner();
}