com.okta.sdk.impl.resource.policy

Class DefaultPolicy

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<Policy>

com.okta.sdk.impl.resource.policy.DefaultPolicy

All Implemented Interfaces:

Deletable, ExtensibleResource, Policy, PropertyRetriever, Resource, Saveable<Policy>, java.util.Map<java.lang.String,java.lang.Object>

Direct Known Subclasses:

DefaultIdentityProviderPolicy, DefaultOAuthAuthorizationPolicy, DefaultOktaSignOnPolicy, DefaultPasswordPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00")
public class DefaultPolicy
extends AbstractInstanceResource<Policy>
implements Policy

Policy

Nested Class Summary

Nested classes/interfaces inherited from interface com.okta.sdk.resource.policy.Policy

Policy.StatusEnum

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

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

Constructor and Description
DefaultPolicy(InternalDataStore dataStore)
DefaultPolicy(InternalDataStore dataStore, java.util.Map<java.lang.String,java.lang.Object> properties)

Method Summary

Modifier and Type	Method and Description
void	activate() Activates a policy.
PolicyRule	createRule(PolicyRule policyRule) Creates a policy rule.
void	deactivate() Deactivates a policy.
void	delete() Removes a policy.
PolicyRuleConditions	getConditions()
java.util.Date	getCreated()
java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.Object>	getEmbedded()
java.lang.String	getId()
java.util.Date	getLastUpdated()
java.util.Map<java.lang.String,java.lang.Object>	getLinks()
java.lang.String	getName()
PolicyRule	getPolicyRule(java.lang.String ruleId) Gets a policy rule.
java.lang.Integer	getPriority()
java.util.Map<java.lang.String,Property>	getPropertyDescriptors()
java.lang.Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
Policy.StatusEnum	getStatus()
java.lang.Boolean	getSystem()
PolicyType	getType()
PolicyRuleList	listPolicyRules() Enumerates all policy rules.
Policy	setConditions(PolicyRuleConditions conditions)
Policy	setDescription(java.lang.String description)
Policy	setName(java.lang.String name)
Policy	setPriority(java.lang.Integer priority)
Policy	setStatus(Policy.StatusEnum status)
Policy	setSystem(java.lang.Boolean system)
Policy	setType(PolicyType type)
Policy	update() Updates a policy.

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

save

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

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, 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, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getResourceHref, setResourceHref

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

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultPolicy

public DefaultPolicy(InternalDataStore dataStore)

DefaultPolicy

public DefaultPolicy(InternalDataStore dataStore,
                     java.util.Map<java.lang.String,java.lang.Object> properties)

Method Detail

getPropertyDescriptors

public java.util.Map<java.lang.String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public java.lang.Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<Policy>

Returns:

The type of resource this class represents.

getEmbedded

public java.util.Map<java.lang.String,java.lang.Object> getEmbedded()

Specified by:

getEmbedded in interface Policy

getLinks

public java.util.Map<java.lang.String,java.lang.Object> getLinks()

Specified by:

getLinks in interface Policy

getConditions

public PolicyRuleConditions getConditions()

Specified by:

getConditions in interface Policy

setConditions

public Policy setConditions(PolicyRuleConditions conditions)

Specified by:

setConditions in interface Policy

getCreated

public java.util.Date getCreated()

Specified by:

getCreated in interface Policy

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Policy

setDescription

public Policy setDescription(java.lang.String description)

Specified by:

setDescription in interface Policy

getId

public java.lang.String getId()

Specified by:

getId in interface Policy

getLastUpdated

public java.util.Date getLastUpdated()

Specified by:

getLastUpdated in interface Policy

getName

public java.lang.String getName()

Specified by:

getName in interface Policy

setName

public Policy setName(java.lang.String name)

Specified by:

setName in interface Policy

getPriority

public java.lang.Integer getPriority()

Specified by:

getPriority in interface Policy

setPriority

public Policy setPriority(java.lang.Integer priority)

Specified by:

setPriority in interface Policy

getStatus

public Policy.StatusEnum getStatus()

Specified by:

getStatus in interface Policy

setStatus

public Policy setStatus(Policy.StatusEnum status)

Specified by:

setStatus in interface Policy

getSystem

public java.lang.Boolean getSystem()

Specified by:

getSystem in interface Policy

setSystem

public Policy setSystem(java.lang.Boolean system)

Specified by:

setSystem in interface Policy

getType

public PolicyType getType()

Specified by:

getType in interface Policy

setType

public Policy setType(PolicyType type)

Specified by:

setType in interface Policy

createRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00",
           comments="POST - /api/v1/policies/{policyId}/rules")
public PolicyRule createRule(PolicyRule policyRule)

Creates a policy rule.

Specified by:

createRule in interface Policy

Parameters:

policyRule - (required)

Returns:

PolicyRule

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00",
           comments="POST - /api/v1/policies/{policyId}/lifecycle/deactivate")
public void deactivate()

Deactivates a policy.

Specified by:

deactivate in interface Policy

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00",
           comments="PUT - /api/v1/policies/{policyId}")
public Policy update()

Updates a policy.

Specified by:

update in interface Policy

Returns:

Policy

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00",
           comments="DELETE - /api/v1/policies/{policyId}")
public void delete()

Removes a policy.

Specified by:

delete in interface Deletable

Specified by:

delete in interface Policy

Overrides:

delete in class AbstractInstanceResource<Policy>

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00",
           comments="POST - /api/v1/policies/{policyId}/lifecycle/activate")
public void activate()

Activates a policy.

Specified by:

activate in interface Policy

listPolicyRules

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00",
           comments="GET - /api/v1/policies/{policyId}/rules")
public PolicyRuleList listPolicyRules()

Enumerates all policy rules.

Specified by:

listPolicyRules in interface Policy

Returns:

PolicyRuleList

getPolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2021-10-11T13:51:56.108-05:00",
           comments="GET - /api/v1/policies/{policyId}/rules/{ruleId}")
public PolicyRule getPolicyRule(java.lang.String ruleId)

Gets a policy rule.

Specified by:

getPolicyRule in interface Policy

Parameters:

ruleId - (required)

Returns:

PolicyRule