AbstractResource (Okta Java SDK 8.2.5 API)

java.lang.Object
- com.okta.sdk.impl.resource.AbstractPropertyRetriever
- - com.okta.sdk.impl.resource.AbstractResource

All Implemented Interfaces:

PropertyRetriever, Resource

Direct Known Subclasses:

AbstractCollectionResource, AbstractInstanceResource, DefaultAccessPolicyConstraint, DefaultAccessPolicyConstraints, DefaultAccessPolicyRuleApplicationSignOn, DefaultAccessPolicyRuleCustomCondition, DefaultAcsEndpoint, DefaultAppAndInstanceConditionEvaluatorAppOrInstance, DefaultAppAndInstancePolicyRuleCondition, DefaultAppInstancePolicyRuleCondition, DefaultApplicationAccessibility, DefaultApplicationCredentials, DefaultApplicationCredentialsOAuthClient, DefaultApplicationCredentialsSigning, DefaultApplicationCredentialsUsernameTemplate, DefaultApplicationLicensing, DefaultApplicationSettings, DefaultApplicationSettingsApplication, DefaultApplicationSettingsNotes, DefaultApplicationSettingsNotifications, DefaultApplicationSettingsNotificationsVpn, DefaultApplicationSettingsNotificationsVpnNetwork, DefaultApplicationVisibility, DefaultApplicationVisibilityHide, DefaultAppUserCredentials, DefaultAppUserPasswordCredential, DefaultAuthenticationProvider, DefaultAuthenticatorProvider, DefaultAuthenticatorProviderConfiguration, DefaultAuthenticatorProviderConfigurationUserNamePlate, DefaultAuthenticatorSettings, DefaultAuthorizationServerCredentials, DefaultAuthorizationServerCredentialsSigningConfig, DefaultAuthorizationServerPolicyRuleActions, DefaultAuthorizationServerPolicyRuleConditions, DefaultAutoLoginApplicationSettingsSignOn, DefaultBeforeScheduledActionPolicyRuleCondition, DefaultCallUserFactorProfile, DefaultCapabilitiesCreateObject, DefaultCapabilitiesUpdateObject, DefaultChannelBinding, DefaultClientPolicyCondition, DefaultCompliance, DefaultContextPolicyRuleCondition, DefaultCsrMetadataSubject, DefaultCsrMetadataSubjectAltNames, DefaultCustomHotpUserFactorProfile, DefaultDevicePolicyRuleCondition, DefaultDevicePolicyRuleConditionPlatform, DefaultDNSRecord, DefaultDomainCertificateMetadata, DefaultDuration, DefaultEmailUserFactorProfile, DefaultError, DefaultErrorCause, DefaultEventHookChannel, DefaultEventHookChannelConfig, DefaultEventHookChannelConfigAuthScheme, DefaultEventHookChannelConfigHeader, DefaultEventSubscriptions, DefaultExtensibleResource, DefaultFeatureStage, DefaultFileResource, DefaultGrantTypePolicyRuleCondition, DefaultGroupCondition, DefaultGroupPolicyRuleCondition, DefaultGroupProfile, DefaultGroupRuleAction, DefaultGroupRuleConditions, DefaultGroupRuleExpression, DefaultGroupRuleGroupAssignment, DefaultGroupRuleGroupCondition, DefaultGroupRulePeopleCondition, DefaultGroupRuleUserCondition, DefaultGroupSchemaAttribute, DefaultGroupSchemaBase, DefaultGroupSchemaBaseProperties, DefaultGroupSchemaCustom, DefaultGroupSchemaDefinitions, DefaultHardwareUserFactorProfile, DefaultIdentityProviderCredentials, DefaultIdentityProviderCredentialsClient, DefaultIdentityProviderCredentialsSigning, DefaultIdentityProviderCredentialsTrust, DefaultIdentityProviderPolicyRuleCondition, DefaultIdpPolicyRuleAction, DefaultIdpPolicyRuleActionProvider, DefaultInactivityPolicyRuleCondition, DefaultInlineHookChannel, DefaultInlineHookChannelConfig, DefaultInlineHookChannelConfigAuthScheme, DefaultInlineHookChannelConfigHeaders, DefaultInlineHookResponseCommands, DefaultInlineHookResponseCommandValue, DefaultIonField, DefaultIonForm, DefaultLifecycleCreateSettingObject, DefaultLifecycleDeactivateSettingObject, DefaultLifecycleExpirationPolicyRuleCondition, DefaultLinkedObjectDetails, DefaultLogActor, DefaultLogAuthenticationContext, DefaultLogClient, DefaultLogDebugContext, DefaultLogGeographicalContext, DefaultLogGeolocation, DefaultLogIpAddress, DefaultLogIssuer, DefaultLogOutcome, DefaultLogRequest, DefaultLogSecurityContext, DefaultLogTarget, DefaultLogTransaction, DefaultLogUserAgent, DefaultMDMEnrollmentPolicyRuleCondition, DefaultNetworkZoneAddress, DefaultNetworkZoneLocation, DefaultOAuth2Actor, DefaultOAuth2ClaimConditions, DefaultOAuth2ScopesMediationPolicyRuleCondition, DefaultOktaSignOnPolicyRuleSignonActions, DefaultOktaSignOnPolicyRuleSignonSessionActions, DefaultOpenIdConnectApplicationIdpInitiatedLogin, DefaultOpenIdConnectApplicationSettingsClient, DefaultOpenIdConnectApplicationSettingsClientKeys, DefaultOpenIdConnectApplicationSettingsRefreshToken, DefaultPasswordCredential, DefaultPasswordCredentialHash, DefaultPasswordCredentialHook, DefaultPasswordDictionary, DefaultPasswordDictionaryCommon, DefaultPasswordExpirationPolicyRuleCondition, DefaultPasswordPolicyAuthenticationProviderCondition, DefaultPasswordPolicyDelegationSettings, DefaultPasswordPolicyDelegationSettingsOptions, DefaultPasswordPolicyPasswordSettings, DefaultPasswordPolicyPasswordSettingsAge, DefaultPasswordPolicyPasswordSettingsComplexity, DefaultPasswordPolicyPasswordSettingsLockout, DefaultPasswordPolicyRecoveryEmail, DefaultPasswordPolicyRecoveryEmailProperties, DefaultPasswordPolicyRecoveryEmailRecoveryToken, DefaultPasswordPolicyRecoveryFactors, DefaultPasswordPolicyRecoveryFactorSettings, DefaultPasswordPolicyRecoveryQuestion, DefaultPasswordPolicyRecoveryQuestionComplexity, DefaultPasswordPolicyRecoveryQuestionProperties, DefaultPasswordPolicyRecoverySettings, DefaultPasswordPolicyRuleAction, DefaultPasswordPolicySettings, DefaultPasswordSettingObject, DefaultPlatformConditionEvaluatorPlatform, DefaultPlatformConditionEvaluatorPlatformOperatingSystem, DefaultPlatformConditionEvaluatorPlatformOperatingSystemVersion, DefaultPlatformPolicyRuleCondition, DefaultPolicyAccountLink, DefaultPolicyAccountLinkFilter, DefaultPolicyAccountLinkFilterGroups, DefaultPolicyNetworkCondition, DefaultPolicyPeopleCondition, DefaultPolicyRuleActions, DefaultPolicyRuleActionsEnroll, DefaultPolicyRuleAuthContextCondition, DefaultPolicyRuleConditions, DefaultPolicySubject, DefaultPolicyUserNameTemplate, DefaultPreRegistrationInlineHook, DefaultProfileEnrollmentPolicyRuleAction, DefaultProfileEnrollmentPolicyRuleActivationRequirement, DefaultProfileEnrollmentPolicyRuleProfileAttribute, DefaultProfileMappingProperty, DefaultProfileMappingSource, DefaultProfileSettingObject, DefaultProtocol, DefaultProtocolAlgorithms, DefaultProtocolAlgorithmType, DefaultProtocolAlgorithmTypeSignature, DefaultProtocolEndpoint, DefaultProtocolEndpoints, DefaultProtocolRelayState, DefaultProtocolSettings, DefaultProvisioning, DefaultProvisioningConditions, DefaultProvisioningConnectionProfile, DefaultProvisioningDeprovisionedCondition, DefaultProvisioningGroups, DefaultProvisioningSuspendedCondition, DefaultPushUserFactorProfile, DefaultRecoveryQuestionCredential, DefaultRiskPolicyRuleCondition, DefaultRiskScorePolicyRuleCondition, DefaultSamlApplicationSettingsSignOn, DefaultSamlAttributeStatement, DefaultScheduledUserLifecycleAction, DefaultScope, DefaultSecurityQuestionUserFactorProfile, DefaultSessionIdentityProvider, DefaultSignOnInlineHook, DefaultSingleLogout, DefaultSmsTemplateTranslations, DefaultSmsUserFactorProfile, DefaultSpCertificate, DefaultTokenAuthorizationServerPolicyRuleAction, DefaultTokenAuthorizationServerPolicyRuleActionInlineHook, DefaultTokenUserFactorProfile, DefaultTotpUserFactorProfile, DefaultU2fUserFactorProfile, DefaultUserCondition, DefaultUserIdentifierConditionEvaluatorPattern, DefaultUserIdentifierPolicyRuleCondition, DefaultUserLifecycleAttributePolicyRuleCondition, DefaultUserPolicyRuleCondition, DefaultUserProfile, DefaultUserSchemaAttribute, DefaultUserSchemaAttributeEnum, DefaultUserSchemaAttributeItems, DefaultUserSchemaAttributeMaster, DefaultUserSchemaAttributeMasterPriority, DefaultUserSchemaAttributePermission, DefaultUserSchemaBase, DefaultUserSchemaBaseProperties, DefaultUserSchemaDefinitions, DefaultUserSchemaProperties, DefaultUserSchemaPropertiesProfile, DefaultUserSchemaPropertiesProfileItem, DefaultUserSchemaPublic, DefaultUserStatusPolicyRuleCondition, DefaultUserTypeCondition, DefaultVerificationMethod, DefaultVoidResource, DefaultWebAuthnUserFactorProfile, DefaultWebUserFactorProfile
```
public abstract class AbstractResource
extends AbstractPropertyRetriever
implements Resource
```
Since:

0.5.0

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,Object> properties
- Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever
  readLock, writeLock

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`properties`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractResource(InternalDataStore dataStore)`
`protected`	`AbstractResource(InternalDataStore dataStore, Map<String,Object> properties)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`protected static Map<String,Property>`	`createPropertyDescriptorMap(Map<String,Property> existingProperties, Property... props)`
`protected static Map<String,Property>`	`createPropertyDescriptorMap(Property... props)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object o)`
`Object`	`get(Object key)`
`protected InternalDataStore`	`getDataStore()`
`protected Set<String>`	`getDeletedPropertyNames()`
`protected Map<String,Object>`	`getInternalProperties()`
`protected Map<String,String>`	`getParamsFromHref(String templateUrl)` Parses path parameters from URL based on a template string.
`Object`	`getProperty(String name)`
`abstract Map<String,Property>`	`getPropertyDescriptors()`
`Set<String>`	`getPropertyNames()`
`String`	`getResourceHref()`
`protected List`	`getResourceListProperty(ResourceListProperty property)` Returns the `List` property identified by `key`
`protected <T extends Resource> T`	`getResourceProperty(ResourceReference<T> property)`
`Set<String>`	`getUpdatedPropertyNames()`
`int`	`hashCode()`
`boolean`	`hasProperty(String name)` Returns `true` if this resource has a property with the specified name, `false` otherwise.
`boolean`	`isDirty()` Returns `true` if the resource's properties have been modified in anyway since the resource instance was created.
`boolean`	`isEmpty()`
`protected boolean`	`isPrintableProperty(String name)` Returns `true` if the internal property is safe to print in toString(), `false` otherwise.
`Set<String>`	`keySet()`
`void`	`materialize()`
`Object`	`put(String key, Object value)`
`void`	`putAll(Map<? extends String,?> m)`
`Object`	`remove(Object key)`
`void`	`setInternalProperties(Map<String,Object> properties)`
`protected void`	`setProperty(Property property, Object value, boolean dirty, boolean isNullable)` Use this method and the set the isNullable flag to true, to set the value to null for the Property.
`protected Object`	`setProperty(String name, Object value, boolean dirty)`
`void`	`setResourceHref(String href)`
`int`	`size()`
`String`	`toString()`
`Collection<Object>`	`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

- Field Detail
  - properties
```
protected Map<String,Object> properties
```
- Constructor Detail
  - AbstractResource
```
protected AbstractResource(InternalDataStore dataStore)
```
  - AbstractResource
```
protected AbstractResource(InternalDataStore dataStore,
                           Map<String,Object> properties)
```
- Method Detail
  - createPropertyDescriptorMap
```
protected static Map<String,Property> createPropertyDescriptorMap(Property... props)
```
  - createPropertyDescriptorMap
```
protected static Map<String,Property> createPropertyDescriptorMap(Map<String,Property> existingProperties,
                                                                  Property... props)
```
  - getPropertyDescriptors
```
public abstract Map<String,Property> getPropertyDescriptors()
```
  - setInternalProperties
```
public void setInternalProperties(Map<String,Object> properties)
```
  - getResourceHref
```
public String getResourceHref()
```
    Specified by:
    
    getResourceHref in interface Resource
  - setResourceHref
```
public void setResourceHref(String href)
```
    Specified by:
    
    setResourceHref in interface Resource
  - getDataStore
```
protected final InternalDataStore getDataStore()
```
  - isDirty
```
public final boolean isDirty()
```
    Returns true if the resource's properties have been modified in anyway since the resource instance was created.
    
    Returns:
    
    true true if the resource's properties have been modified in anyway since the resource instance was created
  - materialize
```
public void materialize()
```
  - getPropertyNames
```
public Set<String> getPropertyNames()
```
  - getUpdatedPropertyNames
```
public Set<String> getUpdatedPropertyNames()
```
  - getDeletedPropertyNames
```
protected Set<String> getDeletedPropertyNames()
```
  - getProperty
```
public Object getProperty(String name)
```
    Specified by:
    
    getProperty in class AbstractPropertyRetriever
  - hasProperty
```
public boolean hasProperty(String name)
```
    Returns true if this resource has a property with the specified name, false otherwise.
    
    Parameters:
    
    name - the name of the property to check for existence
    
    Returns:
    
    true if this resource has a property with the specified name, false otherwise.
  - setProperty
```
protected Object setProperty(String name,
                             Object value,
                             boolean dirty)
```
    Specified by:
    
    setProperty in class AbstractPropertyRetriever
  - setProperty
```
protected void setProperty(Property property,
                           Object value,
                           boolean dirty,
                           boolean isNullable)
```
    Use this method and the set the isNullable flag to true, to set the value to null for the Property. Certain properties can have a value=null in the REST API and therefore, this method will allow to explicitly do that. All other overloaded implementations of setProperty method will assume isNullable=false and therefore setting the value to null by calling those methods, will take no effect and retain the old/previous value for the property.
    
    Parameters:
    
    property - the key of the value to set
    
    value - the actual value to be set
    
    dirty - mark the object as dirty if true
    
    isNullable - true if the value can be set to null
  - getResourceProperty
```
protected <T extends Resource> T getResourceProperty(ResourceReference<T> property)
```
  - getResourceListProperty
```
protected List getResourceListProperty(ResourceListProperty property)
```
    Returns the List property identified by key
    
    Parameters:
    
    property - identifier
    
    Returns:
    
    property identified by property
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isPrintableProperty
```
protected boolean isPrintableProperty(String name)
```
    Returns true if the internal property is safe to print in toString(), false otherwise.
    
    Overrides:
    
    isPrintableProperty in class AbstractPropertyRetriever
    
    Parameters:
    
    name - The name of the property to check for safe printing
    
    Returns:
    
    true if the internal property is safe to print in toString(), false otherwise.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getInternalProperties
```
protected Map<String,Object> getInternalProperties()
```
    Specified by:
    
    getInternalProperties in class AbstractPropertyRetriever
  - size
```
public int size()
```
  - isEmpty
```
public boolean isEmpty()
```
  - containsKey
```
public boolean containsKey(Object key)
```
  - containsValue
```
public boolean containsValue(Object value)
```
  - get
```
public Object get(Object key)
```
  - put
```
public Object put(String key,
                  Object value)
```
  - remove
```
public Object remove(Object key)
```
  - putAll
```
public void putAll(Map<? extends String,?> m)
```
  - clear
```
public void clear()
```
  - keySet
```
public Set<String> keySet()
```
  - values
```
public Collection<Object> values()
```
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
  - getParamsFromHref
```
protected Map<String,String> getParamsFromHref(String templateUrl)
```
    Parses path parameters from URL based on a template string.
    Example: For the template string: /users/{userId}/favorite/{iceCream}, and the href of this resource: /users/42/favorite/vanilla}, the resulting map would be: [userId: 42, iceCream: vanilla].
    
    Parameters:
    
    templateUrl - template of the URL to parse
    
    Returns:
    
    a map of path parameters
    
    Since:
    
    0.8.0

Class AbstractResource

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

properties

Constructor Detail

AbstractResource

AbstractResource

Method Detail

createPropertyDescriptorMap

createPropertyDescriptorMap

getPropertyDescriptors

setInternalProperties

getResourceHref

setResourceHref

getDataStore

isDirty

materialize

getPropertyNames

getUpdatedPropertyNames

getDeletedPropertyNames

getProperty

hasProperty

setProperty

setProperty

getResourceProperty

getResourceListProperty

toString

isPrintableProperty

hashCode

equals

getInternalProperties

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

getParamsFromHref