com.sap.cloud.sdk.services.blockchain.fabric.credentials

Class ChannelService

java.lang.Object

com.sap.cloud.sdk.services.blockchain.fabric.credentials.ChannelService

@Beta
public class ChannelService
extends Object

A Channel Service contains all necessary credentials and information to interact with a Hyperledger Fabric channel.

Constructor Summary

Constructors

Constructor and Description
ChannelService() Provides a Channel Service that contains all necessary credentials and can be used to receive a network object from the Fabric Service.
ChannelService(String userProvidedServiceName) Provides a Channel Service that contains all necessary credentials and can be used to receive a network object from the Fabric Service.
ChannelService(String userName, String mspId, X509Certificate certificate, PrivateKey privateKey, String channelName, byte[] connectionProfile) Provides a Channel Service that contains all provided credentials and can be used to receive a network object from the Fabric Service.

Method Summary

Modifier and Type	Method and Description
X509Certificate	getCertificate()
String	getChannelName()
byte[]	getConnectionProfile()
String	getMspId()
PrivateKey	getPrivateKey()
String	getUserName()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelService

public ChannelService(@Nonnull
                      String userName,
                      @Nonnull
                      String mspId,
                      @Nonnull
                      X509Certificate certificate,
                      @Nonnull
                      PrivateKey privateKey,
                      @Nonnull
                      String channelName,
                      @Nonnull
                      byte[] connectionProfile)

Provides a Channel Service that contains all provided credentials and can be used to receive a network object from the Fabric Service.

Parameters:

userName - Some name for this user

mspId - The MSP ID of the organization for this user

certificate - The X509 certificate for this user

privateKey - The private key for this user

channelName - The name of the Hyperledger Fabric channel

connectionProfile - The common connection profile that contains all the information about the Hyperledger Fabric network. For more information see https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/connectionprofile.html

ChannelService

public ChannelService(@Nonnull
                      String userProvidedServiceName)

Provides a Channel Service that contains all necessary credentials and can be used to receive a network object from the Fabric Service. All information is parsed from the user-provided service with the specific name in the Cloud Foundry environment of the application.

Parameters:

userProvidedServiceName - The name of the user-provided service (only mandatory if there are multiple user-provided services bound to the application)

Throws:

IllegalStateException - if the user-provided service with the given name could not be found

IllegalArgumentException - if the user-provided service is not a hyperledger-fabric ChannelService or some credentials are missing or can not be parsed

ChannelService

public ChannelService()

Provides a Channel Service that contains all necessary credentials and can be used to receive a network object from the Fabric Service. All information is parsed from the user-provided service in the Cloud Foundry environment of the application. If there are multiple user-provided services in the environment the name of the Hyperledger Fabric service must be provided.

Throws:

IllegalStateException - if there are no or more than one user-provided services

IllegalArgumentException - if the user-provided service is not a hyperledger-fabric ChannelService or some credentials are missing or can not be parsed

Method Detail

getUserName

@Nonnull
public String getUserName()

Returns:

the name of the user

getMspId

@Nonnull
public String getMspId()

Returns:

the MSP ID of the organization for this user

getCertificate

@Nonnull
public X509Certificate getCertificate()

Returns:

the public certificate of this user

getPrivateKey

@Nonnull
public PrivateKey getPrivateKey()

Returns:

the private key of this user

getChannelName

@Nonnull
public String getChannelName()

Returns:

the name of the channel on the Hyperledger Fabric network

getConnectionProfile

@Nonnull
public byte[] getConnectionProfile()

Returns:

the common connection profile that contains all the information about the Hyperledger Fabric network. For more information see https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/connectionprofile.html