corda / net.corda.core.node.services

## Package net.corda.core.node.services

### Types

AttachmentStorage | `interface AttachmentStorage` An attachment store records potentially large binary objects, identified by their hash.
AttachmentsStorageService | `interface AttachmentsStorageService`
FileUploader | `interface FileUploader` An interface that denotes a service that can accept file uploads.
IdentityService | `interface IdentityService` An identity service maintains an bidirectional map of Partys to their associated public keys and thus supports lookup of a party given its key. This is obviously very incomplete and does not reflect everything a real identity service would provide.
KeyManagementService | `interface KeyManagementService` The KMS is responsible for storing and using private keys to sign things. An implementation of this may, for example, call out to a hardware security module that enforces various auditing and frequency-of-use requirements.
NetworkMapCache | `interface NetworkMapCache` A network map contains lists of nodes on the network along with information about their identity keys, services they provide and host names or IP addresses where they can be connected to. The cache wraps around a map fetched from an authoritative service, and adds easy lookup of the data stored within it. Generally it would be initialised with a specified network map service, which it fetches data from and then subscribes to updates of.
PartyInfo | `sealed class PartyInfo` Holds information about a Party, which may refer to either a specific node or a service.
ReadOnlyTransactionStorage | `interface ReadOnlyTransactionStorage` Thread-safe storage of transactions.
SchedulerService | `interface SchedulerService` Provides access to schedule activity at some point in time. This interface might well be expanded to increase the feature set in the future.
ServiceInfo | `data class ServiceInfo` A container for additional information for an advertised service.
ServiceType | `sealed class ServiceType` Identifier for service types a node can expose over the network to other peers. These types are placed into network map advertisements. Services that are purely local and are not providing functionality to other parts of the network don't need a declared service type.
StateMachineRecordedTransactionMappingStorage | `interface StateMachineRecordedTransactionMappingStorage` This is the interface to storage storing state machine -> recorded tx mappings. Any time a transaction is recorded during a flow run addMapping should be called.
StateMachineTransactionMapping | `data class StateMachineTransactionMapping`
StorageService | `interface StorageService : AttachmentsStorageService` A sketch of an interface to a simple key/value storage system. Intended for persistence of simple blobs like transactions, serialised flow state machines and so on. Again, this isn't intended to imply lack of SQL or anything like that, this interface is only big enough to support the prototyping work.
TimestampChecker | `class TimestampChecker` Checks if the given timestamp falls within the allowed tolerance interval.
TransactionStorage | `interface TransactionStorage : ReadOnlyTransactionStorage` Thread-safe storage of transactions.
TxWritableStorageService | `interface TxWritableStorageService : StorageService` Storage service, with extensions to allow validated transactions to be added to. For use only within ServiceHub.
UniquenessProvider | `interface UniquenessProvider` A service that records input states of the given transaction and provides conflict information if any of the inputs have already been used in another transaction.
Vault | `class Vault<out T : ContractState>` A vault (name may be temporary) wraps a set of states that are useful for us to keep track of, for instance, because we own them. This class represents an immutable, stable state of a vault: it is guaranteed not to change out from underneath you, even though the canonical currently-best-known vault may change as we learn about new transactions from our peers and generate new transactions that consume states ourselves.
VaultService | `interface VaultService` A VaultService is responsible for securely and safely persisting the current state of a vault to storage. The vault service vends immutable snapshots of the current vault for working with: if you build a transaction based on a vault that isn't current, be aware that it may end up being invalid if the states that were used have been consumed by someone else first!

### Exceptions

NetworkCacheError | `sealed class NetworkCacheError : Exception`
UniquenessException | `class UniquenessException : Exception`

### Extensions for External Classes

kotlin.collections.Iterable |

### Properties

DEFAULT_SESSION_ID | `val DEFAULT_SESSION_ID: Long` Session ID to use for services listening for the first message in a session (before a specific session ID has been established).

### Functions

consumedStates | `fun <T : ContractState> VaultService.consumedStates(): List<StateAndRef<T>>`
dealsWith | `fun <T : DealState> VaultService.dealsWith(party: AbstractParty): List<StateAndRef<T>>`
linearHeadsOfType | `fun <T : LinearState> VaultService.linearHeadsOfType(): Map<UniqueIdentifier, StateAndRef<T>>` Returns the linearState heads only when the type of the state would be considered an 'instanceof' the given type.
unconsumedStates | `fun <T : ContractState> VaultService.unconsumedStates(): List<StateAndRef<T>>`