org.hyperledger.fabric_ca.sdk

Class HFCAAffiliation

java.lang.Object

org.hyperledger.fabric_ca.sdk.HFCAAffiliation

public class HFCAAffiliation
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HFCAAffiliation.HFCAAffiliationResp Response of affiliation requests

Method Summary

Modifier and Type	Method and Description
HFCAAffiliation.HFCAAffiliationResp	create(User registrar) create an affiliation
HFCAAffiliation.HFCAAffiliationResp	create(User registrar, boolean force) create an affiliation
HFCAAffiliation	createDecendent(String name) The identities affected during request
HFCAAffiliation.HFCAAffiliationResp	delete(User registrar) delete an affiliation
HFCAAffiliation.HFCAAffiliationResp	delete(User registrar, boolean force) delete an affiliation
HFCAAffiliation	getChild(String name) Gets child affiliation by name
Collection<HFCAAffiliation>	getChildren() The names of all affiliations affected by request
Collection<HFCAIdentity>	getIdentities() The identities affected during request.
String	getName() The name of the affiliation
String	getUpdateName() The name of the new affiliation
boolean	isDeleted() Returns true if the affiliation has been deleted
int	read(User registrar) gets a specific affiliation
void	setUpdateName(String updateName) The name of the new affiliation
HFCAAffiliation.HFCAAffiliationResp	update(User registrar) update an affiliation
HFCAAffiliation.HFCAAffiliationResp	update(User registrar, boolean force) update an affiliation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

The name of the affiliation

Returns:

The affiliation name.

getUpdateName

public String getUpdateName()
                     throws AffiliationException

The name of the new affiliation

Returns:

The affiliation name.

Throws:

AffiliationException

setUpdateName

public void setUpdateName(String updateName)
                   throws AffiliationException

The name of the new affiliation

Throws:

AffiliationException

getChildren

public Collection<HFCAAffiliation> getChildren()
                                        throws AffiliationException

The names of all affiliations affected by request

Returns:

The affiliation name.

Throws:

AffiliationException

getIdentities

public Collection<HFCAIdentity> getIdentities()
                                       throws AffiliationException

The identities affected during request. Identities are only returned for update and delete requests. Read and Create do not return identities

Returns:

The identities affected.

Throws:

AffiliationException

createDecendent

public HFCAAffiliation createDecendent(String name)
                                throws InvalidArgumentException,
                                       AffiliationException

The identities affected during request

Parameters:

name - Name of the child affiliation

Returns:

The requested child affiliation

Throws:

InvalidArgumentException

AffiliationException

getChild

public HFCAAffiliation getChild(String name)
                         throws AffiliationException,
                                InvalidArgumentException

Gets child affiliation by name

Parameters:

name - Name of the child affiliation to get

Returns:

The requested child affiliation

Throws:

AffiliationException

InvalidArgumentException

isDeleted

public boolean isDeleted()

Returns true if the affiliation has been deleted

Returns:

Returns true if the affiliation has been deleted

read

public int read(User registrar)
         throws AffiliationException,
                InvalidArgumentException

gets a specific affiliation

Parameters:

registrar - The identity of the registrar

Returns:

Returns response

Throws:

AffiliationException - if getting an affiliation fails.

InvalidArgumentException

create

public HFCAAffiliation.HFCAAffiliationResp create(User registrar)
                                           throws AffiliationException,
                                                  InvalidArgumentException

create an affiliation

Parameters:

registrar - The identity of the registrar (i.e. who is performing the registration).

Returns:

Response of request

Throws:

AffiliationException - if adding an affiliation fails.

InvalidArgumentException

create

public HFCAAffiliation.HFCAAffiliationResp create(User registrar,
                                                  boolean force)
                                           throws AffiliationException,
                                                  InvalidArgumentException

create an affiliation

Parameters:

registrar - The identity of the registrar (i.e. who is performing the registration).

force - Forces the creation of parent affiliations

Returns:

Response of request

Throws:

AffiliationException - if adding an affiliation fails.

InvalidArgumentException

update

public HFCAAffiliation.HFCAAffiliationResp update(User registrar)
                                           throws AffiliationException,
                                                  InvalidArgumentException

update an affiliation

Parameters:

registrar - The identity of the registrar (i.e. who is performing the registration).

Returns:

Response of request

Throws:

AffiliationException - If updating an affiliation fails

InvalidArgumentException

update

public HFCAAffiliation.HFCAAffiliationResp update(User registrar,
                                                  boolean force)
                                           throws AffiliationException,
                                                  InvalidArgumentException

update an affiliation

Parameters:

registrar - The identity of the registrar (i.e. who is performing the registration).

force - Forces updating of child affiliations

Returns:

Response of request

Throws:

AffiliationException - If updating an affiliation fails

InvalidArgumentException

delete

public HFCAAffiliation.HFCAAffiliationResp delete(User registrar)
                                           throws AffiliationException,
                                                  InvalidArgumentException

delete an affiliation

Parameters:

registrar - The identity of the registrar (i.e. who is performing the registration).

Returns:

Response of request

Throws:

AffiliationException - if deleting an affiliation fails.

InvalidArgumentException

delete

public HFCAAffiliation.HFCAAffiliationResp delete(User registrar,
                                                  boolean force)
                                           throws AffiliationException,
                                                  InvalidArgumentException

delete an affiliation

Parameters:

registrar - The identity of the registrar (i.e. who is performing the registration).

force - Forces the deletion of affiliation

Returns:

Response of request

Throws:

AffiliationException - if deleting an affiliation fails.

InvalidArgumentException