com.daml.ledger.api.v1.admin

Class PartyManagementServiceGrpc.PartyManagementServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<PartyManagementServiceGrpc.PartyManagementServiceFutureStub>

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

Enclosing class:

PartyManagementServiceGrpc

public static final class PartyManagementServiceGrpc.PartyManagementServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<PartyManagementServiceGrpc.PartyManagementServiceFutureStub>

 Status: experimental interface, will change before it is deemed production
 ready
 Inspect the party management state of a ledger participant and modify the
 parts that are modifiable. We use 'backing participant' to refer to this
 specific participant in the methods of this API.
 

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 and Description
com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.AllocatePartyResponse>	allocateParty(PartyManagementServiceOuterClass.AllocatePartyRequest request) Adds a new party to the set managed by the backing participant.
protected PartyManagementServiceGrpc.PartyManagementServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.GetParticipantIdResponse>	getParticipantId(PartyManagementServiceOuterClass.GetParticipantIdRequest request) Return the identifier of the backing participant.
com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.GetPartiesResponse>	getParties(PartyManagementServiceOuterClass.GetPartiesRequest request) Get the party details of the given parties.
com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.ListKnownPartiesResponse>	listKnownParties(PartyManagementServiceOuterClass.ListKnownPartiesRequest request) List the parties known by the backing participant.

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.PartyManagementServiceFutureStub build(io.grpc.Channel channel,
                                                                            io.grpc.CallOptions callOptions)

Specified by:

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

getParticipantId

public com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.GetParticipantIdResponse> getParticipantId(PartyManagementServiceOuterClass.GetParticipantIdRequest request)

 Return the identifier of the backing participant.
 All horizontally scaled replicas should return the same id.
 daml-on-sql: returns an identifier supplied on command line at launch time
 daml-on-kv-ledger: as above
 canton: returns globally unique identifier of the backing participant
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 

getParties

public com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.GetPartiesResponse> getParties(PartyManagementServiceOuterClass.GetPartiesRequest request)

 Get the party details of the given parties. Only known parties will be
 returned in the list.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 

listKnownParties

public com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.ListKnownPartiesResponse> listKnownParties(PartyManagementServiceOuterClass.ListKnownPartiesRequest request)

 List the parties known by the backing participant.
 The list returned contains parties whose ledger access is facilitated by
 backing participant and the ones maintained elsewhere.
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 

allocateParty

public com.google.common.util.concurrent.ListenableFuture<PartyManagementServiceOuterClass.AllocatePartyResponse> allocateParty(PartyManagementServiceOuterClass.AllocatePartyRequest request)

 Adds a new party to the set managed by the backing participant.
 Caller specifies a party identifier suggestion, the actual identifier
 allocated might be different and is implementation specific.
 This call may:
 - Succeed, in which case the actual allocated identifier is visible in
   the response.
 - Respond with a gRPC error
 Errors:
 - ``UNAUTHENTICATED``: if the request does not include a valid access token
 - ``PERMISSION_DENIED``: if the claims in the token are insufficient to perform a given operation
 - ``UNIMPLEMENTED``: if synchronous party allocation is not supported by the backing participant
 - ``INVALID_ARGUMENT``: if the provided hint and/or display name is invalid on the given ledger (see below).
 daml-on-sql: suggestion's uniqueness is checked and call rejected if the identifier is already present
 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