Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addUsedInput(InputValue) - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Adds an input value used to compute this rating.
- AlternateIdentifier - Class in energy.trolie.client.model.common
-
Alternate identifier for a given power system resource
- AlternateIdentifier() - Constructor for class energy.trolie.client.model.common.AlternateIdentifier
- AMPS - Enum constant in enum class energy.trolie.client.model.common.RatingUnits
-
Current in amperes
B
- begin(ForecastProposalHeader) - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Begin the stream, sending a populated header
- begin(ProposalHeader) - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
-
Begin the stream, sending a populated header
- beginResource(String) - Method in interface energy.trolie.client.request.operatingsnapshots.ForecastSnapshotReceiver
-
Invoked to indicate that a new resource has been found while parsing.
- beginResource(String) - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Begin writing a new group of ratings for a particular resource.
- beginSnapshot() - Method in interface energy.trolie.client.request.operatingsnapshots.ForecastSnapshotReceiver
-
Invoked when a new snapshot is received.
- beginSnapshot() - Method in interface energy.trolie.client.request.operatingsnapshots.RealTimeSnapshotReceiver
-
Invoked when a new snapshot is received.
- bufferSize(int) - Method in class energy.trolie.client.TrolieClientBuilder
-
Override the buffer size used in Java BufferedInputStreams and BufferedOutputStreams to optimize performance.
- build() - Method in class energy.trolie.client.TrolieClientBuilder
-
Construct a new client
- builder(String, CloseableHttpClient) - Static method in interface energy.trolie.client.TrolieClient
-
Initializes a new builder.
C
- close() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Close underlying resources
- close() - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
- complete() - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Completes adding the rating to the proposal update.
- complete() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Finalize the request.
- complete() - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
-
Finalize the request.
- complete() - Method in interface energy.trolie.client.StreamingUpdate
-
Complete the update
- CONTENT_TYPE_FORECAST_PROPOSAL - Static variable in class energy.trolie.client.TrolieApiConstants
-
Content type for forecast proposals
- CONTENT_TYPE_FORECAST_SNAPSHOT - Static variable in class energy.trolie.client.TrolieApiConstants
-
Content type for forecast limit snapshots
- CONTENT_TYPE_MONITORING_SET - Static variable in class energy.trolie.client.TrolieApiConstants
-
Content type for monitoring sets.
- CONTENT_TYPE_REALTIME_PROPOSAL - Static variable in class energy.trolie.client.TrolieApiConstants
-
Content type for real-time proposal status.
- CONTENT_TYPE_REALTIME_SNAPSHOT - Static variable in class energy.trolie.client.TrolieApiConstants
-
Content type for real-time limit snapshots
- createForecastRatingProposalStreamingUpdate() - Method in interface energy.trolie.client.TrolieClient
-
Create a forecast proposal update that can stream the update submission to the server
- createRealTimeRatingProposalStreamingUpdate() - Method in interface energy.trolie.client.TrolieClient
-
Create a real-time proposal update that can stream the update submission to the server
D
- DataProvenance - Class in energy.trolie.client.model.common
-
Provenance for a particular data set
- DataProvenance() - Constructor for class energy.trolie.client.model.common.DataProvenance
- DEFAULT_BUFFER_SIZE - Static variable in class energy.trolie.client.TrolieClientBuilder
-
Default buffer size for BufferedInputStreams and BufferedOutputStreams.
E
- EmergencyRatingDuration - Class in energy.trolie.client.model.common
-
Named duration of emergency ratings.
- EmergencyRatingDuration() - Constructor for class energy.trolie.client.model.common.EmergencyRatingDuration
- EmergencyRatingValue - Class in energy.trolie.client.model.common
-
Emergency limit value for a given duration.
- EmergencyRatingValue() - Constructor for class energy.trolie.client.model.common.EmergencyRatingValue
- endResource() - Method in interface energy.trolie.client.request.operatingsnapshots.ForecastSnapshotReceiver
-
Invoked when the end of a set of ratings for the current resource has been encountered.
- endResource() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Finish the resource set started with
ForecastRatingProposalUpdate.beginResource(String)
. - endSnapshot() - Method in interface energy.trolie.client.request.operatingsnapshots.ForecastSnapshotReceiver
-
Invoked when the snapshot has reached its end.
- endSnapshot() - Method in interface energy.trolie.client.request.operatingsnapshots.RealTimeSnapshotReceiver
-
Invoked when the snapshot has reached its end.
- energy.trolie.client - package energy.trolie.client
-
Entry point to the TROLIE client APIs.
- energy.trolie.client.exception - package energy.trolie.client.exception
-
Exceptions thrown by the TROLIE SDK
- energy.trolie.client.model - package energy.trolie.client.model
-
JSON model POJOs, following the TROLIE schema specification.
- energy.trolie.client.model.common - package energy.trolie.client.model.common
-
Common data structures across the TROLIE Specification
- energy.trolie.client.model.monitoringsets - package energy.trolie.client.model.monitoringsets
-
Monitoring sets data structures
- energy.trolie.client.model.operatingsnapshots - package energy.trolie.client.model.operatingsnapshots
-
Data structures for fetched rating snapshots from TROLIE
- energy.trolie.client.model.ratingproposals - package energy.trolie.client.model.ratingproposals
-
Data structures for publishing proposed ratings to TROLIE
- energy.trolie.client.request.monitoringsets - package energy.trolie.client.request.monitoringsets
-
Interfaces for monitoring set queries
- energy.trolie.client.request.operatingsnapshots - package energy.trolie.client.request.operatingsnapshots
-
Interfaces for snapshot queries
- energy.trolie.client.request.ratingproposals - package energy.trolie.client.request.ratingproposals
-
Interfaces for proposal publishing
- error(StreamingGetException) - Method in interface energy.trolie.client.StreamingResponseReceiver
-
Called when an error occurs establishing, executing or handling the polling request.
- etagStore(ETagStore) - Method in class energy.trolie.client.TrolieClientBuilder
-
Overrides the ETag Store used to cache the version of data stored by this system.
- ETagStore - Interface in energy.trolie.client
-
Pluggable store for request ETag values.
F
- ForecastPeriodBuilder - Interface in energy.trolie.client.model.ratingproposals
-
Rating value builder for specific forecast periods, emitting
ForecastRatingPeriod
s. - ForecastPeriodSnapshot - Class in energy.trolie.client.model.operatingsnapshots
-
For a given resource, represents a rating value set for a given forecast period.
- ForecastPeriodSnapshot() - Constructor for class energy.trolie.client.model.operatingsnapshots.ForecastPeriodSnapshot
- ForecastProposalHeader - Class in energy.trolie.client.model.ratingproposals
-
ProposalHeader
for forecasts. - ForecastProposalHeader() - Constructor for class energy.trolie.client.model.ratingproposals.ForecastProposalHeader
- ForecastRatingPeriod - Class in energy.trolie.client.model.ratingproposals
-
Forecast rating value set for a given period
- ForecastRatingPeriod() - Constructor for class energy.trolie.client.model.ratingproposals.ForecastRatingPeriod
- ForecastRatingProposalStatus - Class in energy.trolie.client.model.ratingproposals
-
Status of a forecast rating proposal
- ForecastRatingProposalStatus() - Constructor for class energy.trolie.client.model.ratingproposals.ForecastRatingProposalStatus
- ForecastRatingProposalUpdate - Class in energy.trolie.client.request.ratingproposals
-
Streaming update for forecast rating proposals.
- ForecastRatingProposalUpdate(HttpClient, TrolieHost, RequestConfig, int, ObjectMapper, Map<String, String>, int) - Constructor for class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Constructs a new update.
- forecastRatingsPollMs(int) - Method in class energy.trolie.client.TrolieClientBuilder
-
Sets the period at which
TrolieClient.subscribeToInUseLimitForecastUpdates(ForecastSnapshotSubscribedReceiver)
and similar methods for forecast ratings poll for new ratings. - ForecastSnapshotHeader - Class in energy.trolie.client.model.operatingsnapshots
-
SnapshotHeader
for forecast ratings, which includes a window begin period. - ForecastSnapshotHeader() - Constructor for class energy.trolie.client.model.operatingsnapshots.ForecastSnapshotHeader
- ForecastSnapshotReceiver - Interface in energy.trolie.client.request.operatingsnapshots
-
Streaming receiver for updated forecast snapshot data and errors from subscriber.
- ForecastSnapshotSubscribedReceiver - Interface in energy.trolie.client.request.operatingsnapshots
-
Streaming receiver for updated forecast snapshot data and errors from subscriber.
- fromAmps(float) - Static method in class energy.trolie.client.model.common.RatingValue
-
Construct from an amps value
- fromMva(float) - Static method in class energy.trolie.client.model.common.RatingValue
-
Construct from an MVA value
- fromMwAndPf(float, float) - Static method in class energy.trolie.client.model.common.RatingValue
-
Construct from a megawatt and power factor ratio combination
G
- getAMPS() - Method in class energy.trolie.client.model.common.RatingValue
-
Gets the rating in amps
- getContentType() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
- getContentType() - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
- getDefaultMonitoringSet(MonitoringSetsReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Identical to
TrolieClient.getMonitoringSet(MonitoringSetsReceiver, String)
, but simply fetches this grid operator's default monitoring set rather than one specified with a particular name. - getETag(String) - Method in interface energy.trolie.client.ETagStore
-
Get the currently stored eTag for this particular path.
- getInUseLimitForecasts(ForecastSnapshotReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Execute a synchronous request for the current forecast limits with a streaming response handler, assuming this user's default monitoring set.
- getInUseLimitForecasts(ForecastSnapshotReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the current forecast limits with a streaming response handler with the given monitoring set.
- getInUseLimitForecasts(ForecastSnapshotReceiver, String, String, Instant, Instant) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the current forecast limits with a streaming response handler
- getInUseLimitForecasts(ForecastSnapshotReceiver, Instant, Instant) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the current forecast limits with a streaming response handler, given this user's default monitoring set.
- getInUseLimits(RealTimeSnapshotReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the current real-time limits with a streaming response handler
- getInUseLimits(RealTimeSnapshotReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the current real-time limits with a streaming response handler
- getInUseLimits(RealTimeSnapshotReceiver, String, String) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the current real-time limits with a streaming response handler
- getMonitoringSet(MonitoringSetsReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Synchronously fetch the definition of a monitoring set.
- getMVA() - Method in class energy.trolie.client.model.common.RatingValue
-
Gets the rating in MVA
- getMWAndPF() - Method in class energy.trolie.client.model.common.RatingValue
-
Gets the rating in a MW and PF pair
- getPath() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
- getPath() - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
- getRegionalLimitsForecast(ForecastSnapshotReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the current forecast limits with a streaming response handler
- getRegionalLimitsForecast(ForecastSnapshotReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the regionally limiting forecast limits with a streaming response handler
- getRegionalLimitsForecast(ForecastSnapshotReceiver, String, String, Instant, Instant) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the regionally limiting forecast limits with a streaming response handler
- getRegionalLimitsForecast(ForecastSnapshotReceiver, Instant, Instant) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the regionally limiting forecast limits with a streaming response handler
- getRegionalRealTimeLimits(RealTimeSnapshotReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the regional real-time limits with a streaming response handler.
- getRegionalRealTimeLimits(RealTimeSnapshotReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the regional real-time limits with a streaming response handler
- getRegionalRealTimeLimits(RealTimeSnapshotReceiver, String, String) - Method in interface energy.trolie.client.TrolieClient
-
Execute a request for the regional real-time limits with a streaming response handler
- getRequest() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
- getRequest() - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
- getResponseHandler() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
- getResponseHandler() - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
- getUnits() - Method in class energy.trolie.client.model.common.RatingValue
-
Determines the units of this rating value
H
- hasBasePath() - Method in class energy.trolie.client.TrolieHost
-
Returns true if the TROLIE server URL includes a base path
- header(ForecastSnapshotHeader) - Method in interface energy.trolie.client.request.operatingsnapshots.ForecastSnapshotReceiver
-
Invoked when the header has been processed.
- header(RealTimeSnapshotHeader) - Method in interface energy.trolie.client.request.operatingsnapshots.RealTimeSnapshotReceiver
-
Invoked when the header has been processed.
- httpHeaders(Map<String, String>) - Method in class energy.trolie.client.TrolieClientBuilder
-
Allows for additional headers to be passed with every request.
I
- InputValue - Class in energy.trolie.client.model.common
-
Generic input value used to compute ratings, attached to proposals.
- InputValue() - Constructor for class energy.trolie.client.model.common.InputValue
- isActive() - Method in interface energy.trolie.client.RequestSubscription
- isHealthy() - Method in interface energy.trolie.client.RequestSubscription
- isSubscribed() - Method in interface energy.trolie.client.RequestSubscription
L
- limit(RealTimeLimit) - Method in interface energy.trolie.client.request.operatingsnapshots.RealTimeSnapshotReceiver
-
Invoked with each resource limit set as it is parsed
M
- monitoringSet(MonitoringSet) - Method in interface energy.trolie.client.request.monitoringsets.MonitoringSetsReceiver
-
Called when a monitoring set is received successfully
- MonitoringSet - Class in energy.trolie.client.model.monitoringsets
-
Monitoring set definition and its contents.
- MonitoringSet() - Constructor for class energy.trolie.client.model.monitoringsets.MonitoringSet
- monitoringSetPollMs(int) - Method in class energy.trolie.client.TrolieClientBuilder
-
Sets the period at which
TrolieClient.subscribeToDefaultMonitoringSetUpdates(MonitoringSetsSubscribedReceiver)
and similar methods poll for monitoring sets. - MonitoringSetsReceiver - Interface in energy.trolie.client.request.monitoringsets
-
Streaming receiver for updated monitoring set data and errors from subscriber.
- MonitoringSetsSubscribedReceiver - Interface in energy.trolie.client.request.monitoringsets
-
Streaming receiver for getting Monitoring Set.
- MVA - Enum constant in enum class energy.trolie.client.model.common.RatingUnits
-
Apparent power in megavolt-amperes
- MW - Enum constant in enum class energy.trolie.client.model.common.RatingUnits
-
Active power in megawatts.
- MWandPF - Enum constant in enum class energy.trolie.client.model.common.RatingUnits
-
Represents the combination of active power and an assumed power factor.
O
- objectMapper(ObjectMapper) - Method in class energy.trolie.client.TrolieClientBuilder
-
Overrides configuration of the Jackson object mapper using for JSON parsing and serialization
- ofMappedJson(Map<String, Float>) - Static method in class energy.trolie.client.model.common.RatingValue
-
Construct from raw Json
P
- PARAM_MONITORING_SET - Static variable in class energy.trolie.client.TrolieApiConstants
-
Common query parameter name for monitoring set filter.
- PARAM_OFFSET_PERIOD_START - Static variable in class energy.trolie.client.TrolieApiConstants
-
Common query parameter name for period offset.
- PARAM_PERIOD_END - Static variable in class energy.trolie.client.TrolieApiConstants
-
Common query parameter name for the period end.
- PARAM_RESOURCE_ID - Static variable in class energy.trolie.client.TrolieApiConstants
-
Common query parameter name for a resource filter.
- PATH_DEFAULT_MONITORING_SET - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to getDefaultMonitoringSet
- PATH_FORECAST_PROPOSAL - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to patchRatingForecastProposal
- PATH_FORECAST_SNAPSHOT - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to getLimitsForecastSnapshot
- PATH_MONITORING_SET_ID - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to getMonitoringSet
- PATH_REALTIME_PROPOSAL - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to postRealTimeProposal
- PATH_REALTIME_SNAPSHOT - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to getRealTimeLimits
- PATH_REGIONAL_FORECAST_SNAPSHOT - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to getRegionalForecastSnapshot
- PATH_REGIONAL_REALTIME_SNAPSHOT - Static variable in class energy.trolie.client.TrolieApiConstants
-
Path to getRegionalRealTimeLimits
- period(ForecastPeriodSnapshot) - Method in interface energy.trolie.client.request.operatingsnapshots.ForecastSnapshotReceiver
-
Invoked as a new rating value set is encountered in the stream
- period(ForecastRatingPeriod) - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Write out a rating set, using the JSON format in a relatively raw way.
- periodBuilder() - Method in class energy.trolie.client.request.ratingproposals.ForecastRatingProposalUpdate
-
Fluent way of constructing valid forecast periods.
- periodLength(int) - Method in class energy.trolie.client.TrolieClientBuilder
-
Sets the period length assumed for forecast ratings.
- PF - Enum constant in enum class energy.trolie.client.model.common.RatingUnits
-
Ratio of active to apparent power.
- PowerSystemResource - Class in energy.trolie.client.model.common
-
Description of a power system resource, along with its list of alternate identifiers.
- PowerSystemResource() - Constructor for class energy.trolie.client.model.common.PowerSystemResource
- ProposalHeader - Class in energy.trolie.client.model.ratingproposals
-
Header information for rating proposals submitted to TROLIE.
- ProposalHeader() - Constructor for class energy.trolie.client.model.ratingproposals.ProposalHeader
- ProposalValidationError - Class in energy.trolie.client.model.ratingproposals
-
Validation error for proposal data for a particular power system resource
- ProposalValidationError() - Constructor for class energy.trolie.client.model.ratingproposals.ProposalValidationError
- putETag(String, String) - Method in interface energy.trolie.client.ETagStore
-
Store a new value at this particular path.
R
- rating(RealTimeRating) - Method in class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
-
Send a rating value set for a given resource.
- RatingBuilder - Interface in energy.trolie.client.model.ratingproposals
-
A rating value builder that respects business rules and conventions configured with the client.
- RatingUnits - Enum Class in energy.trolie.client.model.common
-
Enumeration of common units supported in TROLIE
- RatingValue - Class in energy.trolie.client.model.common
-
Representation of a rating value, given the various units that are possible under the TROLIE specification.
- RealTimeLimit - Class in energy.trolie.client.model.operatingsnapshots
-
Real-time limit value set for a given resource.
- RealTimeLimit() - Constructor for class energy.trolie.client.model.operatingsnapshots.RealTimeLimit
- RealTimeRating - Class in energy.trolie.client.model.ratingproposals
-
Real-time rating value set for a given resource
- RealTimeRating() - Constructor for class energy.trolie.client.model.ratingproposals.RealTimeRating
- RealTimeRatingProposal - Class in energy.trolie.client.model.ratingproposals
-
Batch real-time proposal.
- RealTimeRatingProposal() - Constructor for class energy.trolie.client.model.ratingproposals.RealTimeRatingProposal
- RealTimeRatingProposalStatus - Class in energy.trolie.client.model.ratingproposals
-
Status of a real-time proposal
- RealTimeRatingProposalStatus() - Constructor for class energy.trolie.client.model.ratingproposals.RealTimeRatingProposalStatus
- RealTimeRatingProposalUpdate - Class in energy.trolie.client.request.ratingproposals
-
Streaming update for real-time rating proposals.
- RealTimeRatingProposalUpdate(HttpClient, TrolieHost, RequestConfig, int, ObjectMapper, Map<String, String>) - Constructor for class energy.trolie.client.request.ratingproposals.RealTimeRatingProposalUpdate
-
Constructs new update.
- realTimeRatingsPollMs(int) - Method in class energy.trolie.client.TrolieClientBuilder
-
Sets the period at which
TrolieClient.subscribeToInUseLimits(RealTimeSnapshotSubscribedReceiver)
and similar methods poll for new real-time ratings. - RealTimeSnapshotHeader - Class in energy.trolie.client.model.operatingsnapshots
-
SnapshotHeader
for real-time rating snapshots - RealTimeSnapshotHeader() - Constructor for class energy.trolie.client.model.operatingsnapshots.RealTimeSnapshotHeader
- RealTimeSnapshotReceiver - Interface in energy.trolie.client.request.operatingsnapshots
-
Streaming receiver for real-time snapshot response data The current request handling can be terminated in any of these methods by throwing an exception.
- RealTimeSnapshotSubscribedReceiver - Interface in energy.trolie.client.request.operatingsnapshots
-
Streaming receiver for updated real-time snapshot data and errors from subscriber.
- requestConfig(RequestConfig) - Method in class energy.trolie.client.TrolieClientBuilder
-
Override the HTTP client request config
- RequestSubscription - Interface in energy.trolie.client
-
Handle for an active request subscription that is passed to the subscription receiver, allowing it to control the subscription state
S
- setContinuousAmps(float) - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Sets the continuous rating in Amps
- setContinuousMVA(float) - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Sets the continuous rating in MVA
- setContinuousMWandPF(float, float) - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Sets the continuous rating in a MW and Power Factor combination
- setEmergencyAmps(String, float) - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Sets the rating value in Amps for a particular emergency duration.
- setEmergencyMVA(String, float) - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Sets the rating value in MVA for a particular emergency duration.
- setEmergencyMWandPF(String, float, float) - Method in interface energy.trolie.client.model.ratingproposals.RatingBuilder
-
Sets the rating value using a MW value and assumed power factor for a given emergency duration.
- setPeriod(int) - Method in interface energy.trolie.client.model.ratingproposals.ForecastPeriodBuilder
-
Convenience method to set the period as an offset from the forecast window begin.
- setPeriodEnd(Instant) - Method in interface energy.trolie.client.model.ratingproposals.ForecastPeriodBuilder
-
Sets an absolute period end.
- setPeriodStart(Instant) - Method in interface energy.trolie.client.model.ratingproposals.ForecastPeriodBuilder
-
Sets an absolute period start.
- setSubscription(RequestSubscription) - Method in interface energy.trolie.client.StreamingSubscribedResponseReceiver
-
Called after subscription is initialized, allowing receiver to unsubscribe on errors that are deemed fatal
- SnapshotHeader - Class in energy.trolie.client.model.operatingsnapshots
-
Header information for rating snapshots downloaded from TROLIE.
- SnapshotHeader() - Constructor for class energy.trolie.client.model.operatingsnapshots.SnapshotHeader
- StreamingGetConnectionException - Exception in energy.trolie.client.exception
-
Exception indicating connection or request initialization error, or an I/O error while reading response bytes
- StreamingGetConnectionException(Throwable) - Constructor for exception energy.trolie.client.exception.StreamingGetConnectionException
- StreamingGetException - Exception in energy.trolie.client.exception
-
Common base for exceptions received in
StreamingResponseReceiver.error(StreamingGetException)
- StreamingGetException(String) - Constructor for exception energy.trolie.client.exception.StreamingGetException
- StreamingGetException(String, Throwable) - Constructor for exception energy.trolie.client.exception.StreamingGetException
- StreamingGetException(Throwable) - Constructor for exception energy.trolie.client.exception.StreamingGetException
- StreamingGetHandlingException - Exception in energy.trolie.client.exception
-
Exception indicating an issue with interpreting the response bytes
- StreamingGetHandlingException(String) - Constructor for exception energy.trolie.client.exception.StreamingGetHandlingException
- StreamingGetHandlingException(String, Throwable) - Constructor for exception energy.trolie.client.exception.StreamingGetHandlingException
- StreamingGetHandlingException(Throwable) - Constructor for exception energy.trolie.client.exception.StreamingGetHandlingException
- StreamingGetResponseException - Exception in energy.trolie.client.exception
-
Exception indicating a server response with an abnormal HTTP status code
- StreamingGetResponseException(String, int) - Constructor for exception energy.trolie.client.exception.StreamingGetResponseException
- StreamingGetResponseException(Throwable) - Constructor for exception energy.trolie.client.exception.StreamingGetResponseException
-
Creates with an invalid HTTP code
- StreamingResponseReceiver - Interface in energy.trolie.client
-
Base interface for receiver of streaming GET response data
- StreamingSubscribedResponseReceiver - Interface in energy.trolie.client
-
Base interface for receiver to be invoked when new data is available for a subscribed pollable GET
- StreamingUpdate<T> - Interface in energy.trolie.client
-
Base type for streaming updates.
- SubscriberInternalException - Exception in energy.trolie.client.exception
-
Wrapper for unexpected errors on data subscription.
- SubscriberInternalException(Throwable) - Constructor for exception energy.trolie.client.exception.SubscriberInternalException
- subscribeToDefaultMonitoringSetUpdates(MonitoringSetsSubscribedReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Identical to
TrolieClient.subscribeToMonitoringSetUpdates(MonitoringSetsSubscribedReceiver, String)
, but creates a polling subscription for this grid operator's default monitoring set rather than one specified with a particular name. - subscribeToInUseLimitForecastUpdates(ForecastSnapshotSubscribedReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for forecast snapshot data updates
- subscribeToInUseLimitForecastUpdates(ForecastSnapshotSubscribedReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for forecast snapshot data updates
- subscribeToInUseLimits(RealTimeSnapshotSubscribedReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for real-time snapshot data updates
- subscribeToInUseLimits(RealTimeSnapshotSubscribedReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for real-time snapshot data updates
- subscribeToInUseLimits(RealTimeSnapshotSubscribedReceiver, String, String) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for real-time snapshot data updates
- subscribeToMonitoringSetUpdates(MonitoringSetsSubscribedReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for updates to the given monitoring set.
- subscribeToRegionalLimitsForecast(ForecastSnapshotSubscribedReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for regionally limiting forecast snapshot data updates
- subscribeToRegionalLimitsForecast(ForecastSnapshotSubscribedReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for regionally limiting forecast snapshot data updates
- subscribeToRegionalRealTimeLimits(RealTimeSnapshotSubscribedReceiver) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription regional real-time snapshot data updates
- subscribeToRegionalRealTimeLimits(RealTimeSnapshotSubscribedReceiver, String) - Method in interface energy.trolie.client.TrolieClient
-
Create a polling subscription for regional real-time snapshot data updates
T
- TrolieApiConstants - Class in energy.trolie.client
-
Series of static constants against the TROLIE OpenAPI specification
- TrolieClient - Interface in energy.trolie.client
-
Primary TROLIE client access interface.
- TrolieClientBuilder - Class in energy.trolie.client
-
Builder class used to construct new instances of the TROLIE client.
- TrolieClientBuilder(String) - Constructor for class energy.trolie.client.TrolieClientBuilder
-
Initializes a new builder with a preconfigured apache HTTP client
- TrolieClientBuilder(String, CloseableHttpClient) - Constructor for class energy.trolie.client.TrolieClientBuilder
-
Initializes a new builder.
- TrolieException - Exception in energy.trolie.client.exception
-
Common base for any exceptions thrown by
TrolieClient
to API users. - TrolieException(String) - Constructor for exception energy.trolie.client.exception.TrolieException
- TrolieException(String, Throwable) - Constructor for exception energy.trolie.client.exception.TrolieException
- TrolieException(Throwable) - Constructor for exception energy.trolie.client.exception.TrolieException
- TrolieHost - Class in energy.trolie.client
-
Holds all details needed to describe an HTTP connection to a TROLIE host.
- TrolieHost(String) - Constructor for class energy.trolie.client.TrolieHost
-
Create a TrolieHost from the base URL of the TROLIE server.
- TrolieServerException - Exception in energy.trolie.client.exception
-
Exception that indicates a failure on the side of the TROLIE endpoint.
- TrolieServerException(int, String, Throwable) - Constructor for exception energy.trolie.client.exception.TrolieServerException
U
- unsubscribe(RequestSubscription) - Method in interface energy.trolie.client.TrolieClient
-
Un-subscribe an active polling request
- unsubscribeAll() - Method in interface energy.trolie.client.TrolieClient
-
Un-subscribe all active polling requests
V
- valueOf(String) - Static method in enum class energy.trolie.client.model.common.RatingUnits
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class energy.trolie.client.model.common.RatingUnits
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form