A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractEthosChangeNotificationListSubscriber - Class in com.ellucian.ethos.integration.notification
-
Abstract class which provides "hooks" into the Ethos SDK for ChangeNotification list subscribers.
- AbstractEthosChangeNotificationListSubscriber() - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
Enables subclasses to construct this class without specifying the number of notifications to retrieve from Ethos Integration at a single time.
- AbstractEthosChangeNotificationListSubscriber(Integer) - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
Enables subclasses to construct this class with the specified number of notifications to retrieve from Ethos Integration at a single time (per polling request).
- AbstractEthosChangeNotificationSubscriber - Class in com.ellucian.ethos.integration.notification
-
Abstract class which provides "hooks" into the Ethos SDK for ChangeNotification subscribers.
- AbstractEthosChangeNotificationSubscriber() - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
Enables subclasses to construct this class without specifying the number of notifications to retrieve from Ethos Integration at a single time.
- AbstractEthosChangeNotificationSubscriber(Integer) - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
Enables subclasses to construct this class with the specified number of notifications to retrieve from Ethos Integration at a single time (per polling request).
- AbstractEthosChangeNotificationSubscription - Class in com.ellucian.ethos.integration.notification
-
Abstract class containing the processing logic common for both ChangeNotification and ChangeNotification list processing.
- AbstractEthosChangeNotificationSubscription(Flow.Publisher, Flow.Subscriber, EthosChangeNotificationService, long, TimeUnit) - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
Constructs this subscription with the given params.
- AbstractEthosNotificationPollService - Class in com.ellucian.ethos.integration.notification
-
Abstract class containing a mapping of subscribers to subscriptions, and the polling interval in seconds to wait between poll attempts.
- AbstractEthosNotificationPollService() - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
No-arg constructor setting the pollingIntervalSeconds to DEFAULT_POLL_INTERVAL_SECONDS.
- AbstractEthosNotificationPollService(long) - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
Constructs an instance of this class with the given params.
- AbstractEthosNotificationSubscriber - Class in com.ellucian.ethos.integration.notification
-
Abstract class containing common processing logic for subscribing to and cancelling subscriptions.
- AbstractEthosNotificationSubscriber() - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
Enables subclasses to construct this class without specifying the number of notifications to retrieve from Ethos Integration at a single time.
- AbstractEthosNotificationSubscriber(Integer) - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
Enables subclasses to construct this class with the specified number of notifications to retrieve from Ethos Integration at a single time (per polling request).
- AbstractEthosNotificationSubscription - Class in com.ellucian.ethos.integration.notification
-
An abstract super class for Ethos subscriptions containing the publisher, subscriber, and the threading capabilities used by subscription subclasses to run those subscription processes.
- AbstractEthosNotificationSubscription(Flow.Publisher, Flow.Subscriber, long, TimeUnit) - Constructor for class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
Super constructor which must be called by subclasses supplying the given params.
- AccessToken - Class in com.ellucian.ethos.integration.authentication
-
An access token that can be used for authentication to make calls to Ethos Integration.
- AccessToken(String, LocalDateTime) - Constructor for class com.ellucian.ethos.integration.authentication.AccessToken
-
Creates an instance of an access token that expires at the given time.
- addMultiCriteriaObject(MultiCriteriaObject) - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Adds the given multiCriteriaObject to this array.
- addMultiCriteriaObject(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Adds a MultiCriteriaObject to this array using the given criteriaKey and criteriaValue.
- addMultiCriteriaObject(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Adds a MultiCriteriaObject to this array using the given label, criteriaKey and criteriaValue.
- addNamedQueryObject(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryCombination
-
Adds a NamedQueryObject to this NamedQueryCombination using the given params.
- addNumericSimpleCriteria(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Convenience method to add the given label and value as a numeric value to this object.
- addResourceAbbreviatedVersionOverride(String, String) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Same as
EthosChangeNotificationService.addResourceVersionOverride(String, String)
except the version can be abbreviated as just the version value, e.g: 16, or 16.0.0. - addResourceVersionOverride(String, String) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Enables client application code to add resource version overrides after this service has been built.
- addSimpleCriteria(SimpleCriteria) - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaSet
-
Intended to be used internally by the SDK.
- addSimpleCriteria(SimpleCriteria) - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Adds a SimpleCriteria to this object.
- addSimpleCriteria(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Convenience method to add a SimpleCriteria to this object.
- addSimpleCriteriaObject(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaArray
-
Adds a SimpleCriteriaObject to this array using the given label, criteriaKey, and criteriaValue.
- addSimpleCriteriaObject(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObjectArray
-
Adds a SimpleCriteriaObject to this array from the given params.
- addToNamedQueryObjectArray(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObjectArrayCombination
-
Adds the values as a SimpleCriteriaObject to a list used within this class to generate the JSON structure as an array of NamedQueryObjects.
- addValue(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaValueArray
-
Adds a value to this array.
- apiFilter(SupportedRegions, String, String) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds a URL for interacting with the proxy APIs through Ethos Integration supporting filters.
- apiFilterPaging(SupportedRegions, String, String, int, int) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging with filters.
- apiPaging(SupportedRegions, String, int, int) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds a URL for interacting with the Proxy APIs through Ethos Integration, in support of paging.
- apis(SupportedRegions, String, String) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds a URL for interacting with the Proxy APIs through Ethos Integration.
- appConfig(SupportedRegions) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds an Ethos Integration URL supporting the Application Configuration API.
- arrayLabel - Variable in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObjectArrayCombination
-
The JSON label for the array of NamedQueryObjects
- AUSTRALIA - com.ellucian.ethos.integration.authentication.SupportedRegions
- auth(SupportedRegions) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds an Ethos Integration URL supporting the Token API.
- availableResources(SupportedRegions) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds an Ethos Integration URL supporting the Available Resources API.
B
- build() - Method in class com.ellucian.ethos.integration.client.config.SemVer.Builder
-
Builds a SemVer object with the given major, minor, and patch values that have been set in the builder.
- build() - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter.Builder
-
Builds an instance of this CriteriaFilter class, setting the criteriaSetList from this Builder in the CriteriaFilter.
- build() - Method in class com.ellucian.ethos.integration.client.proxy.filter.FilterMap.Builder
-
Builds a FilterMap instance with the parameter pairs previously provided.
- build() - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Builds the Pager object with whatever attributes are specified from the various methods above.
- build() - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Builds an instance of the EthosChangeNotificationService with the given ethosClientBuilder and any resource version overrides.
- buildCriteriaFilter() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Builds a CriteriaFilter using this SimpleCriteria instance.
- Builder() - Constructor for class com.ellucian.ethos.integration.client.config.SemVer.Builder
-
No-arg constructor for the Builder.
- Builder() - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter.Builder
-
No-arg constructor for easy access to this Builder class.
- Builder() - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.FilterMap.Builder
-
No-arg constructor for the Builder
- Builder() - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
No-arg constructor for easy access in instantiating this class.
- Builder(EthosClientBuilder) - Constructor for class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Instantiates this builder with the given
EthosClientBuilder
. - Builder(String) - Constructor for class com.ellucian.ethos.integration.client.config.SemVer.Builder
-
A Builder constructor that takes a version string which should have a value in SemVer notation, e.g.
- Builder(String) - Constructor for class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the given resourceName to the resourceName of this Builder.
- Builder(String) - Constructor for class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Instantiates this builder with the given apiKey.
- buildEthosConfigurationClient() - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Builds an
EthosConfigurationClient
that will use the given API key to authenticate, and the specified timeout values to connect with. - buildEthosErrorsClient() - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Builds an
EthosErrorsClient
that will use the given API key to authenticate, and the specified timeout values to connect with. - buildEthosFilterQueryClient() - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Builds an
EthosFilterQueryClient
that will use the given API key to authenticate, and the specified timeout values to connect with. - buildEthosMessagesClient() - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Builds an
EthosMessagesClient
that will use the given API key to authenticate, and the specified timeout values to connect with. - buildEthosProxyAsyncClient() - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Builds an
EthosProxyClientAsync
that will use the given API key to authenticate, and the specified timeout values to connect with. - buildEthosProxyClient() - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Builds an
EthosProxyClient
that will use the given API key to authenticate, and the specified timeout values to connect with. - buildEthosResponse(HttpResponse) - Method in class com.ellucian.ethos.integration.client.EthosResponseBuilder
-
Builds an
EthosResponse
object from the givenorg.apache.http.HttpResponse
. - buildHeadersMap(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally by the SDK.
- buildHttpClient() - Method in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
Builds and returns an HttpClient using the pre-initialized configurations.
- buildNamedQueryFilter() - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQuery
-
Builds a NamedQueryFilter using this NamedQuery instance.
C
- calculateNumberOfPages(int, int, int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Calculates the number of pages given the input params.
- CANADA - com.ellucian.ethos.integration.authentication.SupportedRegions
- cancel() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
Submits a cancellation request to cancel the current subscription process.
- cancel() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
Sets the cancellation flag to true, thereby requesting that the subscription stop running after the current polling operation completes.
- cancelSubscription - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
Used to manage cancellation requests for cancelling the thread running this subscription.
- cancelSubscription() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
Cancels the subscription used by this subscriber.
- ChangeNotification - Class in com.ellucian.ethos.integration.client.messages
-
An object representation of a change-notification.
- ChangeNotification() - Constructor for class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Creates an instance of a change-notification.
- ChangeNotificationFactory - Class in com.ellucian.ethos.integration.client.messages
-
A Factory class to help with building ChangeNotification objects.
- ChangeNotificationFactory() - Constructor for class com.ellucian.ethos.integration.client.messages.ChangeNotificationFactory
- com.ellucian.ethos.integration - package com.ellucian.ethos.integration
- com.ellucian.ethos.integration.authentication - package com.ellucian.ethos.integration.authentication
- com.ellucian.ethos.integration.client - package com.ellucian.ethos.integration.client
- com.ellucian.ethos.integration.client.config - package com.ellucian.ethos.integration.client.config
- com.ellucian.ethos.integration.client.errors - package com.ellucian.ethos.integration.client.errors
- com.ellucian.ethos.integration.client.messages - package com.ellucian.ethos.integration.client.messages
- com.ellucian.ethos.integration.client.proxy - package com.ellucian.ethos.integration.client.proxy
- com.ellucian.ethos.integration.client.proxy.filter - package com.ellucian.ethos.integration.client.proxy.filter
- com.ellucian.ethos.integration.notification - package com.ellucian.ethos.integration.notification
- com.ellucian.ethos.integration.service - package com.ellucian.ethos.integration.service
- compareTo(SemVer) - Method in class com.ellucian.ethos.integration.client.config.SemVer
-
Compares this object to the given object, which should also be an instance of this class.
- consume() - Method in class com.ellucian.ethos.integration.client.messages.EthosMessagesClient
-
Gets a list of messages from the subscription queue of the application.
- consume(int, int) - Method in class com.ellucian.ethos.integration.client.messages.EthosMessagesClient
-
Gets a list of messages from the subscription queue of the application.
- consume(SupportedRegions, long, int) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds an Ethos Integration URL supporting the consume API.
- consumeFromId(int) - Method in class com.ellucian.ethos.integration.client.messages.EthosMessagesClient
-
Gets a list of messages from the subscription queue of the application, starting after the given ID.
- consumeWithLimit(int) - Method in class com.ellucian.ethos.integration.client.messages.EthosMessagesClient
-
Gets a list of messages from the subscription queue of the application.
- convertResponseContentToType(EthosResponse, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Converts the response body content within the given EthosResponse to an object of the given class type.
- convertResponseContentToTypedList(EthosResponse, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Converts the response body content within the given EthosResponse to a list of objects of the given class type.
- convertResponsesContentToTypedList(List<EthosResponse>, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Converts the response body content of each EthosResponse within the given ethosResponseList to a list of objects of the given class type.
- createCNFromJson(String) - Static method in class com.ellucian.ethos.integration.client.messages.ChangeNotificationFactory
-
Create a ChangeNotification object using a JSON string.
- createCNListFromJson(String) - Static method in class com.ellucian.ethos.integration.client.messages.ChangeNotificationFactory
-
Create a ChangeNotification array using a JSON string.
- createErrorFromJson(String) - Static method in class com.ellucian.ethos.integration.client.errors.ErrorFactory
-
Create an Error object using a JSON string.
- createErrorListFromJson(String) - Static method in class com.ellucian.ethos.integration.client.errors.ErrorFactory
-
Create an Error array using a JSON string.
- CRITERIA_FILTER_PREFIX - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Prefix value used when specifying criteria filter syntax.
- CriteriaFilter - Class in com.ellucian.ethos.integration.client.proxy.filter
-
This class is used to build CriteriaFilters, for use with Ethos resources using version 8 or later.
- CriteriaFilter.Builder - Class in com.ellucian.ethos.integration.client.proxy.filter
-
Used internally by the SDK.
- criteriaHasLabel - Variable in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Flag to determine whether to generate squirly braces when going toString() based on the existence of a criteria label.
- criteriaList - Variable in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaSet
-
The list of SimpleCriteria, as there could be more than one.
- CriteriaSet - Class in com.ellucian.ethos.integration.client.proxy.filter
-
This class is intended to be used internally by the SDK.
- CriteriaSet() - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.CriteriaSet
-
Intended to be used internally by the SDK.
D
- DEFAULT_CONNECTION_REQUEST_TIMEOUT - Static variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
Intended to be used internally by the SDK.
- DEFAULT_CONNECTION_TIMEOUT - Static variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
Intended to be used internally by the SDK.
- DEFAULT_ERROR_PAGE_SIZE - Static variable in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
The default page size (limit) when paging for errors.
- DEFAULT_MAX_PAGE_SIZE - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
The value used for the max page size if the max page size header is not found in the response.
- DEFAULT_NUM_NOTIFICATIONS - Static variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
Constant for indicating the default number of notifications to be retrieved at a time from Ethos Integration.
- DEFAULT_PAGE_SIZE - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
A default value used for the page size if no page size is specified.
- DEFAULT_POLL_INTERVAL_SECONDS - Static variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
The default poll interval in seconds.
- DEFAULT_SOCKET_TIMEOUT - Static variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
Intended to be used internally by the SDK.
- DEFAULT_VERSION - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
The default version used if no version is specified.
- defaultHeaders - Variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
The default headers.
- delete(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Delete the Error with the given ID from your tenant.
- delete(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Deletes an instance of the given resource by the given id.
- delete(String, Map<String, String>) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Makes an HTTP DELETE request with the given headers.
- doInitialization(Integer, Integer, Integer) - Method in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
Intended to be used internally by the SDK.
- doPaging(int, int, int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Intended to be used internally within the SDK.
- doPagingForAll(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- doPagingForNumPages(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- doPagingForNumRows(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- doPagingFromOffset(String, String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- doPagingFromOffsetForNumPages(String, String, int, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- doPagingFromOffsetForNumRows(String, String, int, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- doPagingFromOffsetForQAPI(String, String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Intended to be used internally within the SDK.
- doSubscribe(Flow.Subscription) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
Intended to be used internally by the SDK.
E
- equals(Object) - Method in class com.ellucian.ethos.integration.client.config.SemVer
-
Overrides the equals method to compare on the major, minor, and patch values.
- ERROR - Static variable in class com.ellucian.ethos.integration.client.errors.EthosError
-
The Error level severity for an Error object.
- ErrorFactory - Class in com.ellucian.ethos.integration.client.errors
-
A Factory class to help with building Error objects.
- ErrorFactory() - Constructor for class com.ellucian.ethos.integration.client.errors.ErrorFactory
- errors(SupportedRegions) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds an Ethos Integration URL supporting the Errors API.
- errorsPaging(SupportedRegions, int, int) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds a URL for interacting with the Errors API through Ethos Integration, in support of paging.
- EthosChangeNotificationListPollService - Class in com.ellucian.ethos.integration.notification
-
Service for distributing lists of Ethos ChangeNotifications retrieved from Ethos Integration.
- EthosChangeNotificationListPollService(EthosChangeNotificationService) - Constructor for class com.ellucian.ethos.integration.notification.EthosChangeNotificationListPollService
-
Constructs an instance of this class with the given
EthosChangeNotificationService
. - EthosChangeNotificationListPollService(EthosChangeNotificationService, long) - Constructor for class com.ellucian.ethos.integration.notification.EthosChangeNotificationListPollService
-
Constructs an instance of this class with the given params.
- EthosChangeNotificationListSubscription - Class in com.ellucian.ethos.integration.notification
-
Subscription for processing lists of ChangeNotifications.
- EthosChangeNotificationListSubscription(Flow.Publisher, Flow.Subscriber, EthosChangeNotificationService, long, TimeUnit) - Constructor for class com.ellucian.ethos.integration.notification.EthosChangeNotificationListSubscription
-
Constructs this subscription with the given params.
- EthosChangeNotificationPollService - Class in com.ellucian.ethos.integration.notification
-
Service for distributing Ethos ChangeNotifications retrieved from Ethos Integration.
- EthosChangeNotificationPollService(EthosChangeNotificationService) - Constructor for class com.ellucian.ethos.integration.notification.EthosChangeNotificationPollService
-
Constructs an instance of this class with the given ethosChangeNotificationService.
- EthosChangeNotificationPollService(EthosChangeNotificationService, long) - Constructor for class com.ellucian.ethos.integration.notification.EthosChangeNotificationPollService
-
Constructs an instance of this class with the given params.
- ethosChangeNotificationService - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
The service used for retrieving ChangeNotifications.
- ethosChangeNotificationService - Variable in class com.ellucian.ethos.integration.notification.EthosChangeNotificationListPollService
-
Used by the EthosChangeNotificationSubscription built by this class.
- ethosChangeNotificationService - Variable in class com.ellucian.ethos.integration.notification.EthosChangeNotificationPollService
-
Used by the EthosChangeNotificationSubscription built by this class.
- EthosChangeNotificationService - Class in com.ellucian.ethos.integration.service
-
Service class used for retrieving ChangeNotifications.
- EthosChangeNotificationService.Builder - Class in com.ellucian.ethos.integration.service
-
Builder class following the builder pattern used to build an EthosChangeNotificationService.
- EthosChangeNotificationSubscription - Class in com.ellucian.ethos.integration.notification
-
Subscription for ChangeNotification processing.
- EthosChangeNotificationSubscription(Flow.Publisher, Flow.Subscriber, EthosChangeNotificationService, long, TimeUnit) - Constructor for class com.ellucian.ethos.integration.notification.EthosChangeNotificationSubscription
-
Constructs this subscription with the given params.
- EthosChangeNotificationSubscriptionException - Exception in com.ellucian.ethos.integration.notification
-
A RuntimeException that can be throws during subscription processing for ChangeNotifications.
- EthosChangeNotificationSubscriptionException(String) - Constructor for exception com.ellucian.ethos.integration.notification.EthosChangeNotificationSubscriptionException
-
Constructs this exception with the given error message.
- EthosChangeNotificationSubscriptionException(String, Throwable) - Constructor for exception com.ellucian.ethos.integration.notification.EthosChangeNotificationSubscriptionException
-
Constructs this exception with the given error message and Throwable cause.
- EthosClient - Class in com.ellucian.ethos.integration.client
-
Base HTTP client to interact with Ellucian Ethos API.
- EthosClient(String, Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.EthosClient
-
Instantiates this client using the given API key and timeout values.
- ethosClientBuilder - Variable in class com.ellucian.ethos.integration.service.EthosService
-
The EthosClientBuilder used by the subclasses to build the Ethos clients used by this service.
- EthosClientBuilder - Class in com.ellucian.ethos.integration.client
-
Builder used for building Ethos clients.
- EthosClientBuilder(String) - Constructor for class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Constructs this class with the given apiKey.
- EthosConfigurationClient - Class in com.ellucian.ethos.integration.client.config
-
An
EthosClient
used to retrieve configuration data from Ethos Integration. - EthosConfigurationClient(String, Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Public constructor taking a sessionToken parameter.
- EthosError - Class in com.ellucian.ethos.integration.client.errors
-
An Ellucian Ethos Integration Error object.
- EthosError() - Constructor for class com.ellucian.ethos.integration.client.errors.EthosError
-
No-arg constructor
- EthosErrorsClient - Class in com.ellucian.ethos.integration.client.errors
-
An EthosClient used to to perform Create, Read, and Delete operations for Error objects, using the Ethos Integration errors service.
- EthosErrorsClient(String, Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Constructs an EthosErrorClient using the given API key.
- EthosFilterQueryClient<T> - Class in com.ellucian.ethos.integration.client.proxy
-
An EthosProxyClient that provides the ability to submit GET requests supporting filters and/or named queries with support for paging.
- EthosFilterQueryClient(String, Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Instantiates this class using the given API key and timeout values.
- EthosIntegrationUrls - Class in com.ellucian.ethos.integration
-
Utility class used for building Ethos Integration URLs with various criteria.
- EthosIntegrationUrls() - Constructor for class com.ellucian.ethos.integration.EthosIntegrationUrls
- ethosMessagesClient - Variable in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
The EthosMessagesClient used for retrieving change notification messages from Ethos.
- EthosMessagesClient - Class in com.ellucian.ethos.integration.client.messages
-
An EthosClient used to publish and consume messages using the Ethos Integration messages service.
- EthosMessagesClient(String, Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.messages.EthosMessagesClient
-
Creates an EthosMessagesClient using the given API key.
- ethosProxyClient - Variable in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
The EthosProxyClient used for making Ethos API calls through Ethos.
- EthosProxyClient<T> - Class in com.ellucian.ethos.integration.client.proxy
-
An EthosClient used to retrieve data from the Ethos Integration Proxy API.
- EthosProxyClient(String, Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Instantiates this class using the given API key.
- EthosProxyClientAsync<T> - Class in com.ellucian.ethos.integration.client.proxy
-
An EthosProxyClient used to retrieve data from the Ethos Integration Proxy API, asynchronously.
- EthosProxyClientAsync(String, Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Instantiates this class using the given API key.
- ethosRequestConverter - Variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
The
EthosRequestConverter
used to convert generic typed objects into JSON formatted strings for request bodies. - EthosRequestConverter<T> - Class in com.ellucian.ethos.integration.client
-
Converts request body generic type objects into JSON formatted strings, for use when making POST or PUT API requests.
- EthosRequestConverter() - Constructor for class com.ellucian.ethos.integration.client.EthosRequestConverter
-
No-arg constructor which also builds the objectMapper.
- EthosResourceNotFoundException - Exception in com.ellucian.ethos.integration.client.config
-
Thrown when the given resource is not found in the available resources response.
- EthosResourceNotFoundException(String) - Constructor for exception com.ellucian.ethos.integration.client.config.EthosResourceNotFoundException
-
Constructor taking the error message.
- EthosResourceNotFoundException(String, String) - Constructor for exception com.ellucian.ethos.integration.client.config.EthosResourceNotFoundException
-
Constructor taking the error message and the name of the resource not found in the available resources response.
- EthosResponse<T> - Class in com.ellucian.ethos.integration.client
-
Response object used by the Ethos SDK to contain specific response headers, response body content, and the HTTP response status code.
- EthosResponse(Map<String, Header>, String, int) - Constructor for class com.ellucian.ethos.integration.client.EthosResponse
-
Instantiates an EthosResponse object with the given parameters.
- ethosResponseBuilder - Variable in class com.ellucian.ethos.integration.client.EthosClient
-
Used to build an EthosResponse from the given HttpResponse in the responseHandler of each call made.
- EthosResponseBuilder - Class in com.ellucian.ethos.integration.client
-
Intended to be used to more easily build an EthosResponse object from the given
org.apache.http.HttpResponse
. - EthosResponseBuilder() - Constructor for class com.ellucian.ethos.integration.client.EthosResponseBuilder
-
No-arg constructor for instantiating this class.
- ethosResponseConverter - Variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
The
EthosResponseConverter
used to convert EthosResponses into other supported formats (Strings and JsonNodes). - EthosResponseConverter - Class in com.ellucian.ethos.integration.client
-
Converter class extending the
EthosResponseBuilder
, the primary purpose of which is to handle manipulation of the response body content for paging calculations, such as trimming the response body content for a given offset or number of rows. - EthosResponseConverter() - Constructor for class com.ellucian.ethos.integration.client.EthosResponseConverter
-
No-arg constructor which also builds the objectMapper.
- EthosService - Class in com.ellucian.ethos.integration.service
-
Abstract base service class used by various subclasses.
- EthosService(EthosClientBuilder) - Constructor for class com.ellucian.ethos.integration.service.EthosService
-
Constructs this service with the given
EthosClientBuilder
. - EthosService(String) - Constructor for class com.ellucian.ethos.integration.service.EthosService
-
Constructs this service with the given API key.
- EUROPE - com.ellucian.ethos.integration.authentication.SupportedRegions
F
- filterAvailableResources(JsonNode, JsonNode) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Intended to be used internally within the SDK.
- filterAvailableResources(JsonNode, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Intended to be used internally within the SDK.
- filterMajorVersions(List<String>) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Intended to be used internally within the SDK.
- FilterMap - Class in com.ellucian.ethos.integration.client.proxy.filter
-
Plain filter map used to support filtering for resource versions 6 and prior.
- FilterMap.Builder - Class in com.ellucian.ethos.integration.client.proxy.filter
-
Static inner class for building a FilterMap instance, following the builder pattern.
- forNumPages(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified numPages and returns this builder for fluent API functionality.
- forNumRows(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified numRows and returns this builder for fluent API functionality.
- forPagingType(Pager.PagingType) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified PagingType for how to page and returns this builder for fluent API functionality.
- forVersion(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified version and returns this builder for fluent API functionality.
- fromOffset(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified offset and returns this builder for fluent API functionality.
- FULL_VERSION - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Pattern used to provide the full version of a given resource.
- FULL_VERSION_TAG - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
The tag used as a placeholder for the version value in the FULL_VERSION string.
G
- get() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Get an initial array (page) of Errors from the tenant associated with the access token.
- get(String) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Convenience method to make an HTTP call without headers.
- get(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of resource data for the given resource by name.
- get(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, offset, and pageSize.
- get(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, offset, and pageSize.
- get(String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of resource data for the given resource by name.
- get(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version.
- get(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, version, offset, and pageSize.
- get(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, version, offset, and pageSize.
- get(String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of resource data for the given resource by name.
- get(String, Map<String, String>) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Make an HTTP GET request with the given headers.
- getAccessToken() - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Gets an access token.
- getAlias() - Method in class com.ellucian.ethos.integration.client.messages.Tenant
-
Gets the alias of the tenant.
- getAllAvailableResources() - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Get the details about all the available resources in the tenant associated with this client's session token.
- getAllAvailableResourcesAsJson() - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Get the details about all the available resources in the tenant associate with this client's session token as a List of JsonNodes.
- getAllErrors() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token.
- getAllErrorsAsEthosErrors() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token, as a list of EthosErrors.
- getAllErrorsAsJsonNodes() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token, as a list of JsonNodes.
- getAllErrorsAsStrings() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token, as a list of Strings in JSON format.
- getAllErrorsWithPageSize(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token using the given page size.
- getAllErrorsWithPageSizeAsJsonNodes(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token using the given page size, as a list of JsonNodes.
- getAllErrorsWithPageSizeAsStrings(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token using the given page size, as a list of strings in JSON format.
- getAllPages(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource.
- getAllPages(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and page size.
- getAllPages(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and page size.
- getAllPages(String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource.
- getAllPages(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and version.
- getAllPages(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size.
- getAllPages(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size.
- getAllPages(String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and version.
- getAllPagesAsJsonNodes(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource.
- getAllPagesAsJsonNodes(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and page size.
- getAllPagesAsJsonNodes(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and version.
- getAllPagesAsJsonNodes(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size.
- getAllPagesAsJsonNodesAsync(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource.
- getAllPagesAsJsonNodesAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and page size.
- getAllPagesAsJsonNodesAsync(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and version.
- getAllPagesAsJsonNodesAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and page size.
- getAllPagesAsStrings(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource.
- getAllPagesAsStrings(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and page size.
- getAllPagesAsStrings(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and version.
- getAllPagesAsStrings(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size.
- getAllPagesAsStringsAsync(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource.
- getAllPagesAsStringsAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and page size.
- getAllPagesAsStringsAsync(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and version.
- getAllPagesAsStringsAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and page size.
- getAllPagesAsync(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource.
- getAllPagesAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and page size.
- getAllPagesAsync(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and page size, and return the response bodies as generic type objects of the given class in each returned EthosResponse.
- getAllPagesAsync(String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, and return the response bodies as generic type objects of the given class in each returned EthosResponse.
- getAllPagesAsync(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and version.
- getAllPagesAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and page size.
- getAllPagesAsync(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, page size, and return the response bodies as generic type objects of the given class in each returned EthosResponse, if the classType is not null.
- getAllPagesAsync(String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and version, and return the response bodies as generic type objects of the given class in each returned EthosResponse.
- getAllPagesFromOffset(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffset(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, offset, and page size.
- getAllPagesFromOffset(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, offset, and page size.
- getAllPagesFromOffset(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffset(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and offset.
- getAllPagesFromOffset(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size, from the offset.
- getAllPagesFromOffset(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size, from the offset.
- getAllPagesFromOffset(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and offset.
- getAllPagesFromOffsetAsJsonNodes(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffsetAsJsonNodes(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and page size from the given offset.
- getAllPagesFromOffsetAsJsonNodes(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and version from the given offset.
- getAllPagesFromOffsetAsJsonNodes(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size, from the given offset.
- getAllPagesFromOffsetAsJsonNodesAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffsetAsJsonNodesAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and page size from the given offset.
- getAllPagesFromOffsetAsJsonNodesAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and version from the given offset.
- getAllPagesFromOffsetAsJsonNodesAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and page size, from the given offset.
- getAllPagesFromOffsetAsStrings(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffsetAsStrings(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource from the given offset with the given page size.
- getAllPagesFromOffsetAsStrings(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource and version from the given offset.
- getAllPagesFromOffsetAsStrings(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets all pages for the given resource, version, and page size from the given offset.
- getAllPagesFromOffsetAsStringsAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffsetAsStringsAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource from the given offset with the given page size.
- getAllPagesFromOffsetAsStringsAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource and version from the given offset.
- getAllPagesFromOffsetAsStringsAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and page size from the given offset.
- getAllPagesFromOffsetAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffsetAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, offset, and page size.
- getAllPagesFromOffsetAsync(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, offset, and page size.
- getAllPagesFromOffsetAsync(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource from the given offset.
- getAllPagesFromOffsetAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and offset.
- getAllPagesFromOffsetAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and page size, from the offset.
- getAllPagesFromOffsetAsync(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and page size, from the offset.
- getAllPagesFromOffsetAsync(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets all pages for the given resource, version, and offset.
- getAppConfig() - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Get application configuration info from Ethos Integration.
- getAppConfigJson() - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Get application configuration as a JsonNode object from Ethos Integration.
- getApplicationId() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the ID of the application that reported the error.
- getApplicationName() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the name of the application that reported the error.
- getApplicationName() - Method in class com.ellucian.ethos.integration.client.messages.Publisher
-
Gets tne name of the publishing application.
- getApplicationSubtype() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the sub-type of the application that reported the error.
- getAsEthosErrors() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Get an initial list of EthosErrors from the tenant associated with the access token.
- getAsJsonNode() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets an initial array (page) of Errors from the tenant associated with the access token, as a JsonNode.
- getAsJsonNode(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets resource data for the given resource by name.
- getAsJsonNode(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, offset, and pageSize.
- getAsJsonNode(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets data for the given resource by name and version.
- getAsJsonNode(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, version, offset, and pageSize.
- getAsString() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets an initial array (page) of Errors from the tenant associated with the access token, as a string.
- getAsString(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of resource data for the given resource by name.
- getAsString(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, offset, and pageSize.
- getAsString(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version.
- getAsString(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name, version, offset, and pageSize.
- getAuthHeader() - Method in class com.ellucian.ethos.integration.authentication.AccessToken
-
Gets an HTTP Authorization header containing the access token.
- getAutoRefresh() - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Gets the automatic refresh behavior for access tokens.
- getAvailableResourcesForApp() - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Get the details about the available resources an application points to, from the tenant associated with this client's session token.
- getAvailableResourcesForAppAsJson() - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets the details about the available resources an application points to, from the tenant associated with this client's session token.
- getById(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Get a single Error from your tenant, using the given ID.
- getById(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name.
- getById(String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name.
- getById(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name and version.
- getById(String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name and version.
- getByIdAsEthosError(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Get a single error as an EthosError object, using the given ID.
- getByIdAsJsonNode(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Get a single error as a JsonNode object, using the given ID.
- getByIdAsJsonNode(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name.
- getByIdAsJsonNode(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name and version.
- getByIdAsString(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Get a single error as a string in JSON format, using the given ID.
- getByIdAsString(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name.
- getByIdAsString(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a resource by ID (GUID) for the given resource name and version.
- getChangeNotifications() - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Retrieves change notifications using the default limit of 20 messages for message retrieval.
- getChangeNotifications(int) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
Intended to be used internally by the SDK.
- getChangeNotifications(int) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Retrieves change notifications using the given limit for message retrieval.
- getContent() - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Gets the response body as a String value.
- getContent() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Gets the content of the resource that was changed.
- getContentAsType() - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Gets the content as a generic type, if specified with this class.
- getContentType() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Gets the content-type associated with the content object.
- getCorrelationId() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the correlation ID for this error.
- getCriteriaFilter() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the request URL criteria filter as assigned by the Builder.
- getCriteriaList() - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaSet
-
Gets the list of SimpleCriteria.
- getDataFromInitialContent(Pager) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- getDataFromPaging(Pager) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- getDateTime() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the date and time that the error was reported.
- getDescription() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the description for this error.
- getDetails() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the detailed message for this error.
- getDomain() - Method in class com.ellucian.ethos.integration.client.messages.Resource
-
Gets the domain to which the resource belongs.
- getEnvironment() - Method in class com.ellucian.ethos.integration.client.messages.Tenant
-
Gets the tenant environment
- getErrorsFromOffset(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token from the given offset.
- getErrorsFromOffsetAsEthosErrors(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token from the given offset, as a list of EthosErrors.
- getErrorsFromOffsetAsJsonNodes(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token from the given offset, as a list of JsonNodes.
- getErrorsFromOffsetAsStrings(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token from the given offset, as a list of strings in JSON format.
- getErrorsFromOffsetWithPageSize(int, int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token from the given offset, using the given pageSize.
- getErrorsFromOffsetWithPageSizeAsJsonNodes(int, int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token from the given offset, using the given pageSize, as a list of JsonNodes.
- getErrorsFromOffsetWithPageSizeAsStrings(int, int) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets all of the errors for the given tenant per access token from the given offset, using the given pageSize, as a list of strings in JSON format.
- getEthosResponse() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the initial EthosResponse that was made to determine if paging was needed, as assigned by the Builder.
- getExpirationMinutes() - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Gets the number of minutes that a new access token will be valid.
- getExpirationTime() - Method in class com.ellucian.ethos.integration.authentication.AccessToken
-
Gets the time when this access token will expire
- getFilterMap() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the filter map string as assigned by the Builder.
- getFilterMapKeys() - Method in class com.ellucian.ethos.integration.client.proxy.filter.FilterMap
-
Gets a list of filter pair keys from the filterPairMap.
- getFilterMapValue(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.FilterMap
-
Gets a filter map value using the given key.
- getFilters(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a list of filters for the given resource name.
- getFilters(String, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a list of filters for the given resource name and version header value.
- getFiltersAndNamedQueries(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a JsonNode containing the supported filters and named queries for the given resource.
- getFiltersAndNamedQueries(String, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a JsonNode containing the supported filters and named queries for the given resource and version header.
- getFromOffset(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and from the given offset index.
- getFromOffset(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and from the given offset index.
- getFromOffset(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, from the given offset index.
- getFromOffset(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, from the given offset index.
- getFromOffsetAsJsonNode(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and from the given offset index.
- getFromOffsetAsJsonNode(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, from the given offset index.
- getFromOffsetAsString(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and from the given offset index.
- getFromOffsetAsString(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, from the given offset index.
- getHeader(String) - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Returns the header for the given key.
- getHeaderMapKeys() - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Gets the keys in the header map, which can be used to retrieve specific header values from
getHeader(String)
. - getHeaders() - Method in class com.ellucian.ethos.integration.client.errors.Request
-
Get the headers that were sent in the request.
- getHeaderValue(EthosResponse, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- getHowToPage() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the paging type to determine how to page.
- getHttpClient() - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Returns the HttpClient built by the httpProtocolClientBuilder.
- getHttpStatusCode() - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Gets the Http status code of the response.
- getId() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the ID for this error
- getId() - Method in class com.ellucian.ethos.integration.client.errors.Resource
-
Get the ID of the resource
- getId() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Gets the ID of the change-notification
- getId() - Method in class com.ellucian.ethos.integration.client.messages.Publisher
-
Gets the ID of the publishing application.
- getId() - Method in class com.ellucian.ethos.integration.client.messages.Resource
-
Gets the ID of the resource
- getId() - Method in class com.ellucian.ethos.integration.client.messages.Tenant
-
Gets the ID of the tenant.
- getKey() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Gets the criteria key.
- getLabel() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObject
-
Gets the name of this SimpleCriteria.
- getLatestVersion(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets the latest version of the given resource.
- getLatestVersionHeader(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets the latest version header of the given resource.
- getMajor() - Method in class com.ellucian.ethos.integration.client.config.SemVer
-
Gets the major version value.
- getMajorVersionsOfResource(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets only the major version headers as a List of Strings for the given resource name.
- getMaxPageSize(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets the max page size for the given Ethos resource.
- getMaxPageSize(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets the max page size for the given Ethos resource and version.
- getMaxPageSize(String, String, EthosResponse) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- getMinor() - Method in class com.ellucian.ethos.integration.client.config.SemVer
-
Gets the minor version value.
- getName() - Method in class com.ellucian.ethos.integration.client.errors.Resource
-
Get the name of the resource.
- getName() - Method in class com.ellucian.ethos.integration.client.messages.Resource
-
Gets the name of the resource.
- getName() - Method in class com.ellucian.ethos.integration.client.messages.Tenant
-
Gets the name of the tenant.
- getNamedQueries(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a map of named queries for the given resource name.
- getNamedQueries(String, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a map of named queries for the given resource name and version header value.
- getNamedQueryFilter() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the named query request URL filter as assigned by the Builder.
- getNumAvailableMessages() - Method in class com.ellucian.ethos.integration.client.messages.EthosMessagesClient
-
Gets the number of available messages in the subscription queue of the application.
- getNumberOfSubscribers() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
Gets the number of subscribers this publisher is responsible for.
- getNumPages() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the number of pages to page for as assigned by the Builder.
- getNumRows() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the number of rows to page for as assigned by the Builder.
- getOffset() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the offset to begin paging from as assigned by the Builder.
- getOperation() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Gets the operation that occurred to the resource.
- getOverriddenResources() - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Gets a list of resources to be overridden in change notifications.
- getOverriddenResourceVersion(String) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Gets the overridden version for the given resource name specified when adding to the resource version override.
- getPages(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource.
- getPages(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size.
- getPages(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size.
- getPages(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource.
- getPages(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and version.
- getPages(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size.
- getPages(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size.
- getPages(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and version.
- getPagesAsJsonNodes(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource.
- getPagesAsJsonNodes(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size.
- getPagesAsJsonNodes(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and version.
- getPagesAsJsonNodes(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size.
- getPagesAsJsonNodesAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource.
- getPagesAsJsonNodesAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size.
- getPagesAsJsonNodesAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and version.
- getPagesAsJsonNodesAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size.
- getPagesAsStrings(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource.
- getPagesAsStrings(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size.
- getPagesAsStrings(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource.
- getPagesAsStrings(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size.
- getPagesAsStringsAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource.
- getPagesAsStringsAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size.
- getPagesAsStringsAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource.
- getPagesAsStringsAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size.
- getPagesAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource.
- getPagesAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size.
- getPagesAsync(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size.
- getPagesAsync(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource.
- getPagesAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and version.
- getPagesAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size.
- getPagesAsync(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size.
- getPagesAsync(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and version.
- getPagesFromOffset(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffset(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size from the given offset.
- getPagesFromOffset(String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size from the given offset.
- getPagesFromOffset(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffset(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and version from the given offset.
- getPagesFromOffset(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffset(String, String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffset(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and version from the given offset.
- getPagesFromOffsetAsJsonNodes(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffsetAsJsonNodes(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size, from the given offset.
- getPagesFromOffsetAsJsonNodes(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and version, from the given offset.
- getPagesFromOffsetAsJsonNodes(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffsetAsJsonNodesAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffsetAsJsonNodesAsync(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size, from the given offset.
- getPagesFromOffsetAsJsonNodesAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and version, from the given offset.
- getPagesFromOffsetAsJsonNodesAsync(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffsetAsStrings(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffsetAsStrings(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and page size from the given offset.
- getPagesFromOffsetAsStrings(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource and version from the given offset.
- getPagesFromOffsetAsStrings(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffsetAsStringsAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffsetAsStringsAsync(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size from the given offset.
- getPagesFromOffsetAsStringsAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and version from the given offset.
- getPagesFromOffsetAsStringsAsync(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffsetAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffsetAsync(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size from the given offset.
- getPagesFromOffsetAsync(String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and page size from the given offset.
- getPagesFromOffsetAsync(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource from the given offset.
- getPagesFromOffsetAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and version from the given offset.
- getPagesFromOffsetAsync(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffsetAsync(String, String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource, version, and page size, from the given offset.
- getPagesFromOffsetAsync(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of pages for the given resource and version from the given offset.
- getPagesFromOffsetWithCriteriaFilter(String, CriteriaFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter.
- getPagesFromOffsetWithCriteriaFilter(String, CriteriaFilter, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter and page size for the given version.
- getPagesFromOffsetWithCriteriaFilter(String, CriteriaFilter, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter and page size for the given version.
- getPagesFromOffsetWithCriteriaFilter(String, CriteriaFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter.
- getPagesFromOffsetWithCriteriaFilter(String, String, CriteriaFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter for the given version.
- getPagesFromOffsetWithCriteriaFilter(String, String, CriteriaFilter, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter and page size for the given version.
- getPagesFromOffsetWithCriteriaFilter(String, String, CriteriaFilter, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter and page size for the given version.
- getPagesFromOffsetWithCriteriaFilter(String, String, CriteriaFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified criteria filter for the given version.
- getPagesFromOffsetWithFilterMap(String, String, FilterMap, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified filter map and page size for the given version.
- getPagesFromOffsetWithFilterMap(String, String, FilterMap, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified filter map and page size for the given version.
- getPagesFromOffsetWithFilterMap(String, String, FilterMap, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified filter map and page size for the given version.
- getPagesFromOffsetWithFilterMap(String, String, FilterMap, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified filter map and page size for the given version.
- getPagesFromOffsetWithNamedQueryFilter(String, NamedQueryFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter.
- getPagesFromOffsetWithNamedQueryFilter(String, NamedQueryFilter, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter and page size for the given version.
- getPagesFromOffsetWithNamedQueryFilter(String, NamedQueryFilter, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter and page size for the given version.
- getPagesFromOffsetWithNamedQueryFilter(String, NamedQueryFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter.
- getPagesFromOffsetWithNamedQueryFilter(String, String, NamedQueryFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter for the given version.
- getPagesFromOffsetWithNamedQueryFilter(String, String, NamedQueryFilter, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter and page size for the given version.
- getPagesFromOffsetWithNamedQueryFilter(String, String, NamedQueryFilter, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter and page size for the given version.
- getPagesFromOffsetWithNamedQueryFilter(String, String, NamedQueryFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at the given offset index, using the specified named query filter for the given version.
- getPagesFromOffsetWithQAPI(String, String, int, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body for the given version.
- getPagesFromOffsetWithQAPI(String, String, int, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body for the given version.
- getPagesFromOffsetWithQAPI(String, String, int, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body for the given version.
- getPagesFromOffsetWithQAPI(String, String, JsonNode, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body and page size for the given version.
- getPagesFromOffsetWithQAPI(String, String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body and page size for the given version.
- getPagesFromOffsetWithQAPI(String, String, T, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the pages for a given resource beginning at the given offset index, using the specified QAPI request body and page size for the given version.
- getPageSize() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the page size, or the number of rows in each page (response) as assigned by the Builder.
- getPageSize(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets the page size for the given Ethos resource.
- getPageSize(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets the page size for the given Ethos resource and version.
- getPageSize(String, String, EthosResponse) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- getPagesWithCriteriaFilter(String, CriteriaFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter.
- getPagesWithCriteriaFilter(String, CriteriaFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter and page size.
- getPagesWithCriteriaFilter(String, CriteriaFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter and page size.
- getPagesWithCriteriaFilter(String, CriteriaFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter.
- getPagesWithCriteriaFilter(String, String, CriteriaFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter for the given version.
- getPagesWithCriteriaFilter(String, String, CriteriaFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter and page size for the given version.
- getPagesWithCriteriaFilter(String, String, CriteriaFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter and page size for the given version.
- getPagesWithCriteriaFilter(String, String, CriteriaFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified criteria filter for the given version.
- getPagesWithFilterMap(String, String, FilterMap) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified filter map and page size for the given version.
- getPagesWithFilterMap(String, String, FilterMap, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified filter map and page size for the given version.
- getPagesWithFilterMap(String, String, FilterMap, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified filter map and page size for the given version.
- getPagesWithFilterMap(String, String, FilterMap, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified filter map and page size for the given version.
- getPagesWithNamedQueryFilter(String, NamedQueryFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter.
- getPagesWithNamedQueryFilter(String, NamedQueryFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter and page size.
- getPagesWithNamedQueryFilter(String, NamedQueryFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter and page size.
- getPagesWithNamedQueryFilter(String, NamedQueryFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter.
- getPagesWithNamedQueryFilter(String, String, NamedQueryFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter for the given version.
- getPagesWithNamedQueryFilter(String, String, NamedQueryFilter, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter and page size for the given version.
- getPagesWithNamedQueryFilter(String, String, NamedQueryFilter, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter and page size for the given version.
- getPagesWithNamedQueryFilter(String, String, NamedQueryFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource using the specified named query filter for the given version.
- getPagesWithQAPI(String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body.
- getPagesWithQAPI(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body.
- getPagesWithQAPI(String, String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body for the given version.
- getPagesWithQAPI(String, String, JsonNode, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body and page size for the given version.
- getPagesWithQAPI(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body for the given version.
- getPagesWithQAPI(String, String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body and page size for the given version.
- getPagesWithQAPI(String, String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body for the given version.
- getPagesWithQAPI(String, String, T, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body and page size for the given version.
- getPagesWithQAPI(String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets all the pages for a given resource beginning at offset index 0, using the specified QAPI request body.
- getPatch() - Method in class com.ellucian.ethos.integration.client.config.SemVer
-
Gets the patch version value.
- getPayload() - Method in class com.ellucian.ethos.integration.client.errors.Request
-
Get the payload that was sent in the request.
- getPublished() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Gets the date and time that this change-notification was published.
- getPublisher() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Gets the publishing application information
- getQapiRequestBody() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the QAPI request body as assigned by the builder.
- getRegion() - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Gets the region to get the data from.
- getRequest() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get original request that caused the error.
- getRequestedUrl() - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Gets the URL which the corresponding request was made for.
- getResource() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the resource associated with this error.
- getResource() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Gets the resource to which the change occurred.
- getResourceDetails(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Get the details of a single resource from the tenant associated with this client's session token.
- getResourceDetailsAsJson(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Get the details of a single resource from the tenant associated with this client's session token.
- getResourceName() - Method in exception com.ellucian.ethos.integration.client.config.EthosResourceNotFoundException
-
Gets the name of the resource that was not found.
- getResourceName() - Method in exception com.ellucian.ethos.integration.client.config.UnsupportedVersionException
-
Gets the name of the Ethos resource.
- getResourceName() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the resource name as assigned by the Builder.
- getResourceVersionsByRepresentationType(String, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Intended to be used internally within the SDK.
- getResponseCode() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the response code associated with this error.
- getRows(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource.
- getRows(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size.
- getRows(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size.
- getRows(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource.
- getRows(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and version.
- getRows(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size.
- getRows(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size.
- getRows(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and version.
- getRowsAsJsonNodes(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource.
- getRowsAsJsonNodes(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size.
- getRowsAsJsonNodes(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and version.
- getRowsAsJsonNodes(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size.
- getRowsAsJsonNodesAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource.
- getRowsAsJsonNodesAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size.
- getRowsAsJsonNodesAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and version.
- getRowsAsJsonNodesAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size.
- getRowsAsStrings(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource.
- getRowsAsStrings(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size.
- getRowsAsStrings(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource.
- getRowsAsStrings(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size.
- getRowsAsStringsAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource.
- getRowsAsStringsAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size.
- getRowsAsStringsAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource.
- getRowsAsStringsAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size.
- getRowsAsync(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource.
- getRowsAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size.
- getRowsAsync(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size.
- getRowsAsync(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource.
- getRowsAsync(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and version.
- getRowsAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size.
- getRowsAsync(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size.
- getRowsAsync(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and version.
- getRowsFromOffset(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffset(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size from the given offset.
- getRowsFromOffset(String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size from the given offset.
- getRowsFromOffset(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffset(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and version from the given offset.
- getRowsFromOffset(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffset(String, String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffset(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and version from the given offset.
- getRowsFromOffsetAsJsonNodes(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffsetAsJsonNodes(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size, from the given offset.
- getRowsFromOffsetAsJsonNodes(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and version, from the given offset.
- getRowsFromOffsetAsJsonNodes(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffsetAsJsonNodesAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffsetAsJsonNodesAsync(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size, from the given offset.
- getRowsFromOffsetAsJsonNodesAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and version, from the given offset.
- getRowsFromOffsetAsJsonNodesAsync(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffsetAsStrings(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffsetAsStrings(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and page size, from the given offset.
- getRowsFromOffsetAsStrings(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource and version, from the given offset.
- getRowsFromOffsetAsStrings(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffsetAsStringsAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffsetAsStringsAsync(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size, from the given offset.
- getRowsFromOffsetAsStringsAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and version, from the given offset.
- getRowsFromOffsetAsStringsAsync(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffsetAsync(String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffsetAsync(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size from the given offset.
- getRowsFromOffsetAsync(String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and page size from the given offset.
- getRowsFromOffsetAsync(String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource from the given offset.
- getRowsFromOffsetAsync(String, String, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and version from the given offset.
- getRowsFromOffsetAsync(String, String, int, int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffsetAsync(String, String, int, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource, version, and page size, from the given offset.
- getRowsFromOffsetAsync(String, String, int, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClientAsync
-
Gets some number of rows for the given resource and version from the given offset.
- getSeverity() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the Severity for the error.
- getSimpleCriteriaCount() - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Gets the count of SimpleCriteria objects this MultiCriteriaObject contains.
- getSubscribers() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
Gets a list of the subscribers this publisher has.
- getTenant() - Method in class com.ellucian.ethos.integration.client.messages.Publisher
-
Gets the tenant where the change occurred.
- getToken() - Method in class com.ellucian.ethos.integration.authentication.AccessToken
-
Gets the JWT value for this access token.
- getTotalCount() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the total count (number of rows) for the given resource, as assigned by the Builder.
- getTotalCount(String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets the total count of rows for the given Ethos resource.
- getTotalCount(String, CriteriaFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given criteriaFilter.
- getTotalCount(String, FilterMap) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given filterMap.
- getTotalCount(String, NamedQueryFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given namedQueryFilter.
- getTotalCount(String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given QAPI request body.
- getTotalCount(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given QAPI request body.
- getTotalCount(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets the total count of rows for the given Ethos resource and version.
- getTotalCount(String, String, EthosResponse) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- getTotalCount(String, String, CriteriaFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given criteriaFilter.
- getTotalCount(String, String, FilterMap) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given filterMap.
- getTotalCount(String, String, NamedQueryFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given namedQueryFilter.
- getTotalCount(String, String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given QAPI request body.
- getTotalCount(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given QAPI request body.
- getTotalCount(String, String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given QAPI request body.
- getTotalCount(String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets the total count of resources available using the given QAPI request body.
- getTotalErrorCount() - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Gets the total number of errors according to the 'x-total-count' response header for the given tenant per access token.
- getUnsupportedVersion() - Method in exception com.ellucian.ethos.integration.client.config.UnsupportedVersionException
-
Gets the unsupported version.
- getURI() - Method in class com.ellucian.ethos.integration.client.errors.Request
-
Get the URI to which the request was sent.
- getValue() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Gets the value to filter by for this criteria.
- getValue() - Method in enum com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Gets the String value of this enum.
- getValueCount() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaValueArray
-
Gets the number of values in the valueList for this array.
- getVersion() - Method in class com.ellucian.ethos.integration.client.errors.Resource
-
Get the version of the resource that erred.
- getVersion() - Method in class com.ellucian.ethos.integration.client.messages.Resource
-
Gets the version of the resource.
- getVersion() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the version (media-type) as assigned by the Builder.
- getVersionHeader(String, int) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets the full version header string for the given resource and major version if the resource supports the given major version.
- getVersionHeader(String, int, int) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets the full version header string for the given resource, major, and minor version if the resource supports the given major.minor version.
- getVersionHeader(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets the full version header string for the given resource, major, minor, and patch version if the resource supports the given major.minor.patch version.
- getVersionHeader(String, SemVer) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets the full version header string for the given resource and SemVer if the resource supports the given version contained within the SemVer.
- getVersionHeadersForApp(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Returns a list of version headers for the given resourceName filtered by the ownerOverrides property from appConfig.
- getVersionHeadersOfResource(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a list of full version headers of the given resource name from the available-resources API.
- getVersionHeadersOfResourceAsStrings(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a list of version header string values from the /versions json property of the ArrayNode returned from
getVersionHeadersOfResource()
. - getVersionList(ArrayNode, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Intended to be used internally by the SDK.
- getVersionListForOwnerOverrides(ArrayNode, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Intended to be used internally by the SDK.
- getVersionsForApp(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Returns a list of versions for the given resourceName filtered by the ownerOverrides property from appConfig.
- getVersionsOfResource(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a list of versions of the given resource name from the available-resources API.
- getVersionsOfResourceAsStrings(String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Gets a list of version string values from the /versions json property of the ArrayNode returned from
getVersionsOfResource()
. - getWithCriteriaFilter(String, CriteriaFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name with the given filter.
- getWithCriteriaFilter(String, CriteriaFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name with the given filter.
- getWithCriteriaFilter(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource with the given filter.
- getWithCriteriaFilter(String, String, CriteriaFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given filter.
- getWithCriteriaFilter(String, String, CriteriaFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given filter.
- getWithCriteriaFilter(String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource with the given filter.
- getWithCriteriaFilter(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given filter.
- getWithCriteriaFilter(String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given filter.
- getWithFilterMap(String, String, FilterMap) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a GET request for the given resource and version using the given filterMap.
- getWithFilterMap(String, String, FilterMap, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a GET request for the given resource and version using the given filterMap.
- getWithFilterMap(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a GET request for the given resource and version using the given filterMapStr.
- getWithFilterMap(String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a GET request for the given resource and version using the given filterMapStr.
- getWithNamedQueryFilter(String, NamedQueryFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name with the given named query filter.
- getWithNamedQueryFilter(String, NamedQueryFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name with the given named query filter.
- getWithNamedQueryFilter(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource with the given named query filter.
- getWithNamedQueryFilter(String, String, NamedQueryFilter) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given named query filter.
- getWithNamedQueryFilter(String, String, NamedQueryFilter, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given named query filter.
- getWithNamedQueryFilter(String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource with the given named query filter.
- getWithNamedQueryFilter(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given named query filter.
- getWithNamedQueryFilter(String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Gets a page of data for the given resource by name and version with the given named query filter.
- getWithPageSize(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name using the given page size.
- getWithPageSize(String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name using the given page size.
- getWithPageSize(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, using the given page size.
- getWithPageSize(String, String, int, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, using the given page size.
- getWithPageSizeAsJsonNode(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name using the given page size.
- getWithPageSizeAsJsonNode(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, using the given page size.
- getWithPageSizeAsString(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name using the given page size.
- getWithPageSizeAsString(String, String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Gets a page of data for the given resource by name and version, using the given page size.
- getWithQAPI(String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a QAPI POST request to filter by the request body.
- getWithQAPI(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a QAPI POST request to filter by the request body.
- getWithQAPI(String, String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a QAPI POST request to filter by the request body.
- getWithQAPI(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a QAPI POST request to filter by the request body.
- getWithQAPI(String, String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a QAPI POST request to filter by the request body.
- getWithQAPI(String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Submits a QAPI POST request to filter by the request body.
- getWithSimpleCriteriaArrayValues(String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaArray.
- getWithSimpleCriteriaArrayValues(String, String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaArray.
- getWithSimpleCriteriaArrayValues(String, String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaArray.
- getWithSimpleCriteriaArrayValues(String, String, String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaArray.
- getWithSimpleCriteriaObjectValues(String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaObject.
- getWithSimpleCriteriaObjectValues(String, String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaObject.
- getWithSimpleCriteriaObjectValues(String, String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaObject.
- getWithSimpleCriteriaObjectValues(String, String, String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteriaObject.
- getWithSimpleCriteriaValues(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteria.
- getWithSimpleCriteriaValues(String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteria.
- getWithSimpleCriteriaValues(String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteria.
- getWithSimpleCriteriaValues(String, String, String, String, Class) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Convenience method to submit a GET request with a single set of criteria filter for a SimpleCriteria.
H
- handlePaging(Pager) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- hashCode() - Method in class com.ellucian.ethos.integration.client.config.SemVer
-
Overrides the hashCode to compute and return the hashCode value comprised of the major, minor, and patch values of this class.
- HDR_APPLICATION_CONTEXT - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the application designation in Ethos Integration.
- HDR_CONTENT_TYPE - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the content-type.
- HDR_DATE - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the current date of the response.
- HDR_HEDTECH_ETHOS_INTEGRATION_APPLICATION_ID - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the application ID of the application used in Ethos Integration.
- HDR_HEDTECH_ETHOS_INTEGRATION_APPLICATION_NAME - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the application name of the application used in Ethos Integration.
- HDR_REMAINING_COUNT - Static variable in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
The remaining count header found in the EthosResponse.
- HDR_TOTAL_COUNT - Static variable in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
The total count header found in the EthosResponse.
- HDR_USER_AGENT - Static variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
The user agent header used for requests from the SDK.
- HDR_VALUE_USER_AGENT - Static variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
The value of the user agent header.
- HDR_X_CONTENT_RESTRICTED - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for content restricted.
- HDR_X_MAX_PAGE_SIZE - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the max page size.
- HDR_X_MEDIA_TYPE - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the version of the Ethos resource (data-model).
- HDR_X_TOTAL_COUNT - Static variable in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Response header for the total count (total number of rows) for the given resource.
- head(String) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Make an HTTP HEAD request against the given URL.
- httpProtocolClientBuilder - Variable in class com.ellucian.ethos.integration.client.EthosClient
-
The Http client builder which builds an HttpClient used for making secure calls to the Ethos Integration API.
- HttpProtocolClientBuilder - Class in com.ellucian.ethos.integration.client
-
Builds an org.apache.http.client.HttpClient used for making secure API calls over HTTP.
- HttpProtocolClientBuilder(Integer, Integer, Integer) - Constructor for class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
Instantiates a new Http client builder service and initializes it with the default configurations for the sslConnectionSocketFactory, and defaultHeaders.
I
- INFO - Static variable in class com.ellucian.ethos.integration.client.errors.EthosError
-
The Info level severity for an Error object.
- init(int, int, int) - Method in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
Intended to be used internally by the SDK.
- isResourceVersionSupported(String, int) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Indicates if the given resource supports the given major version.
- isResourceVersionSupported(String, int, int) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Indicates if the given resource supports the given major.minor version.
- isResourceVersionSupported(String, int, int, int) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Indicates if the given resource supports the given major.minor.patch version.
- isResourceVersionSupported(String, SemVer) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Indicates if the requested Ethos resource supports a version represented by the given SemVer object.
- isResourceVersionSupported(String, String) - Method in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Indicates if the given resource supports the given full version header.
- isRunning() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
Indicates if this subscription is still running, or not.
- isShouldDoPaging() - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Gets the shouldDoPaging indicator as assigned by the Builder.
- isSubscriptionRunning() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
Indicates whether the subscription for this subscriber is running, or not.
- isValid() - Method in class com.ellucian.ethos.integration.authentication.AccessToken
-
Determines if the token is still valid, meaning that is has a JWT string and it is not expired.
J
- JSON_ACCESSOR_APPICATIONID - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing an applicationId property from a JsonNode.
- JSON_ACCESSOR_APPID - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing an appId property from a JsonNode.
- JSON_ACCESSOR_APPNAME - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing an appName property from a JsonNode.
- JSON_ACCESSOR_FILTERS - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a filters property from a JsonNode.
- JSON_ACCESSOR_ID - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing an id property from a JsonNode.
- JSON_ACCESSOR_NAME - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a name property from a JsonNode.
- JSON_ACCESSOR_NAMEDQUERIES - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a namedQueries property from a JsonNode.
- JSON_ACCESSOR_OWNEROVERRIDES - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing an ownerOverrides property from a JsonNode.
- JSON_ACCESSOR_REPRESENTATIONS - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a representations property path from a JsonNode.
- JSON_ACCESSOR_RESOURCE - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a resource property path from a JsonNode.
- JSON_ACCESSOR_RESOURCE_NAME - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a resource/name property path from a JsonNode.
- JSON_ACCESSOR_RESOURCE_REPRESENTATIONS - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a resource/representations property path from a JsonNode.
- JSON_ACCESSOR_RESOURCENAME - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a resourceName property from a JsonNode.
- JSON_ACCESSOR_RESOURCES - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a resources property from a JsonNode.
- JSON_ACCESSOR_VERSION - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a version property from a JsonNode.
- JSON_ACCESSOR_VERSIONS - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing a versions property from a JsonNode.
- JSON_ACCESSOR_XMEDIATYPE - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when accessing an X-Media-Type property from a JsonNode.
- JSON_SETTER_APPID - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting an appId property on a JsonNode.
- JSON_SETTER_APPNAME - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting an appName property on a JsonNode.
- JSON_SETTER_FILTERS - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting a filters property on a JsonNode.
- JSON_SETTER_NAMEDQUERIES - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting a namedQuery property on a JsonNode.
- JSON_SETTER_RESOURCE - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting a resource property on a JsonNode.
- JSON_SETTER_RESOURCENAME - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting a resourceName property on a JsonNode.
- JSON_SETTER_VERSION - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting a version property on a JsonNode.
- JSON_SETTER_VERSIONS - Static variable in class com.ellucian.ethos.integration.client.config.EthosConfigurationClient
-
Constant used when setting a versions property on a JsonNode.
K
- key - Variable in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
The key of the JSON label for the criteria.
L
- label - Variable in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
The JSON label for the this object.
- label - Variable in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObject
-
The label associated with a key/value criteria pair.
M
- MultiCriteriaObject - Class in com.ellucian.ethos.integration.client.proxy.filter
-
A SimpleCriteria object that can contain more than one criteria.
- MultiCriteriaObject(String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Intended to be used internally by the SDK.
- MultiCriteriaObject(String, SimpleCriteria) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Intended to be used internally by the SDK.
- MultiCriteriaObject(String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Intended to be used internally by the SDK.
- MultiCriteriaObject(String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Intended to be used internally by the SDK.
- MultiCriteriaObject(String, String, String, boolean) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Intended to be used internally by the SDK.
- MultiCriteriaObjectArray - Class in com.ellucian.ethos.integration.client.proxy.filter
-
An array of MultiCriteriaObjects.
- MultiCriteriaObjectArray(String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Intended to be used internally by the SDK.
- MultiCriteriaObjectArray(String, MultiCriteriaObject) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Intended to be used internally by the SDK.
- MultiCriteriaObjectArray(String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Intended to be used internally by the SDK.
- MultiCriteriaObjectArray(String, String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Intended to be used internally by the SDK.
N
- namedQuery - Variable in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryFilter
-
A SimpleCriteria reference used to hold the named query criteria.
- NamedQuery - Class in com.ellucian.ethos.integration.client.proxy.filter
-
This class supports the basic structure of key/value pairs for named query criteria proxy filter requests.
- NamedQuery(String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.NamedQuery
-
Intended to be used internally by the SDK.
- NamedQueryCombination - Class in com.ellucian.ethos.integration.client.proxy.filter
-
This class supports the basic structure of a JSON object containing a combination of a NamedQuery and a NamedQueryObject used for named query criteria proxy filter requests.
- NamedQueryCombination(String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryCombination
-
Intended to be used internally by the SDK.
- NamedQueryFilter - Class in com.ellucian.ethos.integration.client.proxy.filter
-
This class generates the named query structure used when making named query proxy filter requests.
- NamedQueryFilter(NamedQuery) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryFilter
-
Intended to be used internally by the SDK.
- NamedQueryObject - Class in com.ellucian.ethos.integration.client.proxy.filter
-
This class supports the basic structure of a JSON object containing a label for a named query key/value pair used for named query criteria proxy filter requests.
- NamedQueryObject(String, String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObject
-
Intended to be used internally by the SDK.
- NamedQueryObjectArrayCombination - Class in com.ellucian.ethos.integration.client.proxy.filter
-
This class supports the basic structure of a JSON object containing a combination of a NamedQueryObject and an array of NamedQueryObjects used for named query criteria proxy filter requests.
- NamedQueryObjectArrayCombination(String, String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObjectArrayCombination
-
Intended to be used internally by the SDK.
- needToPage(int, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- needToPage(JsonNode, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- needToPage(String, int) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- nestCriteria(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObject
-
Nests this SimpleCriteriaObject within a new one using the given label.
- nestedSimpleCriteria - Variable in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObject
-
A reference to a SimpleCriteria which can be nested within this object.
- nestInSimpleCriteriaObject(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Nests this object within a new SimpleCriteriaObject with the given label.
- newCriteriaSet() - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter.Builder
-
Establishes a new CriteriaSet within this filter.
- numNotifications - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
The number of notifications to request at a time from Ethos Integration.
O
- objectMapper - Variable in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
A Jackson objectMapper to count the number of rows in the response body content, and to convert to the response body to a generic type object.
- onChangeNotification(ChangeNotification) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
This is the hook which client application code should implement when subclassing this class for processing ChangeNotifications.
- onChangeNotificationError(Throwable) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
This is the hook which client application code should implement when subclassing this class for handling errors that occurred during onChangeNotification().
- onChangeNotificationList(List<ChangeNotification>) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
This is the hook which client application code should implement when subclassing this class for processing entire lists of ChangeNotifications.
- onChangeNotificationListError(Throwable) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
This is the hook which client application code should implement when subclassing this class for handling errors that occurred during onChangeNotificationList().
- onComplete() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
Intended to be used internally by the SDK.
- onComplete() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
Intended to be used internally by the SDK.
- onError(Throwable) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
Intended to be used internally by the SDK.
- onError(Throwable) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
Intended to be used internally by the SDK.
- onNext(ChangeNotification) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
Intended to be used internally by the SDK.
- onNext(List<ChangeNotification>) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
Intended to be used internally by the SDK.
- onSubscribe(Flow.Subscription) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationListSubscriber
-
Intended to be used internally by the SDK.
- onSubscribe(Flow.Subscription) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscriber
-
Intended to be used internally by the SDK.
P
- PAGE_ALL_PAGES - com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Page for all of the pages for a given resource, starting at the beginning (offset 0).
- PAGE_FROM_OFFSET - com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Page beginning from the given offset (row num) for all of the data.
- PAGE_FROM_OFFSET_FOR_NUMPAGES - com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Page from the given offset for some number of pages.
- PAGE_FROM_OFFSET_FOR_NUMROWS - com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Page from the given offset for some number of rows.
- PAGE_TO_NUMPAGES - com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Page up to the specified number of pages, starting at the beginning (offset 0).
- PAGE_TO_NUMROWS - com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Page up to some number of rows.
- Pager - Class in com.ellucian.ethos.integration.client.proxy
-
Data transfer object (DTO) used primarily within the SDK to easily specify various criteria supporting paging operations.
- Pager() - Constructor for class com.ellucian.ethos.integration.client.proxy.Pager
- Pager.Builder - Class in com.ellucian.ethos.integration.client.proxy
-
An inner static Builder class used for building the Pager object with various criteria.
- Pager.PagingType - Enum in com.ellucian.ethos.integration.client.proxy
-
Various paging types to determine what kind of paging to be done.
- pollingInterval - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
The amount of time to wait between polls.
- pollingIntervalSeconds - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
The polling interval in seconds between poll attempts to retrieve notification messages from Ethos Integration.
- pollingIntervalTimeUnit - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
The time unit for the polling interval.
- post(EthosError) - Method in class com.ellucian.ethos.integration.client.errors.EthosErrorsClient
-
Create the given Error in your tenant with a POST request to the Ethos Integration errors service.
- post(String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a POST request for the given resourceName with the given requestBodyNode.
- post(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a POST request for the given resourceName with the given requestBody.
- post(String, String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a POST request for the given resourceName with the given requestBodyNode, which is a JsonNode.
- post(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a POST request for the given resourceName with the given requestBody.
- post(String, String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a POST request for the given resourceName and version using the given genericTypeBody.
- post(String, Map<String, String>, String) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Makes an HTTP POST request with the given headers and body to the specified URL.
- post(String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a POST request for the given resourceName using the given genericTypeBody.
- prepareForPaging(Pager) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Intended to be used internally within the SDK.
- prepareForPaging(Pager) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- preparePagerForPageSize(Pager) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Intended to be used internally by the SDK.
- preparePagerForTotalCount(Pager) - Method in class com.ellucian.ethos.integration.client.proxy.EthosFilterQueryClient
-
Intended to be used internally by the SDK.
- processCancellation() - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
Intended to be used internally by the SDK.
- processChangeNotificationOverrides(ChangeNotification) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Intended to be used internally by the SDK.
- processChangeNotifications(List<ChangeNotification>) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
Intended to be used internally by the SDK.
- processChangeNotifications(List<ChangeNotification>) - Method in class com.ellucian.ethos.integration.notification.EthosChangeNotificationListSubscription
-
Intended to be used internally by the SDK.
- processChangeNotifications(List<ChangeNotification>) - Method in class com.ellucian.ethos.integration.notification.EthosChangeNotificationSubscription
-
Intended to be used internally by the SDK.
- processRequest(int) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
Intended to be used internally by the SDK.
- publisher - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
The publisher of this subscription.
- Publisher - Class in com.ellucian.ethos.integration.client.messages
-
A Publisher object that is associated with a change-notification.
- Publisher() - Constructor for class com.ellucian.ethos.integration.client.messages.Publisher
-
Creates an instance of a Publisher.
- put(String, String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given requestBodyNode.
- put(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given requestBody.
- put(String, String, String, JsonNode) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given requestBodyNode, which is a JsonNode.
- put(String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given requestBody.
- put(String, String, String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given genericTypeBody.
- put(String, String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given genericTypeBody.
- put(String, Map<String, String>, String) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Makes an HTTP PUT request with the given headers and body to the specified URL.
- put(String, T) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given genericTypeBody.
- put(T, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Submits a PUT request for the given resourceName to update a resource with the given genericTypeBody.
Q
- qapiPaging(SupportedRegions, String, int, int) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging for QAPI POST requests
- qapis(SupportedRegions, String) - Static method in class com.ellucian.ethos.integration.EthosIntegrationUrls
-
Builds a URL for interacting with the Proxy APIs through Ethos Integration for QAPI POST requests.
- queryLabel - Variable in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObject
-
The name of this named query.
- queryName - Variable in class com.ellucian.ethos.integration.client.proxy.filter.NamedQuery
-
The name of this named query.
R
- removeResourceVersionOverride(String) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService
-
Enables client application code to remove resource version overrides after this service has been built.
- request(long) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosChangeNotificationSubscription
-
Intended to be used internally by the SDK.
- request(long) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
Intended to be used internally by the SDK.
- Request - Class in com.ellucian.ethos.integration.client.errors
-
A Request object that is associated with an Error.
- Request(String, String[], String) - Constructor for class com.ellucian.ethos.integration.client.errors.Request
-
Create a Request object.
- requestConfigBuilder - Variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
The Request config builder.
- Resource - Class in com.ellucian.ethos.integration.client.errors
-
A Resource object that is associated with an Error.
- Resource - Class in com.ellucian.ethos.integration.client.messages
-
A Resource object that is associated with a change-notification.
- Resource() - Constructor for class com.ellucian.ethos.integration.client.messages.Resource
-
Creates an instance of a Resource.
- Resource(String, String, String) - Constructor for class com.ellucian.ethos.integration.client.errors.Resource
-
Create an instance of a Resource.
- resourceName - Variable in exception com.ellucian.ethos.integration.client.config.UnsupportedVersionException
-
The name of the resource that the unsupportedVersion was requested for.
- responseHandler - Variable in class com.ellucian.ethos.integration.client.EthosClient
-
The responseHandler used for each request made.
S
- scheduledExecutorService - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
Runs the thread for this subscription on a polling interval schedule.
- scheduledFuture - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
Assigned by the scheduledExecutorService when it schedules the subscription process to run.
- SemVer - Class in com.ellucian.ethos.integration.client.config
-
The SemVer class holds the semantic version for an Ethos resource.
- SemVer() - Constructor for class com.ellucian.ethos.integration.client.config.SemVer
- SemVer.Builder - Class in com.ellucian.ethos.integration.client.config
-
An inner static Builder class used for building the SemVer object with various criteria.
- setApplicationId(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set the ID of the application that reported the error.
- setApplicationName(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set the name of the application that reported the error.
- setApplicationSubtype(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set the sub-type of the application that reported the error.
- setAutoRefresh(boolean) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Sets the automatic refresh behavior for access tokens.
- setContent(JsonNode) - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Sets the content.
- setContentAsType(T) - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Sets the content as a generic type object.
- setContentType(String) - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Sets the contentType.
- setCorrelationId(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set the correlation ID for this error.
- setCriteriaFilter(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the request URL criteria filter.
- setDateTime(Date) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set the date and time that the error was reported.
- setDescription(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set the description for this error.
- setDetails(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set the detailed message for this error.
- setEthosResponse(EthosResponse) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the initial ethosResponse used to determine if paging is needed.
- setExpirationMinutes(int) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Sets the number of minutes that a new access token will be valid.
- setFilterMap(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the request URL filter map string.
- setHowToPage(Pager.PagingType) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the payingType enum for how paging should be done.
- setId(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Sets the ID (GUID)
- setNamedQueryFilter(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the request URL named query filter.
- setNumPages(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the number of pages to page for.
- setNumRows(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the number of rows to page for.
- setOffset(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the offset to begin paging from.
- setPageSize(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the page size.
- setQapiRequestBody(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the QAPI request body.
- setRegion(SupportedRegions) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Sets the region to get the data from.
- setRequest(Request) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Set original request that caused the error.
- setRequestedUrl(String) - Method in class com.ellucian.ethos.integration.client.EthosResponse
-
Sets the requested URL of the corresponding request.
- setResource(Resource) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Get the resource associated with this error.
- setResourceName(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the resource name.
- setResponseCode(int) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Sets the response code for this error.
- setSeverity(String) - Method in class com.ellucian.ethos.integration.client.errors.EthosError
-
Sets the severity for this error.
- setShouldDoPaging(boolean) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the shouldDoPaging indicator.
- setTotalCount(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the total count (number of rows) for the given resource.
- setVersion(String) - Method in class com.ellucian.ethos.integration.client.messages.Resource
-
Sets the version, used to replace the version if needed, as done in the EthosChangeNotificationService.
- setVersion(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager
-
Sets the version (media-type) of the given resource
- shouldDoPaging(Pager, boolean) - Method in class com.ellucian.ethos.integration.client.proxy.EthosProxyClient
-
Intended to be used internally within the SDK.
- SimpleCriteria - Class in com.ellucian.ethos.integration.client.proxy.filter
-
SimpleCriteria class used when building a CriteriaFilter or NamedQueryFilter.
- SimpleCriteria() - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Intended to be used internally by the SDK.
- SimpleCriteria(String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Intended to be used internally by the SDK.
- SimpleCriteria(String, String, boolean) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Intended to be used internally by the SDK.
- SimpleCriteria.Builder - Class in com.ellucian.ethos.integration.client.proxy.filter
-
Builder class used to build the various criteria objects for building a
CriteriaFilter
. - SimpleCriteriaArray - Class in com.ellucian.ethos.integration.client.proxy.filter
-
A MultiCriteriaObject as an array of SimpleCriteria.
- SimpleCriteriaArray(String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaArray
-
Intended to be used internally by the SDK.
- SimpleCriteriaArray(String, SimpleCriteria) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaArray
-
Intended to be used internally by the SDK.
- SimpleCriteriaArray(String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaArray
-
Intended to be used internally by the SDK.
- simpleCriteriaList - Variable in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
A list of SimpleCriteria this object contains.
- simpleCriteriaObject - Variable in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryCombination
-
A reference to a SimpleCriteriaObject for the structure of the NamedQueryObject minus the queryName, since this class is built with a queryName already.
- SimpleCriteriaObject - Class in com.ellucian.ethos.integration.client.proxy.filter
-
A SimpleCriteriaObject containing a label for the given SimpleCriteria it contains.
- SimpleCriteriaObject(String, SimpleCriteria) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObject
-
Intended to be used internally by the SDK.
- SimpleCriteriaObject(String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObject
-
Intended to be used internally by the SDK.
- SimpleCriteriaObjectArray - Class in com.ellucian.ethos.integration.client.proxy.filter
-
A SimpleCriteriaObjectArray containing multiple SimpleCriteriaObjects.
- SimpleCriteriaObjectArray(String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObjectArray
-
Intended to be used internally by the SDK.
- SimpleCriteriaObjectArray(String, SimpleCriteriaObject) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObjectArray
-
Intended to be used internally by the SDK.
- SimpleCriteriaObjectArray(String, String, String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObjectArray
-
Intended to be used internally by the SDK.
- simpleCriteriaObjectList - Variable in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObjectArrayCombination
-
The list of SimpleCriteriaObjects used to generate the syntax for the array of NamedQueryObjects.
- SimpleCriteriaValueArray - Class in com.ellucian.ethos.integration.client.proxy.filter
-
A SimpleCriteriaValueArray containing multiple values.
- SimpleCriteriaValueArray(String, String) - Constructor for class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaValueArray
-
Intended to be used internally by the SDK.
- sslConnectionSocketFactory - Variable in class com.ellucian.ethos.integration.client.HttpProtocolClientBuilder
-
The Ssl connection socket factory.
- submitRequest(HttpRequestBase, Map<String, String>) - Method in class com.ellucian.ethos.integration.client.EthosClient
-
Intended to be used internally by the SDK.
- subscribe(Flow.Subscriber<? super ChangeNotification>) - Method in class com.ellucian.ethos.integration.notification.EthosChangeNotificationPollService
-
Subscribes the given subscriber to an
EthosChangeNotificationSubscription
, initiating the process for the subscriber to receive ChangeNotifications. - subscribe(Flow.Subscriber<? super List<ChangeNotification>>) - Method in class com.ellucian.ethos.integration.notification.EthosChangeNotificationListPollService
-
Subscribes the given subscriber to an
EthosChangeNotificationListSubscription
, initiating the process for the subscriber to receive entire lists of ChangeNotifications at a time. - subscriber - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscription
-
The subscriber subscribing to this subscription.
- subscriberMap - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
Maps the subscribers to their subscriptions, as there could be multiple instances of subscribers.
- subscription - Variable in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationSubscriber
-
The subscription used by this subscriber.
- SupportedRegions - Enum in com.ellucian.ethos.integration.authentication
-
Regions that are supported for Ellucian Ethos Integration.
T
- Tenant - Class in com.ellucian.ethos.integration.client.messages
-
A Tenant object that is associated with a change-notification.
- Tenant() - Constructor for class com.ellucian.ethos.integration.client.messages.Tenant
-
Creates an instance of a Tenant.
- toChangeNotificationList(EthosResponse) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts the given ethosResponse to a list of ChangeNotification objects.
- toContentString(EthosResponse) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Returns the content body of the given
EthosResponse
, or null if theEthosResponse
is null. - toEthosErrorList(EthosResponse) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts an ethosResponse to a list of EthosError objects.
- toJsonNode(EthosResponse) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Returns a
com.fasterxml.jackson.databind.JsonNode
representation of the content body of the givenEthosResponse
. - toJsonString(T) - Method in class com.ellucian.ethos.integration.client.EthosRequestConverter
-
Converts the given generic object type to a JSON formatted string.
- token - Variable in class com.ellucian.ethos.integration.client.EthosClient
-
The AccessToken used to authenticate each request.
- toPageBasedJsonNodeList(List<EthosResponse>) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts the given list of
EthosResponse
objects into a list ofJsonNode
s, where eachJsonNode
in the list contains the content body of the givenEthosResponse
in theethosResponseList
. - toPageBasedStringList(List<EthosResponse>) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts the given list of
EthosResponse
objects into a list ofString
s, where eachString
in the list is the content body of the givenEthosResponse
in theethosResponseList
. - toRowBasedJsonNodeList(List<EthosResponse>) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts the given list of
EthosResponse
objects into a list ofJsonNode
s, where eachJsonNode
in the list is an individual row (instance) of a resource. - toRowBasedStringList(List<EthosResponse>) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts the given list of
EthosResponse
objects into a list ofString
s, where eachString
in the list is an individual row (instance) of a resource. - toSingleEthosError(EthosResponse) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts an ethosResponse to an EthosError object.
- toString() - Method in class com.ellucian.ethos.integration.client.config.SemVer
-
Returns a string representation of this object containing the SemVer notation of the major.minor.patch values.
- toString() - Method in class com.ellucian.ethos.integration.client.errors.EthosError
- toString() - Method in class com.ellucian.ethos.integration.client.messages.ChangeNotification
-
Provides a string representation of this ChangeNotification in JSON format.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter
-
Provides a string representation of this CriteriaFilter.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaSet
-
A string representation in JSON format of this CriteriaSet, used when building the request URL for criteria filters.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.FilterMap
-
Provides a string representation of this filterMap with proper syntax for the request URL filter, e.g:
?credentialValue=A00000718&credentialType=bannerId
. - toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObject
-
Generates a portion of the JSON filter syntax this object contains.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.MultiCriteriaObjectArray
-
Generates a portion of the JSON filter syntax this object contains.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQuery
-
Generates the string for this NamedQuery used when making a named query filter request.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryCombination
-
Generates the string for this NamedQueryCombination used when making a named query filter request.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryFilter
-
Generates the string for this NamedQueryFilter used when making a named query filter request.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObject
-
Generates the string for this NamedQueryObject used when making a named query filter request.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObjectArrayCombination
-
Generates the string for this NamedQueryObjectArrayCombination used when making a named query filter request.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Provides a string representation of this criteria, used when building the request URL.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaArray
-
Generates a portion of the JSON filter syntax this object contains.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObject
-
Generates a portion of the JSON filter syntax this object contains.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaObjectArray
-
Generates a portion of the JSON filter syntax this object contains.
- toString() - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaValueArray
-
Generates a portion of the JSON filter syntax this object contains.
- toString() - Method in enum com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Returns the string value of this enum, same as
getValue()
- toTyped(EthosResponse, Class) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts the EthosResponse content into a generic typed object based on the given class.
- toTypedList(EthosResponse, Class) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Converts the EthosResponse content into a list of generic typed objects based on the given class.
- trimContentForNumRows(EthosResponse, int) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Takes the given
EthosResponse
and trims it's content for the given number of rows. - trimContentFromOffset(EthosResponse, int) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Takes the given
EthosResponse
and trims it's content from the given offset. - trimContentFromOffsetForNumRows(EthosResponse, int, int) - Method in class com.ellucian.ethos.integration.client.EthosResponseConverter
-
Takes the given
EthosResponse
and trims it's content from the given offset for the given number of rows.
U
- unsubscribe(Flow.Subscriber) - Method in class com.ellucian.ethos.integration.notification.AbstractEthosNotificationPollService
-
Unsubscribes the given subscriber from this publisher, removing them from the subscriber map.
- unsupportedVersion - Variable in exception com.ellucian.ethos.integration.client.config.UnsupportedVersionException
-
The unsupported version that was requested for the some resource.
- UnsupportedVersionException - Exception in com.ellucian.ethos.integration.client.config
-
Thrown when an unsupported version is requested for an Ethos resource.
- UnsupportedVersionException(String) - Constructor for exception com.ellucian.ethos.integration.client.config.UnsupportedVersionException
-
Constructs this exception with the given error message.
- UnsupportedVersionException(String, String) - Constructor for exception com.ellucian.ethos.integration.client.config.UnsupportedVersionException
-
Constructs this exception with the given error message and unsupported version that was requested for some resource.
- UnsupportedVersionException(String, String, String) - Constructor for exception com.ellucian.ethos.integration.client.config.UnsupportedVersionException
-
Constructs this exception with the given error message, resource name, and unsupported version of the resource.
- US - com.ellucian.ethos.integration.authentication.SupportedRegions
V
- validateInputCriteria(SimpleCriteria, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Intended to be used internally by the SDK.
- validateInputCriteria(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Intended to be used internally by the SDK.
- validateInputCriteria(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Intended to be used internally by the SDK.
- value - Variable in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
The value to filter by.
- valueIsNumeric - Variable in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria
-
Indicates if the value is numeric or not.
- valueList - Variable in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteriaValueArray
-
A list of String values in this array.
- valueOf(String) - Static method in enum com.ellucian.ethos.integration.authentication.SupportedRegions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.ellucian.ethos.integration.authentication.SupportedRegions
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.ellucian.ethos.integration.client.proxy.Pager.PagingType
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WARNING - Static variable in class com.ellucian.ethos.integration.client.errors.EthosError
-
The Warning level severity for an Error object.
- withArrayLabel(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.NamedQueryObjectArrayCombination
-
Sets the JSON label for the NamedQueryObject array.
- withConnectionRequestTimeout(Integer) - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Sets the connection request timeout value to be used.
- withConnectionRequestTimeout(Integer) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Sets the connection request timeout value for the ethosClientBuilder.
- withConnectionTimeout(Integer) - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Sets the connection timeout value to be used.
- withConnectionTimeout(Integer) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Sets the connection timeout value for the ethosClientBuilder.
- withCriteriaFilter(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified request URL criteria filter and returns this builder for fluent API functionality.
- withCriteriaSet(SimpleCriteria) - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter.Builder
-
Specifies the criteriaSetName used with the given SimpleCriteria when building a CriteriaFilter.
- withCriteriaSet(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter.Builder
-
Specifies the criteriaSetName, key, and value used when building a CriteriaFilter.
- withEthosResponse(EthosResponse) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified EthosResponse and returns this builder for fluent API functionality.
- withFilterMap(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified request URL filter map and returns this builder for fluent API functionality.
- withMajor(int) - Method in class com.ellucian.ethos.integration.client.config.SemVer.Builder
-
Sets the given major value for the version in the builder.
- withMinor(int) - Method in class com.ellucian.ethos.integration.client.config.SemVer.Builder
-
Sets the given minor value for the version in the builder.
- withMultiCriteriaObject(String, String, String, boolean) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
MultiCriteriaObject
class with the given criteria. - withMultiCriteriaObjectArray(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
MultiCriteriaObjectArray
class with the given criteria. - withMultiCriteriaObjectForArray(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Intended to be used when adding criteria to a MultiCriteriaObjectArray, and should not be used standalone because the MultiCriteriaObject built by this method will not contain a label.
- withNamedQuery(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
NamedQuery
class with the given criteria. - withNamedQueryCombination(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
NamedQueryCombination
class with the given criteria. - withNamedQueryFilter(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified request URL named query filter and returns this builder for fluent API functionality.
- withNamedQueryObject(String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
NamedQueryObject
class with the given criteria. - withNamedQueryObjectArrayCombination(String, String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
NamedQueryObjectArrayCombination
class with the given criteria. - withPageSize(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified pageSize and returns this builder for fluent API functionality.
- withParameterPair(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.FilterMap.Builder
-
Adds a key/value pair as a filter parameter to the filterMap.
- withPatch(int) - Method in class com.ellucian.ethos.integration.client.config.SemVer.Builder
-
Sets the given patch value for the version in the builder.
- withQAPIRequestBodyFilter(String) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified QAPI request request body and returns this builder for fluent API functionality.
- withResourceAbbreviatedVersionOverride(String, String) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Same as
withResourceVersionOverride(String, String)
except the version can be abbreviated as just the version value, e.g: 16, or 16.0.0. - withResourceVersionOverride(String, String) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Adds the resource name and version to the resourceVersionOverrideMap.
- withShouldDoPaging(boolean) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified shouldDoPaging indicator and returns this builder for fluent API functionality.
- withSimpleCriteria(SimpleCriteria) - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter.Builder
-
Adds the simpleCriteria to the current criteriaSet.
- withSimpleCriteria(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.CriteriaFilter.Builder
-
Adds the criteriaKey and criteriaValue as a SimpleCriteria to the current criteriaSet.
- withSimpleCriteria(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of
this
class with the given criteria. - withSimpleCriteriaArray(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
SimpleCriteriaArray
class with the given criteria. - withSimpleCriteriaArray(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
SimpleCriteriaArray
class with the given criteria. - withSimpleCriteriaObject(String, SimpleCriteria) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
SimpleCriteriaObject
class, nesting the given simpleCriteria within the given label. - withSimpleCriteriaObject(String, String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
SimpleCriteriaObject
class with the given criteria. - withSimpleCriteriaObjectArray(String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
SimpleCriteriaObjectArray
class with the given criteria. - withSimpleCriteriaObjectArray(String, SimpleCriteriaObject) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
SimpleCriteriaObjectArray
class with the given criteria. - withSimpleCriteriaValueArray(String, String) - Method in class com.ellucian.ethos.integration.client.proxy.filter.SimpleCriteria.Builder
-
Builds an instance of the
SimpleCriteriaValueArray
class with the given criteria. - withSocketTimeout(Integer) - Method in class com.ellucian.ethos.integration.client.EthosClientBuilder
-
Sets the socket timeout value to be used.
- withSocketTimeout(Integer) - Method in class com.ellucian.ethos.integration.service.EthosChangeNotificationService.Builder
-
Sets the socket timeout value for the ethosClientBuilder.
- withTotalCount(int) - Method in class com.ellucian.ethos.integration.client.proxy.Pager.Builder
-
Assigns the specified totalCount and returns this builder for fluent API functionality.
All Classes All Packages