com.okta.sdk.impl.resource.inline.hook

Class DefaultInlineHook

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

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

com.okta.sdk.impl.resource.inline.hook.DefaultInlineHook

All Implemented Interfaces:

Deletable, ExtensibleResource, InlineHook, PropertyRetriever, Resource, Saveable<InlineHook>, Map<String,Object>

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

InlineHook

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
InlineHook	activate() Activates the Inline Hook matching the provided id
InlineHook	deactivate() Deactivates the Inline Hook matching the provided id
void	delete() Deletes the Inline Hook matching the provided id.
InlineHookResponse	execute(InlineHookPayload payloadData) Executes the Inline Hook matching the provided inlineHookId using the request body as the input.
InlineHookChannel	getChannel()
Date	getCreated()
String	getId()
Date	getLastUpdated()
Map<String,Object>	getLinks()
String	getName()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
InlineHookStatus	getStatus()
InlineHookType	getType()
String	getVersion()
InlineHook	setChannel(InlineHookChannel channel)
InlineHook	setName(String name)
InlineHook	setStatus(InlineHookStatus status)
InlineHook	setType(InlineHookType type)
InlineHook	setVersion(String version)
InlineHook	update() Updates an inline hook by ID

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, 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

DefaultInlineHook

public DefaultInlineHook(InternalDataStore dataStore)

DefaultInlineHook

public DefaultInlineHook(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<InlineHook>

Returns:

The type of resource this class represents.

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface InlineHook

getChannel

public InlineHookChannel getChannel()

Specified by:

getChannel in interface InlineHook

setChannel

public InlineHook setChannel(InlineHookChannel channel)

Specified by:

setChannel in interface InlineHook

getCreated

public Date getCreated()

Specified by:

getCreated in interface InlineHook

getId

public String getId()

Specified by:

getId in interface InlineHook

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface InlineHook

getName

public String getName()

Specified by:

getName in interface InlineHook

setName

public InlineHook setName(String name)

Specified by:

setName in interface InlineHook

getStatus

public InlineHookStatus getStatus()

Specified by:

getStatus in interface InlineHook

setStatus

public InlineHook setStatus(InlineHookStatus status)

Specified by:

setStatus in interface InlineHook

getType

public InlineHookType getType()

Specified by:

getType in interface InlineHook

setType

public InlineHook setType(InlineHookType type)

Specified by:

setType in interface InlineHook

getVersion

public String getVersion()

Specified by:

getVersion in interface InlineHook

setVersion

public InlineHook setVersion(String version)

Specified by:

setVersion in interface InlineHook

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/inlineHooks/{inlineHookId}")
public InlineHook update()

Updates an inline hook by ID

Specified by:

update in interface InlineHook

Returns:

InlineHook

execute

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/execute")
public InlineHookResponse execute(InlineHookPayload payloadData)

Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Specified by:

execute in interface InlineHook

Parameters:

payloadData - (required)

Returns:

InlineHookResponse

delete

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

Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Specified by:

delete in interface Deletable

Specified by:

delete in interface InlineHook

Overrides:

delete in class AbstractInstanceResource<InlineHook>

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate")
public InlineHook deactivate()

Deactivates the Inline Hook matching the provided id

Specified by:

deactivate in interface InlineHook

Returns:

InlineHook

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate")
public InlineHook activate()

Activates the Inline Hook matching the provided id

Specified by:

activate in interface InlineHook

Returns:

InlineHook