channelparticipation

Documentation

Index

• Constants
• func ValidateJoinBlock(channelID string, configBlock *cb.Block) (isAppChannel bool, err error)
• type ChannelManagement
• type HTTPHandler
  • func NewHTTPHandler(config localconfig.ChannelParticipation, registrar ChannelManagement) *HTTPHandler
  • func (h *HTTPHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)

Constants

const (
	URLBaseV1              = "/participation/v1/"
	URLBaseV1Channels      = URLBaseV1 + "channels"
	FormDataConfigBlockKey = "config-block"
	RemoveStorageQueryKey  = "removeStorage"
)

Functions

func ValidateJoinBlock

func ValidateJoinBlock(channelID string, configBlock *cb.Block) (isAppChannel bool, err error)

ValidateJoinBlock returns whether this block can be used as a join block for the channel participation API and whether it is an system channel if it contains consortiums, or otherwise and application channel if an application group exists.

Types

type ChannelManagement

type ChannelManagement interface {
	// ChannelList returns a slice of ChannelInfoShort containing all application channels (excluding the system
	// channel), and ChannelInfoShort of the system channel (nil if does not exist).
	// The URL fields are empty, and are to be completed by the caller.
	ChannelList() types.ChannelList

	// ChannelInfo provides extended status information about a channel.
	// The URL field is empty, and is to be completed by the caller.
	ChannelInfo(channelID string) (types.ChannelInfo, error)

	// JoinChannel instructs the orderer to create a channel and join it with the provided config block.
	JoinChannel(channelID string, configBlock *cb.Block, isAppChannel bool) (types.ChannelInfo, error)

	// RemoveChannel instructs the orderer to remove a channel.
	// Depending on the removeStorage parameter, the storage resources are either removed or archived.
	RemoveChannel(channelID string, removeStorage bool) error
}

type HTTPHandler

type HTTPHandler struct {
	// contains filtered or unexported fields
}

HTTPHandler handles all the HTTP requests to the channel participation API.

func NewHTTPHandler

func NewHTTPHandler(config localconfig.ChannelParticipation, registrar ChannelManagement) *HTTPHandler

func (*HTTPHandler) ServeHTTP

func (h *HTTPHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)