com.okta.sdk.impl.resource

Class AbstractCollectionResource<T extends Resource>

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractCollectionResource<T>

All Implemented Interfaces:

CollectionResource<T>, PropertyRetriever, Resource, Iterable<T>

Direct Known Subclasses:

DefaultApplicationFeatureList, DefaultApplicationGroupAssignmentList, DefaultApplicationList, DefaultAppLinkList, DefaultAppUserList, DefaultAuthenticatorList, DefaultAuthorizationServerList, DefaultAuthorizationServerPolicyList, DefaultAuthorizationServerPolicyRuleList, DefaultBrandList, DefaultCatalogApplicationList, DefaultCsrList, DefaultDomainList, DefaultEmailTemplateCustomizationList, DefaultEmailTemplateList, DefaultEventHookList, DefaultFeatureList, DefaultGroupList, DefaultGroupRuleList, DefaultIdentityProviderApplicationUserList, DefaultIdentityProviderList, DefaultInlineHookList, DefaultJsonWebKeyList, DefaultLinkedObjectList, DefaultLogEventList, DefaultNetworkZoneList, DefaultOAuth2ClaimList, DefaultOAuth2ClientList, DefaultOAuth2RefreshTokenList, DefaultOAuth2ScopeConsentGrantList, DefaultOAuth2ScopeList, DefaultOAuth2TokenList, DefaultOrgContactTypeObjList, DefaultPolicyList, DefaultPolicyRuleList, DefaultProfileMappingList, DefaultResponseLinksList, DefaultRoleList, DefaultSecurityQuestionList, DefaultSmsTemplateList, DefaultSocialAuthTokenList, DefaultSubscriptionList, DefaultThemeResponseList, DefaultTrustedOriginList, DefaultUserFactorList, DefaultUserList, DefaultUserTypeList

public abstract class AbstractCollectionResource<T extends Resource>
extends AbstractResource
implements CollectionResource<T>

Since:

0.5.0

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCollectionResource(InternalDataStore dataStore)
protected	AbstractCollectionResource(InternalDataStore dataStore, Map<String,Object> properties)
protected	AbstractCollectionResource(InternalDataStore dataStore, Map<String,Object> properties, Map<String,Object> queryParams)

Method Summary

Modifier and Type	Method and Description
Page<T>	getCurrentPage()
protected abstract Class<T>	getItemType()
String	getNextPageUrl() Returns a next page URL
boolean	isEmpty()
Iterator<T>	iterator()
T	single() This is just a convenience method to retrieve the single element expected to exist in this collection.
Spliterator<T>	spliterator()
Stream<T>	stream() Returns a sequential Stream with this collection as its source.
protected T	toResource(Class<T> resourceClass, Map<String,Object> properties)

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyDescriptors, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbstractCollectionResource

protected AbstractCollectionResource(InternalDataStore dataStore)

AbstractCollectionResource

protected AbstractCollectionResource(InternalDataStore dataStore,
                                     Map<String,Object> properties)

AbstractCollectionResource

protected AbstractCollectionResource(InternalDataStore dataStore,
                                     Map<String,Object> properties,
                                     Map<String,Object> queryParams)

Method Detail

getNextPageUrl

public String getNextPageUrl()

Description copied from interface: CollectionResource

Returns a next page URL

Specified by:

getNextPageUrl in interface CollectionResource<T extends Resource>

Returns:

a URL link to the next resource, or null if the current resource is the last one.

single

public T single()

Description copied from interface: CollectionResource

This is just a convenience method to retrieve the single element expected to exist in this collection. This method is intended to be used in cases where the returned list is explicitly expected to contain a single element. This operation will throw an exception if this list contains zero or more than one element.

This method is not backed by any specific property obtained from the backend, as already mentioned, this is a convenience method.

Specified by:

single in interface CollectionResource<T extends Resource>

Returns:

the single unique resource that is expect to be contained within this list.

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class AbstractResource

getItemType

protected abstract Class<T> getItemType()

getCurrentPage

public Page<T> getCurrentPage()

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Resource>

stream

public Stream<T> stream()

Description copied from interface: CollectionResource

Returns a sequential Stream with this collection as its source.

Specified by:

stream in interface CollectionResource<T extends Resource>

Returns:

a sequential Stream over the elements in this resource

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Iterable<T extends Resource>

toResource

protected T toResource(Class<T> resourceClass,
                       Map<String,Object> properties)