Package com.daml.ledger.api.v1.admin

Class PartyManagementServiceGrpc.PartyManagementServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<PartyManagementServiceGrpc.PartyManagementServiceBlockingStub>

com.daml.ledger.api.v1.admin.PartyManagementServiceGrpc.PartyManagementServiceBlockingStub

Enclosing class:

PartyManagementServiceGrpc

public static final class PartyManagementServiceGrpc.PartyManagementServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<PartyManagementServiceGrpc.PartyManagementServiceBlockingStub>

 This service allows inspecting the party management state of the ledger known to the participant
 and managing the participant-local party metadata.
 The authorization rules for its RPCs are specified on the ``<RpcName>Request``
 messages as boolean expressions over these facts:
 (1) ``HasRight(r)`` denoting whether the authenticated user has right ``r`` and
 (2) ``IsAuthenticatedIdentityProviderAdmin(idp)`` denoting whether ``idp`` is equal to the ``identity_provider_id``
 of the authenticated user and the user has an IdentityProviderAdmin right.
 If `identity_provider_id` is set to an empty string, then it's effectively set to the value of access token's 'iss' field if that is provided.
 If `identity_provider_id` remains an empty string, the default identity provider will be assumed.
 The fields of request messages (and sub-messages) are marked either as ``Optional`` or ``Required``:
 (1) ``Optional`` denoting the client may leave the field unset when sending a request.
 (2) ``Required`` denoting the client must set the field to a non-default value when sending a request.
 A party details resource is described by the ``PartyDetails`` message,
 A party details resource, once it has been created, can be modified using the ``UpdatePartyDetails`` RPC.
 The only fields that can be modified are those marked as ``Modifiable``.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
PartyManagementServiceOuterClass.AllocatePartyResponse	allocateParty(PartyManagementServiceOuterClass.AllocatePartyRequest request)	Allocates a new party on a ledger and adds it to the set managed by the participant.
protected PartyManagementServiceGrpc.PartyManagementServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
PartyManagementServiceOuterClass.GetParticipantIdResponse	getParticipantId(PartyManagementServiceOuterClass.GetParticipantIdRequest request)	Return the identifier of the participant.
PartyManagementServiceOuterClass.GetPartiesResponse	getParties(PartyManagementServiceOuterClass.GetPartiesRequest request)	Get the party details of the given parties.
PartyManagementServiceOuterClass.ListKnownPartiesResponse	listKnownParties(PartyManagementServiceOuterClass.ListKnownPartiesRequest request)	List the parties known by the participant.
PartyManagementServiceOuterClass.UpdatePartyDetailsResponse	updatePartyDetails(PartyManagementServiceOuterClass.UpdatePartyDetailsRequest request)	Update selected modifiable participant-local attributes of a party details resource.
PartyManagementServiceOuterClass.UpdatePartyIdentityProviderResponse	updatePartyIdentityProviderId(PartyManagementServiceOuterClass.UpdatePartyIdentityProviderRequest request)	Update the assignment of a party from one IDP to another.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected PartyManagementServiceGrpc.PartyManagementServiceBlockingStub build(io.grpc.Channel channel,
                                                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<PartyManagementServiceGrpc.PartyManagementServiceBlockingStub>

getParticipantId

public PartyManagementServiceOuterClass.GetParticipantIdResponse getParticipantId(PartyManagementServiceOuterClass.GetParticipantIdRequest request)

 Return the identifier of the participant.
 All horizontally scaled replicas should return the same id.
 daml-on-kv-ledger: returns an identifier supplied on command line at launch time
 canton: returns globally unique identifier of the participant
 

getParties

public PartyManagementServiceOuterClass.GetPartiesResponse getParties(PartyManagementServiceOuterClass.GetPartiesRequest request)

 Get the party details of the given parties. Only known parties will be
 returned in the list.
 

listKnownParties

public PartyManagementServiceOuterClass.ListKnownPartiesResponse listKnownParties(PartyManagementServiceOuterClass.ListKnownPartiesRequest request)

 List the parties known by the participant.
 The list returned contains parties whose ledger access is facilitated by
 the participant and the ones maintained elsewhere.
 

allocateParty

public PartyManagementServiceOuterClass.AllocatePartyResponse allocateParty(PartyManagementServiceOuterClass.AllocatePartyRequest request)

 Allocates a new party on a ledger and adds it to the set managed by the participant.
 Caller specifies a party identifier suggestion, the actual identifier
 allocated might be different and is implementation specific.
 Caller can specify party metadata that is stored locally on the participant.
 This call may:
 - Succeed, in which case the actual allocated identifier is visible in
   the response.
 - Respond with a gRPC error
 daml-on-kv-ledger: suggestion's uniqueness is checked by the validators in
 the consensus layer and call rejected if the identifier is already present.
 canton: completely different globally unique identifier is allocated.
 Behind the scenes calls to an internal protocol are made. As that protocol
 is richer than the surface protocol, the arguments take implicit values
 The party identifier suggestion must be a valid party name. Party names are required to be non-empty US-ASCII strings built from letters, digits, space,
 colon, minus and underscore limited to 255 chars
 

updatePartyDetails

public PartyManagementServiceOuterClass.UpdatePartyDetailsResponse updatePartyDetails(PartyManagementServiceOuterClass.UpdatePartyDetailsRequest request)

 Update selected modifiable participant-local attributes of a party details resource.
 Can update the participant's local information for local parties.
 

updatePartyIdentityProviderId

public PartyManagementServiceOuterClass.UpdatePartyIdentityProviderResponse updatePartyIdentityProviderId(PartyManagementServiceOuterClass.UpdatePartyIdentityProviderRequest request)

 Update the assignment of a party from one IDP to another.