com.okta.sdk.impl.resource.authorization.server

Class DefaultAuthorizationServerPolicy

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

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

com.okta.sdk.impl.resource.authorization.server.DefaultAuthorizationServerPolicy

All Implemented Interfaces:

AuthorizationServerPolicy, ExtensibleResource, PropertyRetriever, Resource, Saveable<AuthorizationServerPolicy>, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultAuthorizationServerPolicy
extends AbstractInstanceResource<AuthorizationServerPolicy>
implements AuthorizationServerPolicy

AuthorizationServerPolicy

Nested Class Summary

Nested classes/interfaces inherited from interface com.okta.sdk.resource.authorization.server.AuthorizationServerPolicy

AuthorizationServerPolicy.StatusEnum

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

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
DefaultAuthorizationServerPolicy(InternalDataStore dataStore)
DefaultAuthorizationServerPolicy(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
void	activate(String authServerId) Activate Authorization Server Policy
AuthorizationServerPolicyRule	createPolicyRule(String authServerId, AuthorizationServerPolicyRule policyRule) Creates a policy rule for the specified Custom Authorization Server and Policy.
void	deactivate(String authServerId) Deactivate Authorization Server Policy
void	delete(String authServerId) Success
void	deletePolicyRule(String authServerId, String ruleId) Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.
PolicyRuleConditions	getConditions()
Date	getCreated()
String	getDescription()
Map<String,Object>	getEmbedded()
String	getId()
Date	getLastUpdated()
Map<String,Object>	getLinks()
String	getName()
AuthorizationServerPolicyRule	getPolicyRule(String authServerId, String ruleId) Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.
Integer	getPriority()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
AuthorizationServerPolicy.StatusEnum	getStatus()
Boolean	getSystem()
PolicyType	getType()
AuthorizationServerPolicyRuleList	listPolicyRules(String authServerId) Enumerates all policy rules for the specified Custom Authorization Server and Policy.
AuthorizationServerPolicy	setConditions(PolicyRuleConditions conditions)
AuthorizationServerPolicy	setDescription(String description)
AuthorizationServerPolicy	setName(String name)
AuthorizationServerPolicy	setPriority(Integer priority)
AuthorizationServerPolicy	setStatus(AuthorizationServerPolicy.StatusEnum status)
AuthorizationServerPolicy	setSystem(Boolean system)
AuthorizationServerPolicy	setType(PolicyType type)
AuthorizationServerPolicy	update(String authServerId) Success

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

delete, 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, finalize, getClass, hashCode, 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

DefaultAuthorizationServerPolicy

public DefaultAuthorizationServerPolicy(InternalDataStore dataStore)

DefaultAuthorizationServerPolicy

public DefaultAuthorizationServerPolicy(InternalDataStore dataStore,
                                        Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public 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<AuthorizationServerPolicy>

Returns:

The type of resource this class represents.

getEmbedded

public Map<String,Object> getEmbedded()

Specified by:

getEmbedded in interface AuthorizationServerPolicy

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface AuthorizationServerPolicy

getConditions

public PolicyRuleConditions getConditions()

Specified by:

getConditions in interface AuthorizationServerPolicy

setConditions

public AuthorizationServerPolicy setConditions(PolicyRuleConditions conditions)

Specified by:

setConditions in interface AuthorizationServerPolicy

getCreated

public Date getCreated()

Specified by:

getCreated in interface AuthorizationServerPolicy

getDescription

public String getDescription()

Specified by:

getDescription in interface AuthorizationServerPolicy

setDescription

public AuthorizationServerPolicy setDescription(String description)

Specified by:

setDescription in interface AuthorizationServerPolicy

getId

public String getId()

Specified by:

getId in interface AuthorizationServerPolicy

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface AuthorizationServerPolicy

getName

public String getName()

Specified by:

getName in interface AuthorizationServerPolicy

setName

public AuthorizationServerPolicy setName(String name)

Specified by:

setName in interface AuthorizationServerPolicy

getPriority

public Integer getPriority()

Specified by:

getPriority in interface AuthorizationServerPolicy

setPriority

public AuthorizationServerPolicy setPriority(Integer priority)

Specified by:

setPriority in interface AuthorizationServerPolicy

getStatus

public AuthorizationServerPolicy.StatusEnum getStatus()

Specified by:

getStatus in interface AuthorizationServerPolicy

setStatus

public AuthorizationServerPolicy setStatus(AuthorizationServerPolicy.StatusEnum status)

Specified by:

setStatus in interface AuthorizationServerPolicy

getSystem

public Boolean getSystem()

Specified by:

getSystem in interface AuthorizationServerPolicy

setSystem

public AuthorizationServerPolicy setSystem(Boolean system)

Specified by:

setSystem in interface AuthorizationServerPolicy

getType

public PolicyType getType()

Specified by:

getType in interface AuthorizationServerPolicy

setType

public AuthorizationServerPolicy setType(PolicyType type)

Specified by:

setType in interface AuthorizationServerPolicy

getPolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}")
public AuthorizationServerPolicyRule getPolicyRule(String authServerId,
                                                                                                                                                                                                                                                                                       String ruleId)

Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.

Specified by:

getPolicyRule in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

ruleId - (required)

Returns:

AuthorizationServerPolicyRule

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate")
public void deactivate(String authServerId)

Deactivate Authorization Server Policy

Specified by:

deactivate in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

createPolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules")
public AuthorizationServerPolicyRule createPolicyRule(String authServerId,
                                                                                                                                                                                                                                                                                  AuthorizationServerPolicyRule policyRule)

Creates a policy rule for the specified Custom Authorization Server and Policy.

Specified by:

createPolicyRule in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

policyRule - (required)

Returns:

AuthorizationServerPolicyRule

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
public AuthorizationServerPolicy update(String authServerId)

Success

Specified by:

update in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

Returns:

AuthorizationServerPolicy

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
public void delete(String authServerId)

Success

Specified by:

delete in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

listPolicyRules

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules")
public AuthorizationServerPolicyRuleList listPolicyRules(String authServerId)

Enumerates all policy rules for the specified Custom Authorization Server and Policy.

Specified by:

listPolicyRules in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

Returns:

AuthorizationServerPolicyRuleList

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate")
public void activate(String authServerId)

Activate Authorization Server Policy

Specified by:

activate in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

deletePolicyRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}")
public void deletePolicyRule(String authServerId,
                                                                                                                                                                                                                                                                    String ruleId)

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

Specified by:

deletePolicyRule in interface AuthorizationServerPolicy

Parameters:

authServerId - (required)

ruleId - (required)