AuthManager (java-sdk 3.8.0 API)

java.lang.Object
- org.fisco.bcos.sdk.v3.contract.auth.manager.AuthManager

public class AuthManager
extends java.lang.Object

构造器概要

构造器
构造器和说明
`AuthManager(Client client, CryptoKeyPair credential)`
`AuthManager(Client client, CryptoKeyPair credential, java.math.BigInteger blockNumberInterval)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.Boolean`	`accountAvailable(java.lang.String accountAddress)` check account is available, if normal then return true
`void`	`asyncRevokeProposal(java.math.BigInteger proposalId, TransactionCallback callback)` async revoke proposal, only governor can call it
`void`	`asyncSetAccountStatus(java.lang.String account, AccessStatus status, PrecompiledCallback callback)` async set account status, only governor can call it.
`void`	`asyncSetContractStatus(java.lang.String contractAddress, AccessStatus status, PrecompiledCallback callback)` async set a contract status, only contract manager can call
`void`	`asyncSetContractStatus(java.lang.String contractAddress, boolean isFreeze, PrecompiledCallback callback)` async set a contract status, freeze or normal, only contract manager can call
`void`	`asyncSetMethodAuth(java.lang.String contractAddress, byte[] func, java.lang.String account, boolean isOpen, PrecompiledCallback callback)` async set a specific contract's method ACL, only contract admin can call it
`void`	`asyncSetMethodAuthType(java.lang.String contractAddress, byte[] func, AuthType authType, PrecompiledCallback callback)` async set a specific contract's method auth type, only contract admin can call it
`void`	`asyncVoteProposal(java.math.BigInteger proposalId, java.lang.Boolean agree, TransactionCallback callback)` async unified vote, only governor can call it
`java.lang.Boolean`	`checkDeployAuth(java.lang.String account)` check the account whether this account can deploy contract
`java.lang.Boolean`	`checkMethodAuth(java.lang.String contractAddress, byte[] func, java.lang.String account)` check the contract interface func whether this account can call
`java.lang.Boolean`	`contractAvailable(java.lang.String contractAddress)` check contract is available, if normal then return true
`java.math.BigInteger`	`createRmNodeProposal(java.lang.String node)` submit a proposal of remove consensus node, only governor can call it
`java.math.BigInteger`	`createSetConsensusWeightProposal(java.lang.String node, java.math.BigInteger weight, boolean addFlag)` submit a proposal of set consensus node weight, only governor can call it
`java.math.BigInteger`	`createSetSysConfigProposal(java.lang.String key, java.lang.String value)` submit a proposal of set system config, only governor can call it
`java.math.BigInteger`	`createUpgradeVoteComputerProposal(java.lang.String address)` submit a proposal of upgrade vote computer logic contract, only governor can call it
`AccountManager`	`getAccountManager()`
`java.lang.String`	`getAdmin(java.lang.String contractAddress)` get a specific contract admin
`java.lang.String`	`getCommitteeAddress()`
`CommitteeInfo`	`getCommitteeInfo()` get Committee info
`CommitteeManager`	`getCommitteeManager()`
`ContractAuthPrecompiled`	`getContractAuthPrecompiled()`
`java.math.BigInteger`	`getDeployAuthType()` get global deploy auth type
`Tuple3<AuthType,java.util.List<java.lang.String>,java.util.List<java.lang.String>>`	`getMethodAuth(java.lang.String contractAddress, byte[] func)` get auth of specific contract's method func
`ProposalInfo`	`getProposalInfo(java.math.BigInteger proposalId)` get proposal info
`java.util.List<ProposalInfo>`	`getProposalInfoList(java.math.BigInteger from, java.math.BigInteger to)` get proposal info list, range in [from,to]
`java.lang.String`	`getProposalManagerAddress()`
`RetCode`	`initAuth(java.lang.String admin)` init committee system for old version chain which not open auth check NOTE: this method only can be used when chain version >= 3.3.0
`java.math.BigInteger`	`modifyDeployAuth(java.lang.String account, java.lang.Boolean openFlag)` submit a proposal of adding deploy contract auth for account, only governor can call it
`java.math.BigInteger`	`proposalCount()` get proposal count
`java.math.BigInteger`	`resetAdmin(java.lang.String newAdmin, java.lang.String contractAddr)` submit a proposal of resetting contract admin, only governor can call it
`TransactionReceipt`	`revokeProposal(java.math.BigInteger proposalId)` revoke proposal, only governor can call it
`RetCode`	`setAccountStatus(java.lang.String account, AccessStatus status)` Set account status, only governor can call it.
`RetCode`	`setContractStatus(java.lang.String contractAddress, AccessStatus status)` set a contract status, only contract manager can call
`RetCode`	`setContractStatus(java.lang.String contractAddress, boolean isFreeze)` set a contract status, freeze or normal, only contract manager can call
`java.math.BigInteger`	`setDeployAuthType(AuthType deployAuthType)` submit a proposal of setting deploy contract auth type, only governor can call it
`RetCode`	`setMethodAuth(java.lang.String contractAddress, byte[] func, java.lang.String account, boolean isOpen)` set a specific contract's method ACL, only contract admin can call it
`RetCode`	`setMethodAuthType(java.lang.String contractAddress, byte[] func, AuthType authType)` set a specific contract's method auth type, only contract admin can call it
`java.math.BigInteger`	`setRate(java.math.BigInteger participatesRate, java.math.BigInteger winRate)` apply set participate rate and win rate. only governor can call it
`java.math.BigInteger`	`updateGovernor(java.lang.String account, java.math.BigInteger weight)` apply for update governor, only governor can call it
`TransactionReceipt`	`voteProposal(java.math.BigInteger proposalId, java.lang.Boolean agree)` unified vote, only governor can call it

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AuthManager
```
public AuthManager(Client client,
                   CryptoKeyPair credential)
```
  - AuthManager
```
public AuthManager(Client client,
                   CryptoKeyPair credential,
                   java.math.BigInteger blockNumberInterval)
```
- 方法详细资料
  - getCommitteeManager
```
public CommitteeManager getCommitteeManager()
```
  - getContractAuthPrecompiled
```
public ContractAuthPrecompiled getContractAuthPrecompiled()
```
  - getAccountManager
```
public AccountManager getAccountManager()
```
  - getCommitteeAddress
```
public java.lang.String getCommitteeAddress()
                                     throws ContractException
```
    抛出:
    
    ContractException
  - getProposalManagerAddress
```
public java.lang.String getProposalManagerAddress()
                                           throws ContractException
```
    抛出:
    
    ContractException
  - updateGovernor
```
public java.math.BigInteger updateGovernor(java.lang.String account,
                                           java.math.BigInteger weight)
                                    throws ContractException
```
    apply for update governor, only governor can call it
    
    参数:
    
    account - new governor address
    
    weight - 0 == delete, bigger than 0 == update or insert
    
    返回:
    
    proposalId
    
    抛出:
    
    ContractException - throw when contract exec exception
  - setRate
```
public java.math.BigInteger setRate(java.math.BigInteger participatesRate,
                                    java.math.BigInteger winRate)
                             throws ContractException
```
    apply set participate rate and win rate. only governor can call it
    
    参数:
    
    participatesRate - [0,100]. if 0, always succeed.
    
    winRate - [0,100].
    
    返回:
    
    proposalId
    
    抛出:
    
    ContractException - throw when contract exec exception
  - setDeployAuthType
```
public java.math.BigInteger setDeployAuthType(AuthType deployAuthType)
                                       throws ContractException
```
    submit a proposal of setting deploy contract auth type, only governor can call it
    
    参数:
    
    deployAuthType - 1-whitelist; 2-blacklist
    
    返回:
    
    proposalId
    
    抛出:
    
    ContractException - throw when contract exec exception
  - getDeployAuthType
```
public java.math.BigInteger getDeployAuthType()
                                       throws ContractException
```
    get global deploy auth type
    
    返回:
    
    deployAuthType
    
    抛出:
    
    ContractException - throw when contract exec exception
  - modifyDeployAuth
```
public java.math.BigInteger modifyDeployAuth(java.lang.String account,
                                             java.lang.Boolean openFlag)
                                      throws ContractException
```
    submit a proposal of adding deploy contract auth for account, only governor can call it
    
    参数:
    
    account - account address string
    
    openFlag - true-open; false-close
    
    返回:
    
    proposalId
    
    抛出:
    
    ContractException - throw when contract exec exception
  - resetAdmin
```
public java.math.BigInteger resetAdmin(java.lang.String newAdmin,
                                       java.lang.String contractAddr)
                                throws ContractException
```
    submit a proposal of resetting contract admin, only governor can call it
    
    参数:
    
    newAdmin - admin address
    
    contractAddr - the address of contract which will propose to reset admin
    
    返回:
    
    proposalId
    
    抛出:
    
    ContractException - throw when contract exec exception
  - createRmNodeProposal
```
public java.math.BigInteger createRmNodeProposal(java.lang.String node)
                                          throws ContractException
```
    submit a proposal of remove consensus node, only governor can call it
    
    参数:
    
    node - node ID
    
    返回:
    
    proposal ID
    
    抛出:
    
    ContractException - throw when contract exec exception
  - createSetConsensusWeightProposal
```
public java.math.BigInteger createSetConsensusWeightProposal(java.lang.String node,
                                                             java.math.BigInteger weight,
                                                             boolean addFlag)
                                                      throws ContractException
```
    submit a proposal of set consensus node weight, only governor can call it
    
    参数:
    
    node - node ID
    
    weight - consensus weight: weigh bigger than 0, sealer; weight = 0, observer
    
    addFlag - flag to distinguish add a node or set node's weight,
    
    返回:
    
    proposal ID
    
    抛出:
    
    ContractException - throw when contract exec exception
  - createSetSysConfigProposal
```
public java.math.BigInteger createSetSysConfigProposal(java.lang.String key,
                                                       java.lang.String value)
                                                throws ContractException
```
    submit a proposal of set system config, only governor can call it
    
    参数:
    
    key - system config key, only support (tx_gas_limit,tx_count_limit,consensus_leader_period)
    
    value - system config value, notice that tx_gas_limit bigger than 100,000, tx_count_limit bigger than 1, consensus_leader_period bigger than 1
    
    返回:
    
    proposal ID
    
    抛出:
    
    ContractException - throw when contract exec exception
  - createUpgradeVoteComputerProposal
```
public java.math.BigInteger createUpgradeVoteComputerProposal(java.lang.String address)
                                                       throws ContractException
```
    submit a proposal of upgrade vote computer logic contract, only governor can call it
    
    参数:
    
    address - vote computer address
    
    返回:
    
    proposal ID
    
    抛出:
    
    ContractException - throw when contract exec exception
  - revokeProposal
```
public TransactionReceipt revokeProposal(java.math.BigInteger proposalId)
```
    revoke proposal, only governor can call it
    
    参数:
    
    proposalId - id
    
    返回:
    
    transaction receipt
  - asyncRevokeProposal
```
public void asyncRevokeProposal(java.math.BigInteger proposalId,
                                TransactionCallback callback)
```
    async revoke proposal, only governor can call it
    
    参数:
    
    proposalId - id
    
    callback - callback when get receipt
  - voteProposal
```
public TransactionReceipt voteProposal(java.math.BigInteger proposalId,
                                       java.lang.Boolean agree)
```
    unified vote, only governor can call it
    
    参数:
    
    proposalId - id
    
    agree - true or false
    
    返回:
    
    transaction receipt
  - asyncVoteProposal
```
public void asyncVoteProposal(java.math.BigInteger proposalId,
                              java.lang.Boolean agree,
                              TransactionCallback callback)
```
    async unified vote, only governor can call it
    
    参数:
    
    proposalId - id
    
    agree - true or false
    
    callback - callback when get receipt
  - getProposalInfo
```
public ProposalInfo getProposalInfo(java.math.BigInteger proposalId)
                             throws ContractException
```
    get proposal info
    
    参数:
    
    proposalId - proposal id
    
    返回:
    
    return ProposalInfo {id, proposer, proposalType, blockNumberInterval, status, address[] agreeVoters, address[] againstVoters }
    
    抛出:
    
    ContractException - throw when contract exec exception
  - getProposalInfoList
```
public java.util.List<ProposalInfo> getProposalInfoList(java.math.BigInteger from,
                                                        java.math.BigInteger to)
                                                 throws ContractException
```
    get proposal info list, range in [from,to]
    
    参数:
    
    from - begin proposal id
    
    to - end proposal id
    
    返回:
    
    return ProposalInfo list {id, proposer, proposalType, blockNumberInterval, status, address[] agreeVoters, address[] againstVoters }[]
    
    抛出:
    
    ContractException - throw when contract exec exception
  - getCommitteeInfo
```
public CommitteeInfo getCommitteeInfo()
                               throws ContractException
```
    get Committee info
    
    返回:
    
    CommitteeInfo
    
    抛出:
    
    ContractException - throw when contract exec exception
  - checkDeployAuth
```
public java.lang.Boolean checkDeployAuth(java.lang.String account)
                                  throws ContractException
```
    check the account whether this account can deploy contract
    
    参数:
    
    account - the account to check
    
    返回:
    
    true or false
    
    抛出:
    
    ContractException - throw when contract exec exception
  - checkMethodAuth
```
public java.lang.Boolean checkMethodAuth(java.lang.String contractAddress,
                                         byte[] func,
                                         java.lang.String account)
                                  throws ContractException
```
    check the contract interface func whether this account can call
    
    参数:
    
    contractAddress - the contractAddress
    
    func - interface func selector of contract, 4 bytes
    
    account - the account to check
    
    返回:
    
    true or false
    
    抛出:
    
    ContractException - throw when contract exec exception
  - getMethodAuth
```
public Tuple3<AuthType,java.util.List<java.lang.String>,java.util.List<java.lang.String>> getMethodAuth(java.lang.String contractAddress,
                                                                                                        byte[] func)
                                                                                                 throws ContractException
```
    get auth of specific contract's method func
    
    参数:
    
    contractAddress - contract address
    
    func - method interface func selector, contains 4 bytes: hash(selector()).getBytes(0,4)
    
    返回:
    
    get a tuple of values: method auth type, access account list, block account list
    
    抛出:
    
    ContractException - AuthType.valueOf will throw this exception
  - getAdmin
```
public java.lang.String getAdmin(java.lang.String contractAddress)
                          throws ContractException
```
    get a specific contract admin
    
    参数:
    
    contractAddress - the contract to get admin
    
    返回:
    
    admin address
    
    抛出:
    
    ContractException - throw when contract exec exception
  - setMethodAuthType
```
public RetCode setMethodAuthType(java.lang.String contractAddress,
                                 byte[] func,
                                 AuthType authType)
                          throws ContractException
```
    set a specific contract's method auth type, only contract admin can call it
    
    参数:
    
    contractAddress - the contract address to set auth
    
    func - interface func selector of contract, 4 bytes
    
    authType - white_list or black_list
    
    返回:
    
    set result, 0 is success
    
    抛出:
    
    ContractException - throw when contract exec exception
  - asyncSetMethodAuthType
```
public void asyncSetMethodAuthType(java.lang.String contractAddress,
                                   byte[] func,
                                   AuthType authType,
                                   PrecompiledCallback callback)
```
    async set a specific contract's method auth type, only contract admin can call it
    
    参数:
    
    contractAddress - the contract address to set auth
    
    func - interface func selector of contract, 4 bytes
    
    authType - white_list or black_list
    
    callback - callback when get receipt
  - setMethodAuth
```
public RetCode setMethodAuth(java.lang.String contractAddress,
                             byte[] func,
                             java.lang.String account,
                             boolean isOpen)
                      throws ContractException
```
    set a specific contract's method ACL, only contract admin can call it
    
    参数:
    
    contractAddress - the contract address to set acl
    
    func - interface func selector of contract, 4 bytes
    
    account - the account to set
    
    isOpen - if open, then white_list type is true, black_list is false; if close, then white_list type is false, black_list is true;
    
    返回:
    
    set result, 0 is success
    
    抛出:
    
    ContractException - throw when contract exec exception
  - asyncSetMethodAuth
```
public void asyncSetMethodAuth(java.lang.String contractAddress,
                               byte[] func,
                               java.lang.String account,
                               boolean isOpen,
                               PrecompiledCallback callback)
```
    async set a specific contract's method ACL, only contract admin can call it
    
    参数:
    
    contractAddress - the contract address to set acl
    
    func - interface func selector of contract, 4 bytes
    
    account - the account to set
    
    isOpen - if open, then white_list type is true, black_list is false; if close, then white_list type is false, black_list is true;
    
    callback - callback when get receipt
  - setContractStatus
```
public RetCode setContractStatus(java.lang.String contractAddress,
                                 boolean isFreeze)
                          throws ContractException
```
    set a contract status, freeze or normal, only contract manager can call
    
    参数:
    
    contractAddress - contract address
    
    isFreeze - is freeze or normal
    
    返回:
    
    0 is success, otherwise is error
    
    抛出:
    
    ContractException - throw when contract exec exception
  - asyncSetContractStatus
```
public void asyncSetContractStatus(java.lang.String contractAddress,
                                   boolean isFreeze,
                                   PrecompiledCallback callback)
```
    async set a contract status, freeze or normal, only contract manager can call
    
    参数:
    
    contractAddress - contract address
    
    isFreeze - is freeze or normal
    
    callback - callback when get receipt
  - setContractStatus
```
public RetCode setContractStatus(java.lang.String contractAddress,
                                 AccessStatus status)
                          throws ContractException
```
    set a contract status, only contract manager can call
    
    参数:
    
    contractAddress - contract address
    
    status - 0 - normal, 1 - freeze, 2 - abolish
    
    返回:
    
    0 is success, otherwise is error
    
    抛出:
    
    ContractException - throw when contract exec exception
  - asyncSetContractStatus
```
public void asyncSetContractStatus(java.lang.String contractAddress,
                                   AccessStatus status,
                                   PrecompiledCallback callback)
```
    async set a contract status, only contract manager can call
    
    参数:
    
    contractAddress - contract address
    
    status - 0 - normal, 1 - freeze, 2 - abolish
    
    callback - callback when get receipt
  - contractAvailable
```
public java.lang.Boolean contractAvailable(java.lang.String contractAddress)
                                    throws ContractException
```
    check contract is available, if normal then return true
    
    参数:
    
    contractAddress - contract address
    
    返回:
    
    if true, then this contract can be called
    
    抛出:
    
    ContractException - throw when contract exec exception
  - setAccountStatus
```
public RetCode setAccountStatus(java.lang.String account,
                                AccessStatus status)
                         throws ContractException
```
    Set account status, only governor can call it. And account to be set should not in governor list, if account not exist in chain, it will create it by default
    
    参数:
    
    account - account address
    
    status - account status
    
    返回:
    
    proposal ID
    
    抛出:
    
    ContractException - throw when contract exec exception
  - asyncSetAccountStatus
```
public void asyncSetAccountStatus(java.lang.String account,
                                  AccessStatus status,
                                  PrecompiledCallback callback)
```
    async set account status, only governor can call it. And account to be set should not in governor list, if account not exist in chain, it will create it by default
    
    参数:
    
    account - account address
    
    status - account status
  - accountAvailable
```
public java.lang.Boolean accountAvailable(java.lang.String accountAddress)
                                   throws ContractException
```
    check account is available, if normal then return true
    
    参数:
    
    accountAddress - account address
    
    返回:
    
    if true, then this account can be used
    
    抛出:
    
    ContractException - throw when contract exec exception
  - proposalCount
```
public java.math.BigInteger proposalCount()
                                   throws ContractException
```
    get proposal count
    
    返回:
    
    count
    
    抛出:
    
    ContractException - throw when contract exec exception
  - initAuth
```
public RetCode initAuth(java.lang.String admin)
                 throws ContractException
```
    init committee system for old version chain which not open auth check NOTE: this method only can be used when chain version >= 3.3.0
    
    参数:
    
    admin - committee first admin
    
    返回:
    
    return code
    
    抛出:
    
    ContractException - throw when check failed or contract exec exception

类 AuthManager

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

AuthManager

AuthManager

方法详细资料

getCommitteeManager

getContractAuthPrecompiled

getAccountManager

getCommitteeAddress

getProposalManagerAddress

updateGovernor

setRate

setDeployAuthType

getDeployAuthType

modifyDeployAuth

resetAdmin

createRmNodeProposal

createSetConsensusWeightProposal

createSetSysConfigProposal

createUpgradeVoteComputerProposal

revokeProposal

asyncRevokeProposal

voteProposal

asyncVoteProposal

getProposalInfo

getProposalInfoList

getCommitteeInfo

checkDeployAuth

checkMethodAuth

getMethodAuth

getAdmin

setMethodAuthType

asyncSetMethodAuthType

setMethodAuth

asyncSetMethodAuth

setContractStatus

asyncSetContractStatus

setContractStatus

asyncSetContractStatus

contractAvailable

setAccountStatus

asyncSetAccountStatus

accountAvailable

proposalCount

initAuth