org.hyperledger.fabric_ca.sdk

Class HFCAIdentity

java.lang.Object

org.hyperledger.fabric_ca.sdk.HFCAIdentity

public class HFCAIdentity
extends Object

Method Summary

Modifier and Type	Method and Description
int	create(User registrar) create an identity
int	delete(User registrar) delete an identity
String	getAffiliation() The affiliation of the identity
Collection<Attribute>	getAttributes() The attributes of the identity
String	getEnrollmentId() The name of the identity
Integer	getMaxEnrollments() The max enrollment value of the identity
String	getSecret() The secret of the identity
String	getType() The type of the identity
boolean	isDeleted() Returns true if the identity has been deleted
int	read(User registrar) read retrieves a specific identity
void	setAffiliation(HFCAAffiliation affiliation) Set affiliation of the identity
void	setAffiliation(String affiliation) Set affiliation of the identity
void	setAttributes(Collection<Attribute> attributes)
void	setMaxEnrollments(Integer maxEnrollments)
void	setSecret(String secret)
void	setType(String type)
int	update(User registrar) update an identity

Methods inherited from class java.lang.Object

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

Method Detail

getEnrollmentId

public String getEnrollmentId()

The name of the identity

Returns:

The identity name.

getType

public String getType()

The type of the identity

Returns:

The identity type.

setType

public void setType(String type)

getSecret

public String getSecret()

The secret of the identity

Returns:

The identity secret.

setSecret

public void setSecret(String secret)

getMaxEnrollments

public Integer getMaxEnrollments()

The max enrollment value of the identity

Returns:

The identity max enrollment.

setMaxEnrollments

public void setMaxEnrollments(Integer maxEnrollments)

getAffiliation

public String getAffiliation()

The affiliation of the identity

Returns:

The identity affiliation.

setAffiliation

public void setAffiliation(String affiliation)

Set affiliation of the identity

Parameters:

affiliation - Affiliation name

setAffiliation

public void setAffiliation(HFCAAffiliation affiliation)

Set affiliation of the identity

Parameters:

affiliation - Affiliation name

getAttributes

public Collection<Attribute> getAttributes()

The attributes of the identity

Returns:

The identity attributes.

setAttributes

public void setAttributes(Collection<Attribute> attributes)

isDeleted

public boolean isDeleted()

Returns true if the identity has been deleted

Returns:

Returns true if the identity has been deleted

read

public int read(User registrar)
         throws IdentityException,
                InvalidArgumentException

read retrieves a specific identity

Parameters:

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

Returns:

statusCode The HTTP status code in the response

Throws:

IdentityException - if retrieving an identity fails.

InvalidArgumentException - Invalid (null) argument specified

create

public int create(User registrar)
           throws IdentityException,
                  InvalidArgumentException

create an identity

Parameters:

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

Returns:

statusCode The HTTP status code in the response

Throws:

IdentityException - if creating an identity fails.

InvalidArgumentException - Invalid (null) argument specified

update

public int update(User registrar)
           throws IdentityException,
                  InvalidArgumentException

update an identity

Parameters:

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

Returns:

statusCode The HTTP status code in the response

Throws:

IdentityException - if adding an identity fails.

InvalidArgumentException - Invalid (null) argument specified

delete

public int delete(User registrar)
           throws IdentityException,
                  InvalidArgumentException

delete an identity

Parameters:

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

Returns:

statusCode The HTTP status code in the response

Throws:

IdentityException - if adding an identity fails.

InvalidArgumentException - Invalid (null) argument specified